Teko_PreconditionerFactory.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_PreconditionerFactory_hpp__
#define __Teko_PreconditionerFactory_hpp__

#include "Teuchos_ParameterListAcceptor.hpp"

// Thyra includes
#include "Thyra_SolveSupportTypes.hpp"
#include "Thyra_LinearOpSourceBase.hpp"
#include "Thyra_PreconditionerFactoryBase.hpp"
#include "Thyra_DefaultBlockedLinearOp.hpp"
#include "Thyra_DefaultPreconditioner.hpp"

// Teko includes
#include "Teko_Utilities.hpp"
#include "Teko_InverseLibrary.hpp"
#include "Teko_CloneFactory.hpp"
#include "Teko_PreconditionerState.hpp"
#include "Teko_RequestHandler.hpp"
#include "Teko_RequestHandlerContainer.hpp"

namespace Teko {

using Thyra::LinearOpBase;
using Thyra::DefaultPreconditioner;

class PreconditionerFactory 
   : public virtual Thyra::PreconditionerFactoryBase<double>, public RequestHandlerContainer
   {
public:

   virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const = 0;

   virtual Teuchos::RCP<PreconditionerState> buildPreconditionerState() const
   { return Teuchos::rcp(new PreconditionerState()); }



   virtual void initializeFromParameterList(const Teuchos::ParameterList & /* settings */)
   { }

   virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
   { return Teuchos::null; }
   
   virtual bool updateRequestedParameters(const Teuchos::ParameterList & /* pl */)
   { return true; }
   

   void setInverseLibrary(const Teuchos::RCP<const InverseLibrary> & il);

   Teuchos::RCP<const InverseLibrary> getInverseLibrary() const;


 
   bool isCompatible(const Thyra::LinearOpSourceBase<double> &fwdOpSrc) const;

   Teuchos::RCP<Thyra::PreconditionerBase<double> > createPrec() const;

   void initializePrec(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > & fwdOpSrc,
                       const Teuchos::RCP<const Thyra::MultiVectorBase<double> > & solnVec,
                       Thyra::PreconditionerBase<double> * precOp,
                       const Thyra::ESupportSolveUse supportSolveUse) const;

   void initializePrec(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > & fwdOpSrc,
                       Thyra::PreconditionerBase<double> * precOp,
                       const Thyra::ESupportSolveUse supportSolveUse) const;

   void uninitializePrec(Thyra::PreconditionerBase<double> * prec, 
                         Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > * fwdOpSrc,
                         Thyra::ESupportSolveUse *supportSolveUse) const;



   void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & paramList); 

   Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList();

   Teuchos::RCP< Teuchos::ParameterList > unsetParameterList();

   void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
   { callbackHandler_ = rh; }

   Teuchos::RCP<RequestHandler> getRequestHandler() const 
   { return callbackHandler_; }

protected:
   Teuchos::RCP<Teuchos::ParameterList>          paramList_;

   Teuchos::RCP<RequestHandler> callbackHandler_;

private:
   Teuchos::RCP<const InverseLibrary> inverseLibrary_;

   static void setOpRequestHandler(const RequestHandlerContainer & rhc,const LinearOp & op);

public:

   static Teuchos::RCP<PreconditionerFactory> 
   buildPreconditionerFactory(const std::string & name, 
                              const Teuchos::ParameterList & settings,
                              const Teuchos::RCP<const InverseLibrary> & invLib=Teuchos::null);

   static void addPreconditionerFactory(const std::string & name,const Teuchos::RCP<Cloneable> & clone);

   static void getPreconditionerFactoryNames(std::vector<std::string> & names);

private:

   static CloneFactory<PreconditionerFactory> precFactoryBuilder_;

   static void initializePrecFactoryBuilder();
};

} // end namespace Teko

#endif