PyTrilinos.NOX.StatusTest.Generic Class Reference

Inheritance diagram for PyTrilinos.NOX.StatusTest.Generic:

Collaboration diagram for PyTrilinos.NOX.StatusTest.Generic:

List of all members.

Public Member Functions
def	__init__
def	checkStatus
def	getStatus
def	__str__

---

Detailed Description

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

C++ includes: NOX_StatusTest_Generic.H 

---

Member Function Documentation

def PyTrilinos.NOX.StatusTest.Generic.__str__	(		self,
			args
	)

__str__(Generic self) -> std::string

def PyTrilinos.NOX.StatusTest.Generic.checkStatus	(		self,
			args
	)

checkStatus(Generic self, NOX::Solver::Generic const & problem, NOX::StatusTest::CheckType checkType) -> NOX::StatusTest::StatusType

virtual
NOX::StatusTest::StatusType
NOX::StatusTest::Generic::checkStatus(const NOX::Solver::Generic
&problem, NOX::StatusTest::CheckType checkType)=0

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. 

Reimplemented in PyTrilinos.NOX.StatusTest.FiniteValue, PyTrilinos.NOX.StatusTest.Stagnation, PyTrilinos.NOX.StatusTest.MaxIters, PyTrilinos.NOX.StatusTest.NormWRMS, PyTrilinos.NOX.StatusTest.NormUpdate, PyTrilinos.NOX.StatusTest.NormF, and PyTrilinos.NOX.StatusTest.Combo.

def PyTrilinos.NOX.StatusTest.Generic.getStatus	(		self,
			args
	)

getStatus(Generic self) -> NOX::StatusTest::StatusType

virtual
NOX::StatusTest::StatusType NOX::StatusTest::Generic::getStatus()
const =0

Return the result of the most recent checkStatus call. 

Reimplemented in PyTrilinos.NOX.StatusTest.FiniteValue, PyTrilinos.NOX.StatusTest.Stagnation, PyTrilinos.NOX.StatusTest.MaxIters, PyTrilinos.NOX.StatusTest.NormWRMS, PyTrilinos.NOX.StatusTest.NormUpdate, PyTrilinos.NOX.StatusTest.NormF, and PyTrilinos.NOX.StatusTest.Combo.

---

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

• StatusTest.py