#include <Teko_TimingsSIMPLEPreconditionerFactory.hpp>

Inheritance diagram for Teko::NS::TimingsSIMPLEPreconditionerFactory:

Public Member Functions
	TimingsSIMPLEPreconditionerFactory ()
	Default constructor. More...

virtual	~TimingsSIMPLEPreconditionerFactory ()
	Destructor that outputs construction timings. More...

LinearOp	buildPreconditionerOperator (BlockedLinearOp &blo, BlockPreconditionerState &state) const
	Function that is called to build the preconditioner for the linear operator that is passed in. More...

virtual void	setMassMatrix (Teko::LinearOp &mass)
	Set the mass matrix for this factory. More...

virtual Teuchos::RCP < Teuchos::ParameterList >	getRequestedParameters () const
	For assisting in construction of the preconditioner. More...

virtual bool	updateRequestedParameters (const Teuchos::ParameterList &pl)
	For assisting in construction of the preconditioner. More...

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

Public Member Functions inherited from Teko::BlockPreconditionerFactory
virtual RCP< PreconditionerState >	buildPreconditionerState () const
	Function that permits the construction of an arbitrary BlockPreconditionerState object. More...

RCP< BlockPreconditionerState >	buildBlockPreconditionerState () 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< RequestHandler >	getRequestHandler () const
	Get the request handler with pointers to the appropriate callbacks. 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...

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< RequestHandler >	callbackHandler_
	For handling requests and send requests back to the user. More...

Detailed Description

The basic XML parameter list for SIMPLE looks like.

<ParameterList name="SIMPLEC">
  <Parameter name="Type" type="string" value="NS SIMPLE-Timed"/>
  <!-- Inverse operations to use -->
  <Parameter name="Inverse Velocity Type" type="string" value="ML_GS-Velocity"/>
  <Parameter name="Inverse Pressure Type" type="string" value="ML_GS-Pressure"/>
  <Parameter name="Explicit Velocity Inverse Type" type="string" value="AbsRowSum"/>
  <Parameter name="Alpha" type="double" value="0.9"/>
</ParameterList>

Definition at line 76 of file Teko_TimingsSIMPLEPreconditionerFactory.hpp.

Constructor & Destructor Documentation

Teko::NS::TimingsSIMPLEPreconditionerFactory::TimingsSIMPLEPreconditionerFactory ( )

Default constructor.

Definition at line 85 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

Teko::NS::TimingsSIMPLEPreconditionerFactory::~TimingsSIMPLEPreconditionerFactory ( )

virtual

Destructor that outputs construction timings.

Definition at line 90 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

Member Function Documentation

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

virtual

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.

Definition at line 108 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

virtual void Teko::NS::TimingsSIMPLEPreconditionerFactory::setMassMatrix ( Teko::LinearOp & mass )

inlinevirtual

Set the mass matrix for this factory.

Definition at line 98 of file Teko_TimingsSIMPLEPreconditionerFactory.hpp.

Teuchos::RCP< Teuchos::ParameterList > Teko::NS::TimingsSIMPLEPreconditionerFactory::getRequestedParameters ( ) const

virtual

For assisting in construction of the preconditioner.

For assiting in construction of the preconditioner.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 370 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

bool Teko::NS::TimingsSIMPLEPreconditionerFactory::updateRequestedParameters ( const Teuchos::ParameterList & pl )

virtual

For assisting in construction of the preconditioner.

For assiting in construction of the preconditioner.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 408 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

void Teko::NS::TimingsSIMPLEPreconditionerFactory::initializeFromParameterList ( const Teuchos::ParameterList & pl )

virtual

Initialize from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 293 of file Teko_TimingsSIMPLEPreconditionerFactory.cpp.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation