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

A Belos::StatusTest class for specifying a maximum number of restarts. More...

#include <BelosStatusTestMaxRestarts.hpp>

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

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructor/Destructor.
 StatusTestMaxRestarts (int maxIters)
 Constructor.
virtual ~StatusTestMaxRestarts ()
 Destructor.
Status methods
StatusType CheckStatus (IterativeSolver< ScalarType, MV, OP > *iSolver)
 Check convergence status of the iterative solver: Unconverged, Converged, Failed.
StatusType GetStatus () const
 Return the result of the most recent CheckStatus call.
Reset methods
void Reset ()
 Resets the internal configuration to the initial state.
Accessor methods
int GetMaxRestarts () const
 Returns the maximum number of restarts set in the constructor.
int GetNumRestarts () const
 Returns the current number of restarts from the most recent StatusTest call.
Attribute methods
bool ResidualVectorRequired () const
 Indicates if residual vector is required by this convergence test: returns false for this class.
Print methods
ostream & Print (ostream &os, int indent=0) const
 Output formatted description of stopping test to output stream.

Detailed Description

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

A Belos::StatusTest class for specifying a maximum number of restarts.

This implementation of the Belos::StatusTest base class tests the number of restarts performed against a maximum number allowed. This status test is only valid for iterative methods which perform restarts, like GMRES.

Definition at line 51 of file BelosStatusTestMaxRestarts.hpp.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::StatusTestMaxRestarts int  maxIters  ) 
 

Constructor.

Definition at line 131 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
virtual Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::~StatusTestMaxRestarts  )  [inline, virtual]
 

Destructor.

Definition at line 62 of file BelosStatusTestMaxRestarts.hpp.


Member Function Documentation

template<class ScalarType, class MV, class OP>
StatusType Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::CheckStatus IterativeSolver< ScalarType, MV, OP > *  iSolver  )  [virtual]
 

Check convergence status of the iterative solver: Unconverged, Converged, Failed.

This method checks to see if the convergence criteria are met using the current information from the iterative solver.

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

Definition at line 143 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
StatusType Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::GetStatus  )  const [inline, virtual]
 

Return the result of the most recent CheckStatus call.

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

Definition at line 75 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
void Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::Reset  )  [virtual]
 

Resets the internal configuration to the initial state.

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

Definition at line 153 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
int Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::GetMaxRestarts  )  const [inline]
 

Returns the maximum number of restarts set in the constructor.

Definition at line 91 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
int Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::GetNumRestarts  )  const [inline]
 

Returns the current number of restarts from the most recent StatusTest call.

Definition at line 94 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
bool Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::ResidualVectorRequired  )  const [inline, virtual]
 

Indicates if residual vector is required by this convergence test: returns false for this class.

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

Definition at line 102 of file BelosStatusTestMaxRestarts.hpp.

template<class ScalarType, class MV, class OP>
ostream & Belos::StatusTestMaxRestarts< ScalarType, MV, OP >::Print ostream &  os,
int  indent = 0
const [virtual]
 

Output formatted description of stopping test to output stream.

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

Definition at line 160 of file BelosStatusTestMaxRestarts.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:30:13 2008 for Belos by doxygen 1.3.9.1