A special StatusTest for printing other status tests in a simple format. More...

#include <BelosStatusTestResNormOutput.hpp>

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

Private Types
typedef MultiVecTraits< ScalarType, MV >	MVT
typedef Belos::StatusTestCombo< ScalarType, MV, OP >	StatusTestCombo_t
typedef Belos::StatusTestResNorm< ScalarType, MV, OP >	StatusTestResNorm_t
typedef Belos::StatusTestMaxIters< ScalarType, MV, OP >	StatusTestMaxIters_t

Print methods
Teuchos::RCP< OutputManager< ScalarType > >	printer_
Teuchos::RCP< StatusTest< ScalarType, MV, OP > >	test_
Teuchos::RCP< StatusTestMaxIters< ScalarType, MV, OP > >	iterTest_
std::vector< Teuchos::RCP< StatusTestResNorm< ScalarType, MV, OP > > >	resTestVec_
	Vector of residual status tests.
std::string	solverDesc_
std::string	precondDesc_
std::vector< int >	currIdx_
StatusType	state_
bool	headerPrinted_
int	stateTest_
int	modTest_
int	lastNumIters_
int	comboType_
int	numResTests_
int	blockSize_
int	currNumRHS_
int	currLSNum_
int	numLSDgts_
int	numIterDgts_
void	print (std::ostream &os, int indent=0) const
	Output formatted description of stopping test to output stream.

Constructors/destructors
	StatusTestResNormOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
	Constructor.
virtual	~StatusTestResNormOutput ()
	Destructor.

Status methods
StatusType	checkStatus (Iteration< ScalarType, MV, OP > *solver)
StatusType	getStatus () const
	Return the result of the most recent checkStatus call, or undefined if it has not been run.

Accessor methods
void	setOutputManager (const Teuchos::RCP< OutputManager< ScalarType > > &printer)
	Set the output manager.
void	setOutputFrequency (int mod)
	Set how often the child test is printed.
void	setChild (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)
	Set child test, which must be a combination of a Belos::StatusTestMaxIters AND a single or combination of Belos::StatusTestResNorms.
Teuchos::RCP< StatusTest< ScalarType, MV, OP > >	getChild () const
	Get child test.
void	setSolverDesc (const std::string &solverDesc)
	Set a short solver description for output clarity.
void	setPrecondDesc (const std::string &precondDesc)
	Set a short preconditioner description for output clarity.

Reset methods
void	reset ()
	Informs the status test that it should reset its internal configuration to the uninitialized state.
void	resetNumCalls ()
	Informs the outputting status test that it should reset the number of calls to zero.

Additional Inherited Members
	StatusTestOutput ()
	Default constructor.
	StatusTestOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
	Constructor.
virtual	~StatusTestOutput ()
	Destructor.
	StatusTest ()
	Constructor.
virtual	~StatusTest ()
	Destructor.
virtual void	printStatus (std::ostream &os, StatusType type) const
	Output the result of the most recent CheckStatus call.

Detailed Description

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

A special StatusTest for printing other status tests in a simple format.

StatusTestResNormOutput is a wrapper around an StatusTest that calls StatusTest::print() on the underlying object on calls to StatusTestResNormOutput::checkStatus(). The frequency and occasion of the printing can be dictated according to some parameters passed to StatusTestResNormOutput::StatusTestResNormOutput().

Definition at line 74 of file BelosStatusTestResNormOutput.hpp.

Member Typedef Documentation

◆ MVT

template<class ScalarType, class MV, class OP>

typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestResNormOutput< ScalarType, MV, OP >::MVT

private

Definition at line 76 of file BelosStatusTestResNormOutput.hpp.

◆ StatusTestCombo_t

template<class ScalarType, class MV, class OP>

typedef Belos::StatusTestCombo<ScalarType,MV,OP> Belos::StatusTestResNormOutput< ScalarType, MV, OP >::StatusTestCombo_t

private

Definition at line 77 of file BelosStatusTestResNormOutput.hpp.

◆ StatusTestResNorm_t

template<class ScalarType, class MV, class OP>

typedef Belos::StatusTestResNorm<ScalarType,MV,OP> Belos::StatusTestResNormOutput< ScalarType, MV, OP >::StatusTestResNorm_t

private

Definition at line 78 of file BelosStatusTestResNormOutput.hpp.

◆ StatusTestMaxIters_t

template<class ScalarType, class MV, class OP>

typedef Belos::StatusTestMaxIters<ScalarType,MV,OP> Belos::StatusTestResNormOutput< ScalarType, MV, OP >::StatusTestMaxIters_t

private

Definition at line 79 of file BelosStatusTestResNormOutput.hpp.

Constructor & Destructor Documentation

◆ StatusTestResNormOutput()

template<class ScalarType, class MV, class OP>

Belos::StatusTestResNormOutput< ScalarType, MV, OP >::StatusTestResNormOutput	(	const Teuchos::RCP< OutputManager< ScalarType > > &	printer,
		Teuchos::RCP< StatusTest< ScalarType, MV, OP > >	test,
		int	mod = 1,
		int	printStates = Passed )

inline

Constructor.

The StatusTestResNormOutput requires an OutputManager for printing the underlying StatusTest on calls to checkStatus(), as well as an underlying StatusTest.

The last two parameters, described below, in addition to the verbosity level of the OutputManager, control when printing is called. When both the mod criterion and the printStates criterion are satisfied, the status test will be printed to the OutputManager with ::MsgType of ::StatusTestDetails.

Parameters

[in]	test	A reference-counted pointer to an object that combines Belos::StatusTestMaxIters and a set of Belos::StatusTestResNorm
[in]	mod	A positive number describes how often the output should be printed. On every call to checkStatus(), an internal counter is incremented. Printing may only occur when this counter is congruent to zero modulo `mod`. Default: 1 (attempt to print on every call to checkStatus())
[in]	printStates	A combination of ::StatusType values for which the output may be printed. Default: ::Passed (attempt to print whenever checkStatus() will return ::Passed)

Definition at line 100 of file BelosStatusTestResNormOutput.hpp.

◆ ~StatusTestResNormOutput()

template<class ScalarType, class MV, class OP>

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

inlinevirtual

Destructor.

Definition at line 123 of file BelosStatusTestResNormOutput.hpp.

Member Function Documentation

◆ checkStatus()

template<class ScalarType, class MV, class OP>

StatusType Belos::StatusTestResNormOutput< ScalarType, MV, OP >::checkStatus ( Iteration< ScalarType, MV, OP > * solver )

inlinevirtual

Check and return status of underlying StatusTest.

This method calls checkStatus() on the StatusTest object passed in the constructor. If appropriate, the method will follow this call with a call to print() on the underlying object, using the OutputManager passed via the constructor with verbosity level ::StatusTestDetails.

The internal counter will be incremented during this call, but only after performing the tests to decide whether or not to print the underlying StatusTest. This way, the very first call to checkStatus() following initialization or reset() will enable the underlying StatusTest to be printed, regardless of the mod parameter, as the current number of calls will be zero.

If the specified Teuchos::RCP for the child class is Teuchos::null, then calling checkStatus() will result in a StatusTestError std::exception being thrown.

Returns: ::StatusType indicating whether the underlying test passed or failed.

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

Definition at line 145 of file BelosStatusTestResNormOutput.hpp.

◆ getStatus()

template<class ScalarType, class MV, class OP>

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

inlinevirtual

Return the result of the most recent checkStatus call, or undefined if it has not been run.

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

Definition at line 179 of file BelosStatusTestResNormOutput.hpp.

◆ setOutputManager()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::setOutputManager ( const Teuchos::RCP< OutputManager< ScalarType > > & printer )

inlinevirtual

Set the output manager.

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

Definition at line 190 of file BelosStatusTestResNormOutput.hpp.

◆ setOutputFrequency()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::setOutputFrequency ( int mod )

inlinevirtual

Set how often the child test is printed.

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

Definition at line 194 of file BelosStatusTestResNormOutput.hpp.

◆ setChild()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::setChild ( Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test )

inlinevirtual

Set child test, which must be a combination of a Belos::StatusTestMaxIters AND a single or combination of Belos::StatusTestResNorms.

Note: This also resets the test status to ::Undefined.

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

Definition at line 200 of file BelosStatusTestResNormOutput.hpp.

◆ getChild()

template<class ScalarType, class MV, class OP>

Teuchos::RCP< StatusTest< ScalarType, MV, OP > > Belos::StatusTestResNormOutput< ScalarType, MV, OP >::getChild ( ) const

inlinevirtual

Get child test.

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

Definition at line 251 of file BelosStatusTestResNormOutput.hpp.

◆ setSolverDesc()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::setSolverDesc ( const std::string & solverDesc )

inlinevirtual

Set a short solver description for output clarity.

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

Definition at line 257 of file BelosStatusTestResNormOutput.hpp.

◆ setPrecondDesc()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::setPrecondDesc ( const std::string & precondDesc )

inlinevirtual

Set a short preconditioner description for output clarity.

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

Definition at line 261 of file BelosStatusTestResNormOutput.hpp.

◆ reset()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::reset ( )

inlinevirtual

Informs the status test that it should reset its internal configuration to the uninitialized state.

This resets the cached state to an ::Undefined state and calls reset() on the underlying test. It also resets the counter for the number of calls to checkStatus().

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

Definition at line 272 of file BelosStatusTestResNormOutput.hpp.

◆ resetNumCalls()

template<class ScalarType, class MV, class OP>

void Belos::StatusTestResNormOutput< ScalarType, MV, OP >::resetNumCalls ( )

inlinevirtual

Informs the outputting status test that it should reset the number of calls to zero.

Note: This outputting status test relies on the number of iterations performed, not number of times the status test has been called, so this method has no effect.

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

Definition at line 283 of file BelosStatusTestResNormOutput.hpp.