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

A virtual base class for StatusTest that print other status tests. More...

#include <BelosStatusTestOutput.hpp>

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

List of all members.

Public Member Functions
Constructors/destructors
	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.
Accessor methods
virtual void	setOutputManager (const Teuchos::RCP< OutputManager< ScalarType > > &printer)=0
	Set the output manager.
virtual void	setOutputFrequency (int mod)=0
	Set how often the child test is printed.
virtual void	setChild (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)=0
	Set child test.
virtual Teuchos::RCP < StatusTest< ScalarType, MV, OP > >	getChild () const =0
	Get child test.
virtual void	setSolverDesc (const std::string &solverDesc)=0
	Set a short solver description for output clarity.
virtual void	setPrecondDesc (const std::string &precondDesc)=0
	Set a short preconditioner description for output clarity.
Reset methods
virtual void	resetNumCalls ()=0
	Informs the outputting status test that it should reset the number of calls to zero.

---

Detailed Description

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

A virtual base class for StatusTest that print other status tests.

StatusTestOutput provides an interface for status tests that wrap another StatusTest. These printing status tests can be generic, calling StatusTest::print() on the underlying object, or can specifically require input status tests to be of a certain type. The frequency and occasion of the printing can be dictated according to some parameters passed to StatusTestOutput::StatusTestOutput().

Definition at line 72 of file BelosStatusTestOutput.hpp.

---

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

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

(

)

[inline]

Default constructor.

Definition at line 79 of file BelosStatusTestOutput.hpp.

template<class ScalarType , class MV , class OP >

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

Constructor.

The StatusTestOutput 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]	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 95 of file BelosStatusTestOutput.hpp.

template<class ScalarType , class MV , class OP >

virtual Belos::StatusTestOutput< ScalarType, MV, OP >::~StatusTestOutput

(

)

[inline, virtual]

Destructor.

Definition at line 102 of file BelosStatusTestOutput.hpp.

---

Member Function Documentation

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setOutputManager

(

const Teuchos::RCP< OutputManager< ScalarType > > &

printer

)

[pure virtual]

Set the output manager.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setOutputFrequency

(

int

mod

)

[pure virtual]

Set how often the child test is printed.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setChild

(

Teuchos::RCP< StatusTest< ScalarType, MV, OP > >

test

)

[pure virtual]

Set child test.

Note:

This also resets the test status to Undefined.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::StatusTestOutput< ScalarType, MV, OP >::getChild

(

)

const [pure virtual]

Get child test.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setSolverDesc

(

const std::string &

solverDesc

)

[pure virtual]

Set a short solver description for output clarity.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setPrecondDesc

(

const std::string &

precondDesc

)

[pure virtual]

Set a short preconditioner description for output clarity.

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

template<class ScalarType , class MV , class OP >

virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::resetNumCalls

(

)

[pure virtual]

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

Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.

---

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

• BelosStatusTestOutput.hpp