Belos Package Browser (Single Doxygen Collection) Development
Belos::MinresIteration< ScalarType, MV, OP > Class Template Reference

#include <BelosMinresIteration.hpp>

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

List of all members.

State methods

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

Detailed Description

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

Definition at line 144 of file BelosMinresIteration.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
virtual void Belos::MinresIteration< ScalarType, MV, OP >::initializeMinres ( MinresIterationState< ScalarType, MV >  newstate) [pure virtual]

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

The MinresIteration 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::MinresIter< ScalarType, MV, OP >.

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

Implemented in Belos::MinresIter< 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