#include <BelosStatusTestOutput.hpp>
Inheritance diagram for Belos::StatusTestOutput< ScalarType, MV, OP >:
Public Member Functions | |
Constructors/destructors | |
| StatusTestOutput (const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod=1, int printStates=Passed) | |
| Constructor. | |
| virtual | ~StatusTestOutput () |
| 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. | |
| Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | getChild () const |
| Get child test. | |
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. | |
| void | clearStatus () |
| Clears the results of the last status test. | |
Print methods | |
| void | print (std::ostream &os, int indent=0) const |
| Output formatted description of stopping test to output stream. | |
StatusTestOutput is a wrapper around another StatusTest that calls StatusTest::print() on the underlying object on calls to StatusTestOutput::checkStatus(). The frequency and occasion of the printing can be dictated according to some parameters passed to StatusTestOutput::StatusTestOutput().
Definition at line 59 of file BelosStatusTestOutput.hpp.
| 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.
| [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 79 of file BelosStatusTestOutput.hpp.
| virtual Belos::StatusTestOutput< ScalarType, MV, OP >::~StatusTestOutput | ( | ) | [inline, virtual] |
| StatusType Belos::StatusTestOutput< ScalarType, MV, OP >::checkStatus | ( | Iteration< ScalarType, MV, OP > * | solver | ) | [inline, virtual] |
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.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 108 of file BelosStatusTestOutput.hpp.
| StatusType Belos::StatusTestOutput< ScalarType, MV, OP >::getStatus | ( | ) | const [inline, virtual] |
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 127 of file BelosStatusTestOutput.hpp.
| void Belos::StatusTestOutput< ScalarType, MV, OP >::setOutputManager | ( | const Teuchos::RCP< OutputManager< ScalarType > > & | printer | ) | [inline] |
| void Belos::StatusTestOutput< ScalarType, MV, OP >::setOutputFrequency | ( | int | mod | ) | [inline] |
| void Belos::StatusTestOutput< ScalarType, MV, OP >::setChild | ( | Teuchos::RCP< StatusTest< ScalarType, MV, OP > > | test | ) | [inline] |
Set child test.
Definition at line 148 of file BelosStatusTestOutput.hpp.
| Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::StatusTestOutput< ScalarType, MV, OP >::getChild | ( | ) | const [inline] |
| void Belos::StatusTestOutput< ScalarType, MV, OP >::reset | ( | ) | [inline, virtual] |
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 168 of file BelosStatusTestOutput.hpp.
| void Belos::StatusTestOutput< ScalarType, MV, OP >::resetNumCalls | ( | ) | [inline] |
Informs the outputting status test that it should reset the number of calls to zero.
Definition at line 175 of file BelosStatusTestOutput.hpp.
| void Belos::StatusTestOutput< ScalarType, MV, OP >::clearStatus | ( | ) | [inline] |
Clears the results of the last status test.
This resets the cached state to an Undefined state and calls clearStatus() on the underlying test.
Definition at line 179 of file BelosStatusTestOutput.hpp.
| void Belos::StatusTestOutput< ScalarType, MV, OP >::print | ( | std::ostream & | os, | |
| int | indent = 0 | |||
| ) | const [inline, virtual] |
Output formatted description of stopping test to output stream.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 190 of file BelosStatusTestOutput.hpp.
1.4.7