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 >:

[legend]List of all members.

Public Member Functions
Constructor/Destructor.
	StatusTestMaxIters (int maxIters)
	Constructor.
virtual	~StatusTestMaxIters ()
	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 status test to the initial internal state.
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.
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::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 50 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 130 of file BelosStatusTestMaxIters.hpp.

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

Destructor. Definition at line 61 of file BelosStatusTestMaxIters.hpp.

---

Member Function Documentation

template<class ScalarType, class MV, class OP> StatusType Belos::StatusTestMaxIters< 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 142 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 74 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 152 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 90 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 93 of file BelosStatusTestMaxIters.hpp.

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

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

---

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

• BelosStatusTestMaxIters.hpp

---