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

#include <BelosCGIteration.hpp>

Inheritance diagram for Belos::CGIteration< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

State methods

virtual void initializeCG (CGIterationState< ScalarType, MV > newstate)=0
 Initialize the solver to an iterate, providing a complete state.
virtual CGIterationState
< ScalarType, MV > 
getState () const =0
 Get the current state of the linear solver.

Detailed Description

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

Definition at line 121 of file BelosCGIteration.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual void Belos::CGIteration< ScalarType, MV, OP >::initializeCG ( CGIterationState< ScalarType, MV >  newstate  )  [pure virtual]

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

The CGIteration 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::BlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, and Belos::PseudoBlockCGIter< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >
virtual CGIterationState<ScalarType,MV> Belos::CGIteration< 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 CGIterationState object containing const pointers to the current solver state.

Implemented in Belos::BlockCGIter< ScalarType, MV, OP >, Belos::CGIter< ScalarType, MV, OP >, and Belos::PseudoBlockCGIter< ScalarType, MV, OP >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:09 2011 for Belos by  doxygen 1.6.3