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

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

Status methods
StatusType	checkStatus (Iteration< ScalarType, MV, OP > *iSolver)
	Check convergence status of the iterative solver: Unconverged, Converged, Failed. More...
StatusType	getStatus () const
	Return the result of the most recent CheckStatus call. More...

Reset methods
void	reset ()
	Resets the status test to the initial internal state. More...
void	setMaxIters (int maxIters)
	Sets the maximum number of iterations allowed. More...

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

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

Overridden from Teuchos::Describable
std::string	description () const
	Method to return description of the maximum iteration status test. More...

Private data members.
int	maxIters_
	Maximum number of iterations allowed. More...
int	nIters_
	Current number of iterations. More...
StatusType	status_
	Status. More...

Additional Inherited Members
Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
	StatusTest ()
	Constructor. More...
virtual	~StatusTest ()
	Destructor. More...
Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
virtual	~Describable ()
	LabeledObject ()
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
virtual std::string	getObjectLabel () const
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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 31 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 121 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >

virtual Belos::StatusTestMaxIters< ScalarType, MV, OP >::~StatusTestMaxIters ( )

inlinevirtual

Destructor.

Definition at line 42 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 133 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >

StatusType Belos::StatusTestMaxIters< ScalarType, MV, OP >::getStatus ( ) const

inlinevirtual

Return the result of the most recent CheckStatus call.

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

Definition at line 55 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 143 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 66 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 74 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 77 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 150 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 163 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >

std::string Belos::StatusTestMaxIters< ScalarType, MV, OP >::description ( ) const

inlinevirtual

Method to return description of the maximum iteration status test.

Reimplemented from Teuchos::Describable.

Definition at line 96 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 109 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 112 of file BelosStatusTestMaxIters.hpp.

template<class ScalarType , class MV , class OP >

StatusType Belos::StatusTestMaxIters< ScalarType, MV, OP >::status_

private

Status.

Definition at line 115 of file BelosStatusTestMaxIters.hpp.

---

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

• BelosStatusTestMaxIters.hpp