NOX  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
NOX::StatusTest::MaxIters Class Reference

Failure test based on the maximum number of nonlinear solver iterations. More...

#include <NOX_StatusTest_MaxIters.H>

Inheritance diagram for NOX::StatusTest::MaxIters:
Inheritance graph
Collaboration diagram for NOX::StatusTest::MaxIters:
Collaboration graph

Public Member Functions

 MaxIters (int maxIterations, const NOX::Utils *u=NULL)
 Constructor. Specify the maximum number of nonlinear solver iterations, $ k_{\max}$ ands optinally an error stream for printing errors.
virtual ~MaxIters ()
virtual NOX::StatusTest::StatusType checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)
 Test the stopping criterion More...
virtual NOX::StatusTest::StatusType getStatus () const
 Return the result of the most recent checkStatus call.
virtual std::ostream & print (std::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. More...
- Public Member Functions inherited from NOX::StatusTest::Generic
 Generic ()
virtual ~Generic ()

Detailed Description

Failure test based on the maximum number of nonlinear solver iterations.

Let $ k$ denote the current number of iterations (accessed via NOX::Solver::getNumIterations) and $ k_{\max}$ denote the tolerance set in the constructor of this status test. This test returns NOX::StatusTest::Failed if $ k \geq k_{\rm max}. $ Otherwise, it returns NOX::StatusTest::Unconverged.

If checkStatus is called with the type set to NOX::StatusTest::None, it then the status is set to to NOX::Status::Unevaluated and returned. (Also #niters is set to -1.)

Member Function Documentation

NOX::StatusTest::StatusType NOX::StatusTest::MaxIters::checkStatus ( const NOX::Solver::Generic problem,
NOX::StatusTest::CheckType  checkType 

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.

References NOX::StatusTest::Complete, NOX::StatusTest::Failed, NOX::Solver::Generic::getNumIterations(), NOX::StatusTest::Minimal, NOX::StatusTest::None, NOX::StatusTest::Unconverged, and NOX::StatusTest::Unevaluated.

int NOX::StatusTest::MaxIters::getNumIters ( ) const

Returns the current number of iterations taken by the solver.

Returns -1 if the status of this test is NOX::StatusTest::Unevaluated.

The documentation for this class was generated from the following files: