Teko::Preconditioner Class Reference

An extension of the Thyra::DefaultPreconditioner class with some specializations useful for use within Teko. More...

#include <Teko_Preconditioner.hpp>

Inherits DefaultPreconditioner< double >.

Public Member Functions
virtual void	setSourceVector (const RCP< Thyra::MultiVectorBase< double > > &srcVec)
virtual void	setStateObject (const RCP< PreconditionerState > &state)
virtual const RCP < PreconditionerState >	getStateObject ()
virtual const RCP< const PreconditionerState >	getStateObject () const
virtual void	mergeStateObject (const PreconditionerState &state)
Constructors based from Thyra::DefaultPreconditioner
	Preconditioner ()
	Preconditioner (const RCP< LinearOpBase< double > > &leftPrecOp, const RCP< LinearOpBase< double > > &rightPrecOp)
	Preconditioner (const RCP< const LinearOpBase< double > > &leftPrecOp, const RCP< const LinearOpBase< double > > &rightPrecOp)
	Preconditioner (const RCP< LinearOpBase< double > > &unspecifiedPrecOp)
	Preconditioner (const RCP< const LinearOpBase< double > > &unspecifiedPrecOp)

Protected Attributes
RCP< PreconditionerState >	state_
	User defined state for this preconditioner. More...

Detailed Description

An extension of the Thyra::DefaultPreconditioner class with some specializations useful for use within Teko.

An extension of the Thyra::DefaultPreconditioner class with some specializations useful for use within Teko. This includes having facilities to store the source vector and the state object.

Definition at line 70 of file Teko_Preconditioner.hpp.

Member Function Documentation

virtual void Teko::Preconditioner::setSourceVector ( const RCP< Thyra::MultiVectorBase< double > > &  srcVec )

inlinevirtual

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

Parameters

[in]

srcVec

The source vector associated with this preconditioner.

Definition at line 92 of file Teko_Preconditioner.hpp.

virtual void Teko::Preconditioner::setStateObject ( const RCP< PreconditionerState > &  state )

inlinevirtual

Set the state object associated with this preconditioner

Parameters

[in]

state

The state object to use

Definition at line 100 of file Teko_Preconditioner.hpp.

virtual const RCP<PreconditionerState> Teko::Preconditioner::getStateObject ( )

inlinevirtual

Get the state object associated with this preconditioner

Returns

The state object used by this preconditioner

Definition at line 107 of file Teko_Preconditioner.hpp.

virtual const RCP<const PreconditionerState> Teko::Preconditioner::getStateObject ( ) const

inlinevirtual

Get the state object associated with this preconditioner

Returns

The state object used by this preconditioner

Definition at line 114 of file Teko_Preconditioner.hpp.

virtual void Teko::Preconditioner::mergeStateObject ( const PreconditionerState &  state )

inlinevirtual

Merge a state object into the one used by this Preconditioner (Merge in this case is the same as that used by PreconditionerState::merge).

Parameters

[in]

state

A state object to merge into the internal state object.

Definition at line 122 of file Teko_Preconditioner.hpp.

Member Data Documentation

RCP<PreconditionerState> Teko::Preconditioner::state_

protected

User defined state for this preconditioner.

Definition at line 127 of file Teko_Preconditioner.hpp.

---

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

• Teko_Preconditioner.hpp