Belos::FixedPointIteration< ScalarType, MV, OP > Class Template Reference

#include <BelosFixedPointIteration.hpp>

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

State methods
virtual void	initializeFixedPoint (FixedPointIterationState< ScalarType, MV > &newstate)=0
	Initialize the solver to an iterate, providing a complete state. More...
virtual FixedPointIterationState < ScalarType, MV >	getState () const =0
	Get the current state of the linear solver. More...

Detailed Description

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

Definition at line 127 of file BelosFixedPointIteration.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

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

pure virtual

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

The FixedPointIteration contains a certain amount of state.

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.

Implemented in Belos::FixedPointIter< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

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

pure virtual

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.

Implemented in Belos::FixedPointIter< ScalarType, MV, OP >.

---

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

• BelosFixedPointIteration.hpp