NOX::StatusTest::Generic Class Reference
Generic status test to check for convergence or failure of the nonlinear solver. More...
#include <NOX_StatusTest_Generic.H>
Public Member Functions | |
| Generic () | |
| Constructor. | |
| virtual | ~Generic () |
| Destructor. | |
| virtual NOX::StatusTest::StatusType | checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)=0 |
| Test the stopping criterion | |
| virtual NOX::StatusTest::StatusType | getStatus () const =0 |
| Return the result of the most recent checkStatus call. | |
| virtual ostream & | print (ostream &stream, int indent=0) const =0 |
| Output formatted description of stopping test to output stream. | |
Detailed Description
Generic status test to check for convergence or failure of the nonlinear solver.Definition at line 87 of file NOX_StatusTest_Generic.H.
Constructor & Destructor Documentation
| NOX::StatusTest::Generic::Generic | ( | ) | [inline] |
| virtual NOX::StatusTest::Generic::~Generic | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual NOX::StatusTest::StatusType NOX::StatusTest::Generic::checkStatus | ( | const NOX::Solver::Generic & | problem, | |
| NOX::StatusTest::CheckType | checkType | |||
| ) | [pure virtual] |
Test the stopping criterion
The test can (and should, if possible) be skipped if checkType is NOX::StatusType::None. If the test is skipped, then the status should be set to NOX::StatusTest::Unevaluated.
Implemented in NOX::StatusTest::Combo, NOX::StatusTest::Divergence, NOX::StatusTest::FiniteValue, NOX::StatusTest::MaxIters, NOX::StatusTest::NormF, NOX::StatusTest::NormUpdate, NOX::StatusTest::NormWRMS, NOX::StatusTest::Stagnation, and LOCA::StatusTest::Wrapper.
Referenced by NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Solver::InexactTrustRegionBased::iterateStandard(), NOX::Solver::TrustRegionBased::step(), NOX::Solver::TensorBased::step(), NOX::Solver::LineSearchBased::step(), and NOX::Multiphysics::Solver::FixedPointBased::step().
| virtual NOX::StatusTest::StatusType NOX::StatusTest::Generic::getStatus | ( | ) | const [pure virtual] |
Return the result of the most recent checkStatus call.
Implemented in NOX::StatusTest::Combo, NOX::StatusTest::Divergence, NOX::StatusTest::FiniteValue, NOX::StatusTest::MaxIters, NOX::StatusTest::NormF, NOX::StatusTest::NormUpdate, NOX::StatusTest::NormWRMS, NOX::StatusTest::Stagnation, and LOCA::StatusTest::Wrapper.
| virtual ostream& NOX::StatusTest::Generic::print | ( | ostream & | stream, | |
| int | indent = 0 | |||
| ) | const [pure virtual] |
Output formatted description of stopping test to output stream.
Implemented in NOX::StatusTest::Combo, NOX::StatusTest::Divergence, NOX::StatusTest::FiniteValue, NOX::StatusTest::MaxIters, NOX::StatusTest::NormF, NOX::StatusTest::NormUpdate, NOX::StatusTest::NormWRMS, NOX::StatusTest::Stagnation, and LOCA::StatusTest::Wrapper.
The documentation for this class was generated from the following file:
