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:

List of all members.

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 std::ostream &	print (std::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

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::NormWRMS, NOX::StatusTest::NormF, NOX::StatusTest::NormUpdate, NOX::StatusTest::Combo, NOX::StatusTest::Stagnation, NOX::StatusTest::NStep, NOX::StatusTest::Divergence, NOX::StatusTest::FiniteValue, LOCA::StatusTest::Wrapper, NOX::StatusTest::MaxIters, and NOX::StatusTest::RelativeNormF.

Referenced by NOX::Solver::InexactTrustRegionBased::iterateInexact(), NOX::Solver::InexactTrustRegionBased::iterateStandard(), NOX::Solver::PseudoTransient::step(), NOX::Solver::LineSearchBased::step(), NOX::Multiphysics::Solver::FixedPointBased::step(), NOX::Solver::TrustRegionBased::step(), and NOX::Solver::TensorBased::step().

---

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

• NOX_StatusTest_Generic.H