Teko Version of the Day
Loading...
Searching...
No Matches
List of all members
Teko::IdentityPreconditionerFactory Class Reference

#include <Teko_IdentityPreconditionerFactory.hpp>

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

Constructors.

double scaling_
 some members
 
 IdentityPreconditionerFactory ()
 
LinearOp buildPreconditionerOperator (LinearOp &lo, PreconditionerState &state) const
 Create the Identity preconditioner operator.
 
virtual void initializeFromParameterList (const Teuchos::ParameterList &pl)
 Initialize from a parameter list.
 

Additional Inherited Members

- Public Member Functions inherited from Teko::PreconditionerFactory
virtual Teuchos::RCP< PreconditionerStatebuildPreconditionerState () const
 Function that permits the construction of an arbitrary PreconditionerState object.
 
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< RequestHandlergetRequestHandler () const
 Get the request handler with pointers to the appropriate callbacks.
 
- Static Public Member Functions inherited from Teko::PreconditionerFactory
static Teuchos::RCP< PreconditionerFactorybuildPreconditionerFactory (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.
 
- Protected Attributes inherited from Teko::PreconditionerFactory
Teuchos::RCP< Teuchos::ParameterList > paramList_
 for ParameterListAcceptor
 
Teuchos::RCP< RequestHandlercallbackHandler_
 For handling requests and send requests back to the user.
 

Detailed Description

Uses a scaled identity operator as the approximate inverse. This is a last resort!

<Parameter name="Type" type="string" value="Identity"/>
<Parameter name="Scaling" type="double" value="<Some value>"/>

Definition at line 65 of file Teko_IdentityPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ IdentityPreconditionerFactory()

Teko::IdentityPreconditionerFactory::IdentityPreconditionerFactory ( )

Build an empty Identity preconditioner factory.

Build a Identity preconditioner factory from a parameter list

Definition at line 58 of file Teko_IdentityPreconditionerFactory.cpp.

Member Function Documentation

◆ buildPreconditionerOperator()

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

Create the Identity preconditioner operator.

This method breaks apart the BlockLinearOp and builds a block diagonal preconditioner. The inverse of the diagonals are specified by the BlockInvDiagonalStrategy object.

Implements Teko::PreconditionerFactory.

Definition at line 62 of file Teko_IdentityPreconditionerFactory.cpp.

◆ initializeFromParameterList()

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

Initialize from a parameter list.

Reimplemented from Teko::PreconditionerFactory.

Definition at line 68 of file Teko_IdentityPreconditionerFactory.cpp.

Member Data Documentation

◆ scaling_

double Teko::IdentityPreconditionerFactory::scaling_
protected

some members

Definition at line 86 of file Teko_IdentityPreconditionerFactory.hpp.


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