PyTrilinos::NOX::StatusTest::Generic Class Reference

Inheritance diagram for PyTrilinos::NOX::StatusTest::Generic:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::StatusTest::Generic:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def checkStatus
def getStatus
def __str__
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__(self) -> string

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

__str__(self) -> string

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

checkStatus(self, Generic problem, CheckType checkType) -> 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::Combo, PyTrilinos::NOX::StatusTest::NormF, PyTrilinos::NOX::StatusTest::NormUpdate, PyTrilinos::NOX::StatusTest::NormWRMS, PyTrilinos::NOX::StatusTest::MaxIters, PyTrilinos::NOX::StatusTest::Stagnation, PyTrilinos::NOX::StatusTest::FiniteValue, PyTrilinos::NOX::StatusTest::Combo, PyTrilinos::NOX::StatusTest::NormF, PyTrilinos::NOX::StatusTest::NormUpdate, PyTrilinos::NOX::StatusTest::NormWRMS, PyTrilinos::NOX::StatusTest::MaxIters, PyTrilinos::NOX::StatusTest::Stagnation, and PyTrilinos::NOX::StatusTest::FiniteValue.

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

checkStatus(self, Generic problem, CheckType checkType) -> 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::Combo, PyTrilinos::NOX::StatusTest::NormF, PyTrilinos::NOX::StatusTest::NormUpdate, PyTrilinos::NOX::StatusTest::NormWRMS, PyTrilinos::NOX::StatusTest::MaxIters, PyTrilinos::NOX::StatusTest::Stagnation, PyTrilinos::NOX::StatusTest::FiniteValue, PyTrilinos::NOX::StatusTest::Combo, PyTrilinos::NOX::StatusTest::NormF, PyTrilinos::NOX::StatusTest::NormUpdate, PyTrilinos::NOX::StatusTest::NormWRMS, PyTrilinos::NOX::StatusTest::MaxIters, PyTrilinos::NOX::StatusTest::Stagnation, and PyTrilinos::NOX::StatusTest::FiniteValue.

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

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


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

Generated on Thu Dec 17 11:00:22 2009 for PyTrilinos by  doxygen 1.5.9