Teko  Version of the Day
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Member Functions | List of all members
Teko::MultPreconditionerFactory Class Reference

#include <Teko_MultPreconditionerFactory.hpp>

Inheritance diagram for Teko::MultPreconditionerFactory:
Inheritance graph
[legend]

Public Member Functions

 MultPreconditionerFactory (const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &FirstFactory, const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &SecondFactory)
 Constructor. More...
 
Teko::LinearOp buildPreconditionerOperator (Teko::BlockedLinearOp &blo, Teko::BlockPreconditionerState &state) const
 Function inherited from Teko::BlockPreconditionerFactory. More...
 
virtual Teuchos::RCP
< Teko::PreconditionerState
buildPreconditionerState () const
 Build the MultPrecondState object. More...
 
- Public Member Functions inherited from Teko::BlockPreconditionerFactory
RCP< BlockPreconditionerStatebuildBlockPreconditionerState () const
 Function that constructs a BlockPreconditionerState object. More...
 
virtual LinearOp buildPreconditionerOperator (LinearOp &blo, PreconditionerState &state) const
 Function that is called to build the preconditioner for the linear operator that is passed in. More...
 
bool isCompatible (const Thyra::LinearOpSourceBase< double > &fwdOpSrc) const
 is this operator compatiable with the preconditioner factory? More...
 
- Public Member Functions inherited from Teko::PreconditionerFactory
void setInverseLibrary (const Teuchos::RCP< const InverseLibrary > &il)
 Set the inverse library used by this preconditioner factory. More...
 
Teuchos::RCP< const
InverseLibrary > 
getInverseLibrary () const
 Get the inverse library used by this preconditioner factory. More...
 
void setRequestHandler (const Teuchos::RCP< RequestHandler > &rh)
 Set the request handler with pointers to the appropriate callbacks. More...
 
Teuchos::RCP< RequestHandlergetRequestHandler () const
 Get the request handler with pointers to the appropriate callbacks. More...
 
virtual Teuchos::RCP
< Teuchos::ParameterList > 
getRequestedParameters () const
 Request the additional parameters this preconditioner factory needs. More...
 
virtual bool updateRequestedParameters (const Teuchos::ParameterList &)
 Update this object with the fields from a parameter list. More...
 
bool isCompatible (const Thyra::LinearOpSourceBase< double > &fwdOpSrc) const
 is this operator compatiable with the preconditioner factory? More...
 
Teuchos::RCP
< Thyra::PreconditionerBase
< double > > 
createPrec () const
 create an instance of the preconditioner More...
 
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
 initialize a newly created preconditioner object More...
 
void initializePrec (const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOpSrc, Thyra::PreconditionerBase< double > *precOp, const Thyra::ESupportSolveUse supportSolveUse) const
 initialize a newly created preconditioner object More...
 
void uninitializePrec (Thyra::PreconditionerBase< double > *prec, Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > *fwdOpSrc, Thyra::ESupportSolveUse *supportSolveUse) const
 wipe clean a already initialized preconditioner object More...
 
void setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &paramList)
 Set parameters from a parameter list and return with default values. More...
 
Teuchos::RCP
< Teuchos::ParameterList > 
getNonconstParameterList ()
 Get the parameter list that was set using setParameterList(). More...
 
Teuchos::RCP
< Teuchos::ParameterList > 
unsetParameterList ()
 Unset the parameter list that was set using setParameterList(). More...
 

Protected Member Functions

virtual void initializeFromParameterList (const Teuchos::ParameterList &pl)
 Initialize from a parameter list. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Teko::PreconditionerFactory
static Teuchos::RCP
< PreconditionerFactory
buildPreconditionerFactory (const std::string &name, const Teuchos::ParameterList &settings, const Teuchos::RCP< const InverseLibrary > &invLib=Teuchos::null)
 Builder function for creating preconditioner factories (yes this is a factory factory). More...
 
static void addPreconditionerFactory (const std::string &name, const Teuchos::RCP< Cloneable > &clone)
 Add a preconditioner factory to the builder. This is done using the clone pattern. More...
 
static void getPreconditionerFactoryNames (std::vector< std::string > &names)
 Get the names of the block preconditioner factories. More...
 
- Protected Attributes inherited from Teko::PreconditionerFactory
Teuchos::RCP
< Teuchos::ParameterList > 
paramList_
 for ParameterListAcceptor More...
 
Teuchos::RCP< RequestHandlercallbackHandler_
 For handling requests and send requests back to the user. More...
 

Detailed Description

Declaration of preconditioner factory that creates a preconditioner which is the multiplicative combination of two other preconditioners.

Definition at line 118 of file Teko_MultPreconditionerFactory.hpp.

Constructor & Destructor Documentation

Teko::MultPreconditionerFactory::MultPreconditionerFactory ( const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &  FirstFactory,
const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &  SecondFactory 
)

Constructor.

Member Function Documentation

Teko::LinearOp Teko::MultPreconditionerFactory::buildPreconditionerOperator ( Teko::BlockedLinearOp &  blo,
Teko::BlockPreconditionerState state 
) const
virtual

Function inherited from Teko::BlockPreconditionerFactory.

Use the factory to build the preconditioner (this is where the work goes)

Implements Teko::BlockPreconditionerFactory.

Definition at line 95 of file Teko_MultPreconditionerFactory.cpp.

RCP< Teko::PreconditionerState > Teko::MultPreconditionerFactory::buildPreconditionerState ( ) const
virtual

Build the MultPrecondState object.

Reimplemented from Teko::BlockPreconditionerFactory.

Definition at line 84 of file Teko_MultPreconditionerFactory.cpp.

void Teko::MultPreconditionerFactory::initializeFromParameterList ( const Teuchos::ParameterList &  pl)
protectedvirtual

Initialize from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 129 of file Teko_MultPreconditionerFactory.cpp.


The documentation for this class was generated from the following files: