Status checkers. More...

Classes
class	Combo
	Arbitrary combination of status tests. More...

class	Divergence
	Failure test based on a threshold value of the norm of F. More...

class	Factory
	Factory to build a set of status tests from a parameter list. More...

class	FiniteValue
	Failure test based on whether the norm of a vector has a finite value. More...

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

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

class	NormF
	Various convergence tests based on the norm of the residual. More...

class	NormUpdate
	Various convergence tests based on the norm of the change in the solution vector, , between outer iterations. More...

class	NormWRMS
	Convergence test based on the weighted root mean square norm fo the solution update between iterations. More...

class	NStep
	Takes n Iterations before declaring convergence. More...

class	RelativeNormF
	Requires reduction in residual norm compared to initial norm. More...

class	Stagnation
	Failure test based on the convergence rate between nonlinear iterations. More...

Enumerations
enum	StatusType { Unevaluated = -2 , Unconverged = 0 , Converged = 1 , Failed = -1 }
	Status type. More...

enum	CheckType { Complete , Minimal , None }
	Type of check that should be done by checkStatus. More...

Functions
std::ostream &	operator<< (std::ostream &os, NOX::StatusTest::StatusType type)

Teuchos::RCP< NOX::StatusTest::Generic >	buildStatusTests (const std::string &file_name, const NOX::Utils &utils, std::map< std::string, Teuchos::RCP< NOX::StatusTest::Generic > > *tagged_tests=nullptr)
	Nonmember helper function for the NOX::StatusTest::Factory.

Teuchos::RCP< NOX::StatusTest::Generic >	buildStatusTests (Teuchos::ParameterList &p, const NOX::Utils &utils, std::map< std::string, Teuchos::RCP< NOX::StatusTest::Generic > > *tagged_tests=nullptr)
	Nonmember helper function for the NOX::StatusTest::Factory.

Teuchos::RCP< LOCA::StatusTest::Abstract >	buildStatusTests (const std::string &file_name, const Teuchos::RCP< const LOCA::GlobalData > &globalData, std::map< std::string, Teuchos::RCP< LOCA::StatusTest::Abstract > > *tagged_tests=0)
	Nonmember helper function for the NOX::StatusTest::Factory.

Teuchos::RCP< LOCA::StatusTest::Abstract >	buildStatusTests (Teuchos::ParameterList &p, const Teuchos::RCP< const LOCA::GlobalData > &globalData, std::map< std::string, Teuchos::RCP< LOCA::StatusTest::Abstract > > *tagged_tests=0)
	Nonmember helper function for the NOX::StatusTest::Factory.

Detailed Description

Status checkers.

Enumeration Type Documentation

Type of check that should be done by checkStatus.

Enumerator
Complete	Evaluate every test and subtest.
Minimal	Evaluate all tests and subtests that are necessary to determine the status.
None	Evaluation is entirely optional.

Status type.

Enumerator
Unevaluated	Unevaluated.
Unconverged	Neither Converged nor Failed.
Converged	Converged.
Failed	Failed.