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

#include <BelosStochasticCGIteration.hpp>

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

State methods
virtual void	initializeCG (StochasticCGIterationState< ScalarType, MV > &newstate)=0
	Initialize the solver to an iterate, providing a complete state. More...
virtual StochasticCGIterationState < 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::StochasticCGIteration< ScalarType, MV, OP >

Definition at line 87 of file BelosStochasticCGIteration.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

virtual void Belos::StochasticCGIteration< ScalarType, MV, OP >::initializeCG ( StochasticCGIterationState< ScalarType, MV > &  newstate )

pure virtual

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

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

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

template<class ScalarType , class MV , class OP >

virtual StochasticCGIterationState<ScalarType,MV> Belos::StochasticCGIteration< 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 StochasticCGIterationState object containing const pointers to the current solver state.

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

---

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

• BelosStochasticCGIteration.hpp