#include <NOX_StatusTest_MaxIters.H>
Inheritance diagram for NOX::StatusTest::MaxIters:
Public Member Functions | |
MaxIters (int maxIterations, const NOX::Utils *u=NULL) | |
Constructor. Specify the maximum number of nonlinear solver iterations, ands optinally an error stream for printing errors. | |
virtual | ~MaxIters () |
Destructor. | |
virtual NOX::StatusTest::StatusType | checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType) |
Test the stopping criterion | |
virtual NOX::StatusTest::StatusType | getStatus () const |
Return the result of the most recent checkStatus call. | |
virtual ostream & | print (ostream &stream, int indent=0) const |
Output formatted description of stopping test to output stream. | |
virtual int | getMaxIters () const |
Returns the Maximum number of iterations set in the constructor. | |
virtual int | getNumIters () const |
Returns the current number of iterations taken by the solver. |
Let denote the current number of iterations (accessed via NOX::Solver::getNumIterations) and denote the tolerance set in the constructor of this status test. This test returns NOX::StatusTest::Failed if Otherwise, it returns NOX::StatusTest::Unconverged.
NOX::StatusTest::StatusType NOX::StatusTest::MaxIters::checkStatus | ( | const NOX::Solver::Generic & | problem, | |
NOX::StatusTest::CheckType | checkType | |||
) | [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.
Implements NOX::StatusTest::Generic.
int NOX::StatusTest::MaxIters::getNumIters | ( | ) | const [virtual] |
Returns the current number of iterations taken by the solver.
Returns -1 if the status of this test is NOX::StatusTest::Unevaluated.