#include <Teko_MultPreconditionerFactory.hpp>

Inheritance diagram for Teko::MultPreconditionerFactory:

[legend]

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

Protected Member Functions
virtual void	initializeFromParameterList (const Teuchos::ParameterList &pl)
	Initialize from a parameter list.
virtual LinearOp	buildPreconditionerOperator (BlockedLinearOp &blo, BlockPreconditionerState &state) const=0
	Function that is called to build the preconditioner for the linear operator that is passed in.
virtual LinearOp	buildPreconditionerOperator (LinearOp &blo, PreconditionerState &state) const
	Function that is called to build the preconditioner for the linear operator that is passed in.

Additional Inherited Members
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).
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.
static void	getPreconditionerFactoryNames (std::vector< std::string > &names)
	Get the names of the block preconditioner factories.
Teuchos::RCP< Teuchos::ParameterList >	paramList_
	for ParameterListAcceptor
Teuchos::RCP< RequestHandler >	callbackHandler_
	For handling requests and send requests back to the user.

Detailed Description

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

Definition at line 80 of file Teko_MultPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ MultPreconditionerFactory()

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

Constructor.

Member Function Documentation

◆ buildPreconditionerOperator() [1/3]

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

Function inherited from Teko::BlockPreconditionerFactory.

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

Definition at line 55 of file Teko_MultPreconditionerFactory.cpp.

◆ buildPreconditionerState()

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

virtual

Build the MultPrecondState object.

Reimplemented from Teko::BlockPreconditionerFactory.

Definition at line 45 of file Teko_MultPreconditionerFactory.cpp.

◆ initializeFromParameterList()

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

protectedvirtual

Initialize from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 88 of file Teko_MultPreconditionerFactory.cpp.

◆ buildPreconditionerOperator() [2/3]

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

protectedvirtual

Function that is called to build the preconditioner for the linear operator that is passed in.

This function builds a preconditioner based on the passed in BlockedLinearOp.

Parameters

[in]	blo	Source linear operator that is to be preconditioned.
[in]	state	An object associated with this operator to store the preconditioner state.

Returns: The preconditioner as a linear operator (i.e. to perform a matrix-vector operation simply call "apply").

Implements Teko::BlockPreconditionerFactory.

◆ buildPreconditionerOperator() [3/3]

LinearOp Teko::BlockPreconditionerFactory::buildPreconditionerOperator	(	LinearOp &	lo,
		PreconditionerState &	state ) const

protectedvirtual

Function that is called to build the preconditioner for the linear operator that is passed in.

This function builds a preconditioner based on the passed in LinearOp.

Parameters

[in]	lo	Source linear operator that is to be preconditioned.
[in]	state	An object associated with this operator to store the preconditioner state.

Returns: The preconditioner as a linear operator (i.e. to perform a matrix-vector operation simply call "apply").

Reimplemented from Teko::BlockPreconditionerFactory.

Definition at line 107 of file Teko_BlockPreconditionerFactory.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultPreconditionerFactory()

Member Function Documentation

◆ buildPreconditionerOperator() [1/3]

◆ buildPreconditionerState()

◆ initializeFromParameterList()

◆ buildPreconditionerOperator() [2/3]

◆ buildPreconditionerOperator() [3/3]