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

An implementation of a state object preconditioners. More...

#include <Teko_PreconditionerState.hpp>

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

for ParameterListAcceptor

Teuchos::RCP< Teuchos::ParameterList > paramList_
 for ParameterListAcceptor
Teko::MultiVector srcVector_
 Store a source vector.
std::map< std::string, Teko::InverseLinearOp > inverses_
 Store a map of inverse linear operators.
bool isInitialized_
 Stores the initialization state.
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().
virtual bool isInitialized () const
virtual void setInitialized (bool init=true)
virtual void setSourceVector (const Teko::MultiVector &srcVec)
 Set the vector associated with this operator (think nonlinear system).
virtual const Teko::MultiVector getSourceVector () const
 Set the vector associated with this operator (think nonlinear system).
virtual void addInverse (const std::string &name, const Teko::InverseLinearOp &ilo)
 Add a named inverse to the state object.
virtual Teko::InverseLinearOp getInverse (const std::string &name) const
 Get a named inverse from the state object.
virtual void addLinearOp (const std::string &name, const Teko::LinearOp &lo)
 Add a named operator to the state object.
virtual Teko::LinearOp getLinearOp (const std::string &name)
 Add a named operator to the state object.
virtual void addModifiableOp (const std::string &name, const Teko::ModifiableLinearOp &mlo)
 Add a named operator to the state object.
virtual Teko::ModifiableLinearOp & getModifiableOp (const std::string &name)
 Add a named operator to the state object.
virtual void merge (const PreconditionerState &ps, int position=-1)
 Merge internal storage of another PreconditionerState object into this one.
unsigned int getTag () const
 Get the tag for this operator.
void setTag (unsigned int tag)
 Set the tag for this operator.

Detailed Description

An implementation of a state object preconditioners.

An implementation of a state object for preconditioners. This implementation takes a parameter list and has capacity to store linear operators. However, it is easy to override this class and fill it with what ever is neccessary to build the preconditioner. This is essentially a "bag" that can be filled with whatever a user wants.

Definition at line 34 of file Teko_PreconditionerState.hpp.

Member Function Documentation

◆ setParameterList()

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

Set parameters from a parameter list and return with default values.

Definition at line 20 of file Teko_PreconditionerState.cpp.

◆ getNonconstParameterList()

RCP< Teuchos::ParameterList > Teko::PreconditionerState::getNonconstParameterList ( )

Get the parameter list that was set using setParameterList().

Definition at line 25 of file Teko_PreconditionerState.cpp.

◆ unsetParameterList()

RCP< Teuchos::ParameterList > Teko::PreconditionerState::unsetParameterList ( )

Unset the parameter list that was set using setParameterList().

Definition at line 32 of file Teko_PreconditionerState.cpp.

◆ isInitialized()

virtual bool Teko::PreconditionerState::isInitialized ( ) const
inlinevirtual

Has this state object been initialized for the particular operator being used?

Definition at line 63 of file Teko_PreconditionerState.hpp.

◆ setInitialized()

virtual void Teko::PreconditionerState::setInitialized ( bool init = true)
inlinevirtual

Set that this state object has been initialized for this operator.

Definition at line 67 of file Teko_PreconditionerState.hpp.

◆ setSourceVector()

virtual void Teko::PreconditionerState::setSourceVector ( const Teko::MultiVector & srcVec)
inlinevirtual

Set the vector associated with this operator (think nonlinear system).

Definition at line 70 of file Teko_PreconditionerState.hpp.

◆ getSourceVector()

virtual const Teko::MultiVector Teko::PreconditionerState::getSourceVector ( ) const
inlinevirtual

Set the vector associated with this operator (think nonlinear system).

Definition at line 73 of file Teko_PreconditionerState.hpp.

◆ addInverse()

virtual void Teko::PreconditionerState::addInverse ( const std::string & name,
const Teko::InverseLinearOp & ilo )
inlinevirtual

Add a named inverse to the state object.

Definition at line 76 of file Teko_PreconditionerState.hpp.

◆ getInverse()

virtual Teko::InverseLinearOp Teko::PreconditionerState::getInverse ( const std::string & name) const
inlinevirtual

Get a named inverse from the state object.

Definition at line 81 of file Teko_PreconditionerState.hpp.

◆ addLinearOp()

virtual void Teko::PreconditionerState::addLinearOp ( const std::string & name,
const Teko::LinearOp & lo )
inlinevirtual

Add a named operator to the state object.

Definition at line 89 of file Teko_PreconditionerState.hpp.

◆ getLinearOp()

virtual Teko::LinearOp Teko::PreconditionerState::getLinearOp ( const std::string & name)
inlinevirtual

Add a named operator to the state object.

Definition at line 94 of file Teko_PreconditionerState.hpp.

◆ addModifiableOp()

virtual void Teko::PreconditionerState::addModifiableOp ( const std::string & name,
const Teko::ModifiableLinearOp & mlo )
inlinevirtual

Add a named operator to the state object.

Definition at line 97 of file Teko_PreconditionerState.hpp.

◆ getModifiableOp()

virtual Teko::ModifiableLinearOp & Teko::PreconditionerState::getModifiableOp ( const std::string & name)
inlinevirtual

Add a named operator to the state object.

Definition at line 102 of file Teko_PreconditionerState.hpp.

◆ merge()

void Teko::PreconditionerState::merge ( const PreconditionerState & ps,
int position = -1 )
virtual

Merge internal storage of another PreconditionerState object into this one.

Definition at line 39 of file Teko_PreconditionerState.cpp.

◆ getTag()

unsigned int Teko::PreconditionerState::getTag ( ) const

Get the tag for this operator.

Definition at line 53 of file Teko_PreconditionerState.cpp.

◆ setTag()

void Teko::PreconditionerState::setTag ( unsigned int tag)

Set the tag for this operator.

Definition at line 56 of file Teko_PreconditionerState.cpp.

Member Data Documentation

◆ paramList_

Teuchos::RCP<Teuchos::ParameterList> Teko::PreconditionerState::paramList_
protected

for ParameterListAcceptor

Definition at line 120 of file Teko_PreconditionerState.hpp.

◆ srcVector_

Teko::MultiVector Teko::PreconditionerState::srcVector_
protected

Store a source vector.

Definition at line 123 of file Teko_PreconditionerState.hpp.

◆ inverses_

std::map<std::string, Teko::InverseLinearOp> Teko::PreconditionerState::inverses_
protected

Store a map of inverse linear operators.

Definition at line 126 of file Teko_PreconditionerState.hpp.

◆ isInitialized_

bool Teko::PreconditionerState::isInitialized_
protected

Stores the initialization state.

Definition at line 131 of file Teko_PreconditionerState.hpp.

The documentation for this class was generated from the following files:
Generated on for Teko by doxygen 1.15.0