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

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

#include <BelosStatusTestMaxIters.hpp>

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

List of all members.

Constructor/Destructor.

 StatusTestMaxIters (int maxIters)
 Constructor.
virtual ~StatusTestMaxIters ()
 Destructor.

Status methods

StatusType checkStatus (Iteration< 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 status test to the initial internal state.
void setMaxIters (int maxIters)
 Sets the maximum number of iterations allowed.

Accessor methods

int getMaxIters () const
 Returns the maximum number of iterations set in the constructor.
int getNumIters () const
 Returns the current number of iterations from the most recent StatusTest call.

Print methods

void print (std::ostream &os, int indent=0) const
 Output formatted description of stopping test to output stream.
void printStatus (std::ostream &os, StatusType type) const
 Print message for each status specific to this stopping test.

Overridden from Teuchos::Describable

std::string description () const
 Method to return description of the maximum iteration status test.

Private data members.

int maxIters_
 Maximum number of iterations allowed.
int nIters_
 Current number of iterations.
StatusType status_
 Status.

Detailed Description

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

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

This implementation of the Belos::StatusTest base class tests the number of iterations performed against a maximum number allowed.

Definition at line 63 of file BelosStatusTestMaxIters.hpp.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 153 of file BelosStatusTestMaxIters.hpp.

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

Destructor.

Definition at line 74 of file BelosStatusTestMaxIters.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
StatusType Belos::StatusTestMaxIters< ScalarType, MV, OP >::checkStatus ( Iteration< 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 165 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
StatusType Belos::StatusTestMaxIters< 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 87 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestMaxIters< ScalarType, MV, OP >::reset ( ) [virtual]

Resets the status test to the initial internal state.

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

Definition at line 175 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestMaxIters< ScalarType, MV, OP >::setMaxIters ( int  maxIters) [inline]

Sets the maximum number of iterations allowed.

Definition at line 98 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
int Belos::StatusTestMaxIters< ScalarType, MV, OP >::getMaxIters ( ) const [inline]

Returns the maximum number of iterations set in the constructor.

Definition at line 106 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
int Belos::StatusTestMaxIters< ScalarType, MV, OP >::getNumIters ( ) const [inline]

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

Definition at line 109 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestMaxIters< ScalarType, MV, OP >::print ( std::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 182 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestMaxIters< ScalarType, MV, OP >::printStatus ( std::ostream &  os,
StatusType  type 
) const [virtual]

Print message for each status specific to this stopping test.

Reimplemented from Belos::StatusTest< ScalarType, MV, OP >.

Definition at line 195 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
std::string Belos::StatusTestMaxIters< ScalarType, MV, OP >::description ( ) const [inline, virtual]

Method to return description of the maximum iteration status test.

Reimplemented from Teuchos::Describable.

Definition at line 128 of file BelosStatusTestMaxIters.hpp.


Member Data Documentation

template<class ScalarType , class MV , class OP >
int Belos::StatusTestMaxIters< ScalarType, MV, OP >::maxIters_ [private]

Maximum number of iterations allowed.

Definition at line 141 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
int Belos::StatusTestMaxIters< ScalarType, MV, OP >::nIters_ [private]

Current number of iterations.

Definition at line 144 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >
StatusType Belos::StatusTestMaxIters< ScalarType, MV, OP >::status_ [private]

Status.

Definition at line 147 of file BelosStatusTestMaxIters.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines