This class implements the preconditioned fixed point iteration. More...

#include <BelosFixedPointIter.hpp>

Inheritance diagram for Belos::FixedPointIter< ScalarType, MV, OP >:

Public Types
typedef MultiVecTraits < ScalarType, MV >	MVT

typedef OperatorTraits < ScalarType, MV, OP >	OPT

typedef Teuchos::ScalarTraits < ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

Public Member Functions
Constructors/Destructor
	FixedPointIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, Teuchos::ParameterList &params)
	FixedPointIter constructor with linear problem, solver utilities, and parameter list of solver options. More...

virtual	~FixedPointIter ()
	Destructor. More...

Solver methods
void	iterate ()
	This method performs Fixed Point iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More...

void	initializeFixedPoint (FixedPointIterationState< ScalarType, MV > &newstate)
	Initialize the solver to an iterate, providing a complete state. More...

void	initialize ()
	Initialize the solver with the initial vectors from the linear problem or random data. More...

FixedPointIterationState < ScalarType, MV >	getState () const
	Get the current state of the linear solver. More...

Status methods
int	getNumIters () const
	Get the current iteration count. More...

void	resetNumIters (int iter=0)
	Reset the iteration count. More...

Teuchos::RCP< const MV >	getNativeResiduals (std::vector< MagnitudeType > *) const
	Get the norms of the residuals native to the solver. More...

Teuchos::RCP< MV >	getCurrentUpdate () const
	Get the current update to the linear system. More...

Accessor methods
const LinearProblem < ScalarType, MV, OP > &	getProblem () const
	Get a constant reference to the linear problem. More...

int	getBlockSize () const
	Get the blocksize to be used by the iterative solver in solving this linear problem. More...

void	setBlockSize (int blockSize)
	Set the blocksize to be used by the iterative solver in solving this linear problem. More...

bool	isInitialized ()
	States whether the solver has been initialized or not. More...

State methods
Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP >
	Iteration ()
	Default Constructor. More...

virtual	~Iteration ()
	Destructor. More...

virtual Teuchos::RCP< const MV >	getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0
	Get the residuals native to the solver. More...

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::FixedPointIter< ScalarType, MV, OP >

This class implements the preconditioned fixed point iteration.

Definition at line 77 of file BelosFixedPointIter.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

typedef MultiVecTraits<ScalarType,MV> Belos::FixedPointIter< ScalarType, MV, OP >::MVT

Definition at line 84 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

typedef OperatorTraits<ScalarType,MV,OP> Belos::FixedPointIter< ScalarType, MV, OP >::OPT

Definition at line 85 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

typedef Teuchos::ScalarTraits<ScalarType> Belos::FixedPointIter< ScalarType, MV, OP >::SCT

Definition at line 86 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

typedef SCT::magnitudeType Belos::FixedPointIter< ScalarType, MV, OP >::MagnitudeType

Definition at line 87 of file BelosFixedPointIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::FixedPointIter< ScalarType, MV, OP >::FixedPointIter	(	const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &	problem,
		const Teuchos::RCP< OutputManager< ScalarType > > &	printer,
		const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &	tester,
		Teuchos::ParameterList &	params
	)

FixedPointIter constructor with linear problem, solver utilities, and parameter list of solver options.

This constructor takes pointers required by the linear solver iteration, in addition to a parameter list of options for the linear solver.

Definition at line 253 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

virtual Belos::FixedPointIter< ScalarType, MV, OP >::~FixedPointIter ( )

inlinevirtual

Destructor.

Definition at line 103 of file BelosFixedPointIter.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

void Belos::FixedPointIter< ScalarType, MV, OP >::iterate ( )

virtual

This method performs Fixed Point iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

iterate() will first determine whether the solver is initialized; if not, it will call initialize() using default arguments. After initialization, the solver performs FixedPoint iterations until the status test evaluates as Passed, at which point the method returns to the caller.

The status test is queried at the beginning of the iteration.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 377 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointIter< ScalarType, MV, OP >::initializeFixedPoint ( FixedPointIterationState< ScalarType, MV > & newstate )

virtual

Initialize the solver to an iterate, providing a complete state.

The FixedPointIter contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.

initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.

Postcondition: isInitialized() == true (see post-conditions of isInitialize())

Note: For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

Implements Belos::FixedPointIteration< ScalarType, MV, OP >.

Definition at line 331 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointIter< ScalarType, MV, OP >::initialize ( )

inlinevirtual

Initialize the solver with the initial vectors from the linear problem or random data.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 143 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

FixedPointIterationState<ScalarType,MV> Belos::FixedPointIter< ScalarType, MV, OP >::getState ( ) const

inlinevirtual

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns: A FixedPointIterationState object containing const pointers to the current solver state.

Implements Belos::FixedPointIteration< ScalarType, MV, OP >.

Definition at line 155 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::FixedPointIter< ScalarType, MV, OP >::getNumIters ( ) const

inlinevirtual

Get the current iteration count.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 169 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointIter< ScalarType, MV, OP >::resetNumIters ( int iter = 0 )

inlinevirtual

Reset the iteration count.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 172 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<const MV> Belos::FixedPointIter< ScalarType, MV, OP >::getNativeResiduals ( std::vector< MagnitudeType > * ) const

inline

Get the norms of the residuals native to the solver.

Returns: A std::vector of length blockSize containing the native residuals.

Definition at line 176 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::FixedPointIter< ScalarType, MV, OP >::getCurrentUpdate ( ) const

inlinevirtual

Get the current update to the linear system.

Note: This method returns a null pointer because the linear problem is current.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 181 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

const LinearProblem<ScalarType,MV,OP>& Belos::FixedPointIter< ScalarType, MV, OP >::getProblem ( ) const

inlinevirtual

Get a constant reference to the linear problem.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 189 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::FixedPointIter< ScalarType, MV, OP >::getBlockSize ( ) const

inlinevirtual

Get the blocksize to be used by the iterative solver in solving this linear problem.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 192 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::FixedPointIter< ScalarType, MV, OP >::setBlockSize ( int blockSize )

virtual

Set the blocksize to be used by the iterative solver in solving this linear problem.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 303 of file BelosFixedPointIter.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::FixedPointIter< ScalarType, MV, OP >::isInitialized ( )

inlinevirtual

States whether the solver has been initialized or not.

Implements Belos::Iteration< ScalarType, MV, OP >.

Definition at line 198 of file BelosFixedPointIter.hpp.

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

BelosFixedPointIter.hpp

Public Types

Public Member Functions

Detailed Description

template<class ScalarType, class MV, class OP> class Belos::FixedPointIter< ScalarType, MV, OP >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class ScalarType, class MV, class OP>
class Belos::FixedPointIter< ScalarType, MV, OP >