Teko_TpetraBlockPreconditioner.hpp

/*
// @HEADER
// 
// ***********************************************************************
// 
//      Teko: A package for block and physics based preconditioning
//                  Copyright 2010 Sandia Corporation 
//  
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//  
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//  
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//  
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//  
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission. 
//  
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//  
// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
// 
// ***********************************************************************
// 
// @HEADER
 
*/
 
#ifndef __Teko_TpetraBlockPreconditioner_hpp__
#define __Teko_TpetraBlockPreconditioner_hpp__
 
// #include "Teko_BlockPreconditionerFactory.hpp"
#include "Teko_PreconditionerFactory.hpp"
#include "Teko_TpetraInverseOpWrapper.hpp"
#include "Teko_ConfigDefs.hpp"
 
namespace Teko {
namespace TpetraHelpers {

class TpetraBlockPreconditioner : public TpetraInverseOpWrapper {
public:
   TpetraBlockPreconditioner(const Teuchos::RCP<const PreconditionerFactory> & bfp); 

   virtual void initPreconditioner(bool clearOld=false);

   virtual void buildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A,bool clear=true);

   virtual void buildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A,const Tpetra::MultiVector<ST,LO,GO,NT> & mv,bool clear=true);

   virtual void rebuildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A);

   virtual void rebuildPreconditioner(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A,const Tpetra::MultiVector<ST,LO,GO,NT> & mv);

   virtual Teuchos::RCP<PreconditionerState> getPreconditionerState();

   virtual Teuchos::RCP<const PreconditionerState> getPreconditionerState() const;
 
protected:
   Teuchos::RCP<const Thyra::LinearOpBase<ST> > extractLinearOp(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A) const;
   Teuchos::RCP<const MappingStrategy> extractMappingStrategy(const Teuchos::RCP<const Tpetra::Operator<ST,LO,GO,NT> > & A) const;
 
   TpetraBlockPreconditioner(); 
   TpetraBlockPreconditioner(const TpetraBlockPreconditioner &); 
 
   // Teuchos::RCP<const BlockPreconditionerFactory> preconFactory_;
   Teuchos::RCP<const PreconditionerFactory> preconFactory_;
   Teuchos::RCP<Thyra::PreconditionerBase<ST> > preconObj_;
   bool firstBuildComplete_;
};
 
} // end namespace TpetraHelpers
} // end namespace Teko
 
#endif