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

#include <Teko_PreconditionerState.hpp>

Inheritance diagram for Teko::PreconditionerState:

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 > &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...

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...

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 71 of file Teko_PreconditionerState.hpp.

Member Function Documentation

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 63 of file Teko_PreconditionerState.cpp.

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

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

Definition at line 72 of file Teko_PreconditionerState.cpp.

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

inlinevirtual

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

Definition at line 100 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

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

Definition at line 105 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

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

Definition at line 109 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

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

Definition at line 113 of file Teko_PreconditionerState.hpp.

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 117 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

Get a named inverse from the state object.

Definition at line 121 of file Teko_PreconditionerState.hpp.

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 128 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

Add a named operator to the state object.

Definition at line 132 of file Teko_PreconditionerState.hpp.

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 136 of file Teko_PreconditionerState.hpp.

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

inlinevirtual

Add a named operator to the state object.

Definition at line 141 of file Teko_PreconditionerState.hpp.

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

virtual

Merge internal storage of another PreconditionerState object into this one.

Definition at line 80 of file Teko_PreconditionerState.cpp.

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

Get the tag for this operator.

Definition at line 95 of file Teko_PreconditionerState.cpp.

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

Set the tag for this operator.

Definition at line 101 of file Teko_PreconditionerState.cpp.

Member Data Documentation

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

protected

for ParameterListAcceptor

Definition at line 159 of file Teko_PreconditionerState.hpp.

Teko::MultiVector Teko::PreconditionerState::srcVector_

protected

Store a source vector.

Definition at line 162 of file Teko_PreconditionerState.hpp.

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

protected

Store a map of inverse linear operators.

Definition at line 165 of file Teko_PreconditionerState.hpp.

bool Teko::PreconditionerState::isInitialized_

protected

Stores the initialization state.

Definition at line 170 of file Teko_PreconditionerState.hpp.

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

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation