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

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

#include <BelosStatusTestOutput.hpp>

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

Public Member Functions

Constructors/destructors
 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...
 
Accessor methods
virtual void setOutputManager (const Teuchos::RCP< OutputManager< ScalarType > > &printer)=0
 Set the output manager. More...
 
virtual void setOutputFrequency (int mod)=0
 Set how often the child test is printed. More...
 
virtual void setChild (Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test)=0
 Set child test. More...
 
virtual Teuchos::RCP
< StatusTest< ScalarType, MV,
OP > > 
getChild () const =0
 Get child test. More...
 
virtual void setSolverDesc (const std::string &solverDesc)=0
 Set a short solver description for output clarity. More...
 
virtual void setPrecondDesc (const std::string &precondDesc)=0
 Set a short preconditioner description for output clarity. More...
 
Reset methods
virtual void resetNumCalls ()=0
 Informs the outputting status test that it should reset the number of calls to zero. More...
 
- Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP >
 StatusTest ()
 Constructor. More...
 
virtual ~StatusTest ()
 Destructor. More...
 
virtual StatusType checkStatus (Iteration< ScalarType, MV, OP > *iSolver)=0
 Check convergence status: Unconverged, Converged, Failed. More...
 
virtual StatusType getStatus () const =0
 Return the result of the most recent CheckStatus call. More...
 
virtual void reset ()=0
 Informs the convergence test that it should reset its internal configuration to the initialized state. More...
 
virtual void print (std::ostream &os, int indent=0) const =0
 Output formatted description of stopping test to output stream. 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::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 40 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 47 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]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 63 of file BelosStatusTestOutput.hpp.

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

Destructor.

Definition at line 70 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
template<class ScalarType , class MV , class OP >
virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setOutputFrequency ( int  mod)
pure virtual
template<class ScalarType , class MV , class OP >
virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setChild ( Teuchos::RCP< StatusTest< ScalarType, MV, OP > >  test)
pure virtual
template<class ScalarType , class MV , class OP >
virtual Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::StatusTestOutput< ScalarType, MV, OP >::getChild ( ) const
pure virtual
template<class ScalarType , class MV , class OP >
virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setSolverDesc ( const std::string &  solverDesc)
pure virtual
template<class ScalarType , class MV , class OP >
virtual void Belos::StatusTestOutput< ScalarType, MV, OP >::setPrecondDesc ( const std::string &  precondDesc)
pure virtual
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::StatusTestUserOutput< ScalarType, MV, OP >, Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.


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

Generated on Tue Jul 23 2024 09:24:23 for Belos by doxygen 1.8.5