PyTrilinos::NOX::StatusTest::Combo Class Reference

Inheritance diagram for PyTrilinos::NOX::StatusTest::Combo:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def addStatusTest
def checkStatus
def getStatus
def __init__
def addStatusTest
def checkStatus
def getStatus

Public Attributes

 this

Static Public Attributes

 AND = _StatusTest.Combo_AND
 OR = _StatusTest.Combo_OR


Detailed Description

Arbitrary combination of status tests.

In the AND (see NOX::StatusTest::Combo::ComboType) combination, the
result is Unconverged (see NOX::StatusTest::StatusType) if any of the
tests is Unconverged. Otherwise, the result is equal to the result of
the first test in the list that is either Converged or Failed. It is
not recommended to mix Converged and Failed tests in an AND
combination.

In the OR combination, the result is Unconverged if all of the tests
are Unconverged. Otherwise, it is the result of the first test in the
list that is either Converged or Failed. Therefore, it will generally
make sense to put the Failed -type tests at the end of the OR list.

We call checkStatus on every convergence test, though some may be
called with the NOX::StatusTest::None option.

Tammy Kolda (SNL 8950) and Roger Pawlowski (SNL 1416)

C++ includes: NOX_StatusTest_Combo.H 

Member Function Documentation

def PyTrilinos::NOX::StatusTest::Combo::__init__ (   self,
  args 
)

__init__(self, ComboType t, NOX::Utils u = None) -> Combo
__init__(self, ComboType t, Teuchos::RCP<(NOX::StatusTest::Generic)> a, 
    NOX::Utils u = None) -> Combo
__init__(self, ComboType t, Teuchos::RCP<(NOX::StatusTest::Generic)> a, 
    Teuchos::RCP<(NOX::StatusTest::Generic)> b, 
    NOX::Utils u = None) -> Combo

NOX::StatusTest::Combo::Combo(ComboType t, const Teuchos::RCP< Generic
> &a, const Teuchos::RCP< Generic > &b, const NOX::Utils *u=NULL)

Constructor with two tests. 

def PyTrilinos::NOX::StatusTest::Combo::__init__ (   self,
  args 
)

__init__(self, ComboType t, NOX::Utils u = None) -> Combo
__init__(self, ComboType t, Teuchos::RCP<(NOX::StatusTest::Generic)> a, 
    NOX::Utils u = None) -> Combo
__init__(self, ComboType t, Teuchos::RCP<(NOX::StatusTest::Generic)> a, 
    Teuchos::RCP<(NOX::StatusTest::Generic)> b, 
    NOX::Utils u = None) -> Combo

NOX::StatusTest::Combo::Combo(ComboType t, const Teuchos::RCP< Generic
> &a, const Teuchos::RCP< Generic > &b, const NOX::Utils *u=NULL)

Constructor with two tests. 

def PyTrilinos::NOX::StatusTest::Combo::addStatusTest (   self,
  args 
)

addStatusTest(self, Teuchos::RCP<(NOX::StatusTest::Generic)> a) -> Combo

NOX::StatusTest::Combo & NOX::StatusTest::Combo::addStatusTest(const
Teuchos::RCP< Generic > &a)

Add another test to this combination.

Calls isSafe() to determine if it is safe to add a to the combination.

def PyTrilinos::NOX::StatusTest::Combo::addStatusTest (   self,
  args 
)

addStatusTest(self, Teuchos::RCP<(NOX::StatusTest::Generic)> a) -> Combo

NOX::StatusTest::Combo & NOX::StatusTest::Combo::addStatusTest(const
Teuchos::RCP< Generic > &a)

Add another test to this combination.

Calls isSafe() to determine if it is safe to add a to the combination.

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

checkStatus(self, Generic problem, CheckType checkType) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::Combo::checkStatus(const
NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)

Tests stopping criterion.

See addOp() and orOp() for details. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

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

checkStatus(self, Generic problem, CheckType checkType) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::Combo::checkStatus(const
NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)

Tests stopping criterion.

See addOp() and orOp() for details. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

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

getStatus(self) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::Combo::getStatus() const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.

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

getStatus(self) -> StatusType

NOX::StatusTest::StatusType NOX::StatusTest::Combo::getStatus() const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::NOX::StatusTest::Generic.


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