Belos
Version of the Day
|
A Belos::StatusTest debugging class for storing the absolute residual norms generated during a solve. More...
#include <BelosStatusTestLogResNorm.hpp>
Public Types | |
typedef Teuchos::ScalarTraits < ScalarType >::magnitudeType | MagnitudeType |
The type of the magnitude (absolute value) of a ScalarType. More... | |
Public Member Functions | |
Constructor/Destructor. | |
StatusTestLogResNorm (int maxIters) | |
Constructor. More... | |
virtual | ~StatusTestLogResNorm () |
Destructor. More... | |
Status methods | |
StatusType | checkStatus (Iteration< ScalarType, MV, OP > *iSolver) |
Check convergence status of the iterative solver: Unconverged, Converged, Failed. More... | |
StatusType | getStatus () const |
Return the result of the most recent CheckStatus call. More... | |
Reset methods | |
void | reset () |
Resets the status test to the initial internal state. More... | |
void | setMaxIters (int maxIters) |
Sets the maximum number of iterations allowed so internal storage can be resized. More... | |
Accessor methods | |
int | getMaxIters () const |
Returns the maximum number of iterations set in the constructor. More... | |
int | getNumIters () const |
Returns the current number of iterations from the most recent StatusTest call. More... | |
const std::vector< typename Teuchos::ScalarTraits < ScalarType >::magnitudeType > & | getLogResNorm () const |
Returns the log of the absolute residual norm from the iteration. More... | |
Print methods | |
void | print (std::ostream &os, int indent=0) const |
Output formatted description of stopping test to output stream. More... | |
void | printStatus (std::ostream &os, StatusType type) const |
Print message for each status specific to this stopping test. More... | |
Overridden from Teuchos::Describable | |
std::string | description () const |
Method to return description of the debugging status test. More... | |
Public Member Functions inherited from Belos::StatusTest< ScalarType, MV, OP > | |
StatusTest () | |
Constructor. More... | |
virtual | ~StatusTest () |
Destructor. More... | |
Public Member Functions inherited from Teuchos::Describable | |
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 |
A Belos::StatusTest debugging class for storing the absolute residual norms generated during a solve.
This implementation of the Belos::StatusTest base class stores the absolute residual norm provided by the iteration throughout an entire solve.
Definition at line 67 of file BelosStatusTestLogResNorm.hpp.
typedef Teuchos::ScalarTraits<ScalarType>::magnitudeType Belos::StatusTestLogResNorm< ScalarType, MV, OP >::MagnitudeType |
The type of the magnitude (absolute value) of a ScalarType.
Definition at line 71 of file BelosStatusTestLogResNorm.hpp.
Belos::StatusTestLogResNorm< ScalarType, MV, OP >::StatusTestLogResNorm | ( | int | maxIters | ) |
Constructor.
Definition at line 172 of file BelosStatusTestLogResNorm.hpp.
|
inlinevirtual |
Destructor.
Definition at line 88 of file BelosStatusTestLogResNorm.hpp.
|
virtual |
Check convergence status of the iterative solver: Unconverged, Converged, Failed.
This method checks to see if the convergence criteria are met using the current information from the iterative solver.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 185 of file BelosStatusTestLogResNorm.hpp.
|
inlinevirtual |
Return the result of the most recent CheckStatus call.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 101 of file BelosStatusTestLogResNorm.hpp.
|
virtual |
Resets the status test to the initial internal state.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 212 of file BelosStatusTestLogResNorm.hpp.
|
inline |
Sets the maximum number of iterations allowed so internal storage can be resized.
Definition at line 112 of file BelosStatusTestLogResNorm.hpp.
|
inline |
Returns the maximum number of iterations set in the constructor.
Definition at line 120 of file BelosStatusTestLogResNorm.hpp.
|
inline |
Returns the current number of iterations from the most recent StatusTest call.
Definition at line 123 of file BelosStatusTestLogResNorm.hpp.
|
inline |
Returns the log of the absolute residual norm from the iteration.
Definition at line 127 of file BelosStatusTestLogResNorm.hpp.
|
virtual |
Output formatted description of stopping test to output stream.
Implements Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 220 of file BelosStatusTestLogResNorm.hpp.
|
virtual |
Print message for each status specific to this stopping test.
Reimplemented from Belos::StatusTest< ScalarType, MV, OP >.
Definition at line 229 of file BelosStatusTestLogResNorm.hpp.
|
inlinevirtual |
Method to return description of the debugging status test.
Reimplemented from Teuchos::Describable.
Definition at line 146 of file BelosStatusTestLogResNorm.hpp.