|
Belos Package Browser (Single Doxygen Collection)
Development
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Belos Package Browser (Single Doxygen Collection)
Development
|
A virtual base class for StatusTest that print other status tests. More...
#include <BelosStatusTestOutput.hpp>
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... | |
Additional Inherited Members | |
 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 | |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
| 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 |
| Static Public Attributes inherited from Teuchos::Describable | |
| static const EVerbosityLevel | verbLevel_default |
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.
|
inline |
Default constructor.
Definition at line 47 of file BelosStatusTestOutput.hpp.
|
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.
| [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 63 of file BelosStatusTestOutput.hpp.
|
inlinevirtual |
Destructor.
Definition at line 70 of file BelosStatusTestOutput.hpp.
|
pure virtual |
Set the output manager.
Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, Belos::StatusTestUserOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
pure virtual |
Set how often the child test is printed.
Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, Belos::StatusTestUserOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
pure virtual |
Set child test.
Implemented in Belos::StatusTestResNormOutput< ScalarType, MV, OP >, Belos::StatusTestUserOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
pure virtual |
Get child test.
Implemented in Belos::StatusTestUserOutput< ScalarType, MV, OP >, Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
pure virtual |
Set a short solver description for output clarity.
Implemented in Belos::StatusTestUserOutput< ScalarType, MV, OP >, Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
pure virtual |
Set a short preconditioner description for output clarity.
Implemented in Belos::StatusTestUserOutput< ScalarType, MV, OP >, Belos::StatusTestResNormOutput< ScalarType, MV, OP >, and Belos::StatusTestGeneralOutput< ScalarType, MV, OP >.
|
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 >.
1.8.5