Belos
Version of the Day
|
An abstract class of StatusTest for stopping criteria using residual norms. More...
#include <BelosStatusTestResNorm.hpp>
Public Types | |
typedef Teuchos::ScalarTraits < ScalarType > | SCT |
typedef SCT::magnitudeType | MagnitudeType |
typedef MultiVecTraits < ScalarType, MV > | MVT |
Public Member Functions | |
Form and parameter definition methods. | |
virtual int | setTolerance (MagnitudeType tolerance)=0 |
Set the value of the tolerance. More... | |
virtual int | setQuorum (int quorum)=0 |
Sets the number of residuals that must pass the convergence test before Passed is returned. More... | |
virtual int | setShowMaxResNormOnly (bool showMaxResNormOnly)=0 |
Set whether the only maximum residual norm is displayed when the print() method is called. More... | |
virtual int | defineScaleForm (ScaleType TypeOfScaling, NormType TypeOfNorm, MagnitudeType ScaleValue=Teuchos::ScalarTraits< MagnitudeType >::one())=0 |
Define the form of the scaling for the residual. More... | |
Methods to access data members. | |
virtual int | getQuorum () const =0 |
Returns the number of residuals that must pass the convergence test before Passed is returned. More... | |
virtual bool | getShowMaxResNormOnly ()=0 |
Returns whether the only maximum residual norm is displayed when the print() method is called. More... | |
virtual std::vector< int > | convIndices ()=0 |
Returns the std::vector containing the indices of the residuals that passed the test. More... | |
virtual MagnitudeType | getTolerance () const =0 |
Returns the value of the tolerance, , set in the constructor. More... | |
virtual const std::vector < MagnitudeType > * | getTestValue () const =0 |
Returns the test value, , computed in most recent call to CheckStatus. More... | |
virtual Teuchos::RCP< MV > | getSolution ()=0 |
Returns the current solution estimate that was computed for the most recent residual test. More... | |
virtual bool | getLOADetected () const =0 |
Returns a boolean indicating a loss of accuracy has been detected in computing the residual. 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 |
An abstract class of StatusTest for stopping criteria using residual norms.
Definition at line 62 of file BelosStatusTestResNorm.hpp.
typedef Teuchos::ScalarTraits<ScalarType> Belos::StatusTestResNorm< ScalarType, MV, OP >::SCT |
Definition at line 67 of file BelosStatusTestResNorm.hpp.
typedef SCT::magnitudeType Belos::StatusTestResNorm< ScalarType, MV, OP >::MagnitudeType |
Definition at line 68 of file BelosStatusTestResNorm.hpp.
typedef MultiVecTraits<ScalarType,MV> Belos::StatusTestResNorm< ScalarType, MV, OP >::MVT |
Definition at line 69 of file BelosStatusTestResNorm.hpp.
|
pure virtual |
Set the value of the tolerance.
We allow the tolerance to be reset for cases where, in the process of testing the residual, we find that the initial tolerance was too tight or too lax.
Implemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Sets the number of residuals that must pass the convergence test before Passed is returned.
quorum=-1
then all residuals must pass the convergence test before Passed is returned. Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Set whether the only maximum residual norm is displayed when the print() method is called.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Define the form of the scaling for the residual.
Implemented in Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns the number of residuals that must pass the convergence test before Passed is returned.
quorum=-1
then all residuals must pass the convergence test before Passed is returned. Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns whether the only maximum residual norm is displayed when the print() method is called.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns the std::vector containing the indices of the residuals that passed the test.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns the value of the tolerance, , set in the constructor.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns the test value, , computed in most recent call to CheckStatus.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns the current solution estimate that was computed for the most recent residual test.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.
|
pure virtual |
Returns a boolean indicating a loss of accuracy has been detected in computing the residual.
Implemented in Belos::StatusTestImpResNorm< ScalarType, MV, OP >, and Belos::StatusTestGenResNorm< ScalarType, MV, OP >.