Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Belos::StatusTestGeneralOutput< ScalarType, MV, OP > Class Template Reference

A special StatusTest for printing other status tests. More...

#include <BelosStatusTestGeneralOutput.hpp>

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

Public Member Functions

Constructors/destructors
 StatusTestGeneralOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
 Constructor. More...
 
virtual ~StatusTestGeneralOutput ()
 Destructor. More...
 
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. More...
 
Accessor methods
void setOutputManager (const Teuchos::RCP< OutputManager< ScalarType > > &printer)
 Set the output manager. More...
 
void setOutputFrequency (int mod)
 Set how often the child test is printed. More...
 
void setChild (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)
 Set child test. More...
 
Teuchos::RCP< StatusTest
< ScalarType, MV, OP > > 
getChild () const
 Get child test. More...
 
void setSolverDesc (const std::string &solverDesc)
 Set a short solver description for output clarity. More...
 
void setPrecondDesc (const std::string &precondDesc)
 Set a short preconditioner description for output clarity. More...
 
Reset methods
void reset ()
 Informs the status test that it should reset its internal configuration to the uninitialized state. More...
 
void resetNumCalls ()
 Informs the outputting status test that it should reset the number of calls to zero. More...
 
Print methods
void print (std::ostream &os, int indent=0) const
 Output formatted description of stopping test to output stream. More...
 
- Public Member Functions inherited from Belos::StatusTestOutput< ScalarType, MV, OP >
 StatusTestOutput ()
 Default constructor. More...
 
 StatusTestOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed)
 Constructor. More...
 
virtual ~StatusTestOutput ()
 Destructor. More...
 
- Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
 StatusTest ()
 Constructor. More...
 
virtual ~StatusTest ()
 Destructor. More...
 
virtual void printStatus (std::ostream &os, StatusType type) const
 Output the result of the most recent CheckStatus call. More...
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
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
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Additional Inherited Members

- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

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

A special StatusTest for printing other status tests.

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

Definition at line 40 of file BelosStatusTestGeneralOutput.hpp.

Constructor & Destructor Documentation

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

Constructor.

The StatusTestGeneralOutput 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]modA 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]printStatesA combination of StatusType values for which the output may be printed. Default: Passed (attempt to print whenever checkStatus() will return Passed)

Definition at line 60 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::~StatusTestGeneralOutput ( )
inlinevirtual

Destructor.

Definition at line 73 of file BelosStatusTestGeneralOutput.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >
StatusType Belos::StatusTestGeneralOutput< 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 95 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
StatusType Belos::StatusTestGeneralOutput< 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 114 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::setOutputManager ( const Teuchos::RCP< OutputManager< ScalarType > > &  printer)
inlinevirtual

Set the output manager.

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

Definition at line 125 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::setOutputFrequency ( int  mod)
inlinevirtual

Set how often the child test is printed.

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

Definition at line 129 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::setChild ( Teuchos::RCP< StatusTest< ScalarType, MV, OP > >  test)
inlinevirtual

Set child test.

Note
This also resets the test status to Undefined.

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

Definition at line 135 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::getChild ( ) const
inlinevirtual

Get child test.

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

Definition at line 141 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< 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 147 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< 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 151 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< 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 163 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::resetNumCalls ( )
inlinevirtual

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

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

Definition at line 170 of file BelosStatusTestGeneralOutput.hpp.

template<class ScalarType , class MV , class OP >
void Belos::StatusTestGeneralOutput< ScalarType, MV, OP >::print ( std::ostream &  os,
int  indent = 0 
) const
inlinevirtual

Output formatted description of stopping test to output stream.

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

Definition at line 178 of file BelosStatusTestGeneralOutput.hpp.


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

Generated on Mon Jul 15 2024 09:24:25 for Belos by doxygen 1.8.5