An implementation of a state object preconditioners. More...
#include <Teko_PreconditionerState.hpp>
Public Member Functions | |
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) More... | |
virtual const Teko::MultiVector | getSourceVector () const |
Set the vector associated with this operator (think nonlinear system) More... | |
virtual void | addInverse (const std::string &name, const Teko::InverseLinearOp &ilo) |
Add a named inverse to the state object. More... | |
virtual Teko::InverseLinearOp | getInverse (const std::string &name) const |
Get a named inverse from the state object. More... | |
virtual void | addLinearOp (const std::string &name, const Teko::LinearOp &lo) |
Add a named operator to the state object. More... | |
virtual Teko::LinearOp | getLinearOp (const std::string &name) |
Add a named operator to the state object. More... | |
virtual void | addModifiableOp (const std::string &name, const Teko::ModifiableLinearOp &mlo) |
Add a named operator to the state object. More... | |
virtual Teko::ModifiableLinearOp & | getModifiableOp (const std::string &name) |
Add a named operator to the state object. More... | |
virtual void | merge (const PreconditionerState &ps, int position=-1) |
Merge internal storage of another PreconditionerState object into this one. More... | |
unsigned int | getTag () const |
Get the tag for this operator. More... | |
void | setTag (unsigned int tag) |
Set the tag for this operator. More... | |
Default and copy constructors | |
PreconditionerState () | |
PreconditionerState (const PreconditionerState &src) | |
for ParameterListAcceptor | |
void | setParameterList (const Teuchos::RCP< Teuchos::ParameterList > ¶mList) |
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 Attributes | |
Teuchos::RCP < Teuchos::ParameterList > | paramList_ |
for ParameterListAcceptor More... | |
Teko::MultiVector | srcVector_ |
Store a source vector. More... | |
std::map< std::string, Teko::InverseLinearOp > | inverses_ |
Store a map of inverse linear operators. More... | |
bool | isInitialized_ |
Stores the initialization state. More... | |
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 71 of file Teko_PreconditionerState.hpp.
void Teko::PreconditionerState::setParameterList | ( | const Teuchos::RCP< Teuchos::ParameterList > & | paramList | ) |
Set parameters from a parameter list and return with default values.
Definition at line 57 of file Teko_PreconditionerState.cpp.
RCP< Teuchos::ParameterList > Teko::PreconditionerState::getNonconstParameterList | ( | ) |
Get the parameter list that was set using setParameterList().
Definition at line 62 of file Teko_PreconditionerState.cpp.
RCP< Teuchos::ParameterList > Teko::PreconditionerState::unsetParameterList | ( | ) |
Unset the parameter list that was set using setParameterList().
Definition at line 69 of file Teko_PreconditionerState.cpp.
|
inlinevirtual |
Has this state object been initialized for the particular operator being used?
Definition at line 100 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Set that this state object has been initialized for this operator.
Definition at line 104 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Set the vector associated with this operator (think nonlinear system)
Definition at line 107 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Set the vector associated with this operator (think nonlinear system)
Definition at line 110 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Add a named inverse to the state object.
Definition at line 113 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Get a named inverse from the state object.
Definition at line 118 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Add a named operator to the state object.
Definition at line 126 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Add a named operator to the state object.
Definition at line 131 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Add a named operator to the state object.
Definition at line 134 of file Teko_PreconditionerState.hpp.
|
inlinevirtual |
Add a named operator to the state object.
Definition at line 139 of file Teko_PreconditionerState.hpp.
|
virtual |
Merge internal storage of another PreconditionerState object into this one.
Definition at line 76 of file Teko_PreconditionerState.cpp.
unsigned int Teko::PreconditionerState::getTag | ( | ) | const |
Get the tag for this operator.
Definition at line 90 of file Teko_PreconditionerState.cpp.
void Teko::PreconditionerState::setTag | ( | unsigned int | tag | ) |
Set the tag for this operator.
Definition at line 93 of file Teko_PreconditionerState.cpp.
|
protected |
for ParameterListAcceptor
Definition at line 157 of file Teko_PreconditionerState.hpp.
|
protected |
Store a source vector.
Definition at line 160 of file Teko_PreconditionerState.hpp.
|
protected |
Store a map of inverse linear operators.
Definition at line 163 of file Teko_PreconditionerState.hpp.
|
protected |
Stores the initialization state.
Definition at line 168 of file Teko_PreconditionerState.hpp.