NOX::StatusTest::Generic Class Reference

Generic status test to check for convergence or failure of the nonlinear solver. More...

#include <NOX_StatusTest_Generic.H>

Inheritance diagram for NOX::StatusTest::Generic:

[legend]
List of all members.

Public Member Functions

 Generic ()
 Constructor.
virtual ~Generic ()
 Destructor.
virtual NOX::StatusTest::StatusType checkStatus (const NOX::Solver::Generic &problem)=0
 Test the stopping criterion
virtual NOX::StatusTest::StatusType checkStatusEfficiently (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)
 Test the stopping criterion efficiently
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.


Member Function Documentation

NOX::StatusTest::StatusType NOX::StatusTest::Generic::checkStatusEfficiently const NOX::Solver::Generic problem,
NOX::StatusTest::CheckType  checkType
[virtual]
 

Test the stopping criterion efficiently

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.

Reimplemented in NOX::StatusTest::Combo, NOX::StatusTest::FiniteValue, NOX::StatusTest::MaxIters, NOX::StatusTest::NormF, NOX::StatusTest::NormUpdate, and LOCA::StatusTest::Wrapper.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:40:52 2008 for NOX by doxygen 1.3.9.1