Public Member Functions | |
def | __init__ |
def | checkStatus |
def | getStatus |
def | finiteNumberTest |
def | __init__ |
def | checkStatus |
def | getStatus |
def | finiteNumberTest |
Public Attributes | |
this | |
Static Public Attributes | |
FVector = _StatusTest.FiniteValue_FVector | |
SolutionVector = _StatusTest.FiniteValue_SolutionVector |
Failure test based on whether the norm of a vector has a finite value. This test returns NOX::StatusTest::Failed if the norm of a vector is calssified as a NaN or Inf. Otherwise, it returns NOX::StatusTest::Unconverged. The user can specify whether to use the F vector or the solution vector from the current solution group for the check. NOX does not have access to vector entries so the number used in the NaN/Inf check is based on the norm of a vector. If checkStatus is called with the type set to NOX::StatusTest::None, then the status is set to NOX::Status::Unevaluated and returned. C++ includes: NOX_StatusTest_FiniteValue.H
def PyTrilinos::NOX::StatusTest::FiniteValue::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, VectorType v = FVector, NOX::Abstract::Vector::NormType n = NOX::Abstract::Vector::TwoNorm) -> FiniteValue NOX::StatusTest::FiniteValue::FiniteValue(VectorType v=FVector, NOX::Abstract::Vector::NormType n=NOX::Abstract::Vector::TwoNorm) Constructor. Specify which vector to check and with what norm to use.
def PyTrilinos::NOX::StatusTest::FiniteValue::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, VectorType v = FVector, NOX::Abstract::Vector::NormType n = NOX::Abstract::Vector::TwoNorm) -> FiniteValue NOX::StatusTest::FiniteValue::FiniteValue(VectorType v=FVector, NOX::Abstract::Vector::NormType n=NOX::Abstract::Vector::TwoNorm) Constructor. Specify which vector to check and with what norm to use.
def PyTrilinos::NOX::StatusTest::FiniteValue::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, Generic problem, CheckType checkType) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::FiniteValue::checkStatus(const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType) 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 from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::FiniteValue::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, Generic problem, CheckType checkType) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::FiniteValue::checkStatus(const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType) 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 from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::FiniteValue::finiteNumberTest | ( | self, | ||
args | ||||
) |
finiteNumberTest(self, double x) -> int int NOX::StatusTest::FiniteValue::finiteNumberTest(double x) const The finite number test algorithm. Autoconf will test to see if the compiler implements the isnan() and isinf() functions in the cmath or math.h headers. If so, we will use these. If not, we supply a default implementation. The default implementation is only guaranteed to work if the code is IEEE 748/754 compliant. The checks for isnan and isinf are separate because compilers like the old sgi platforms support one but not the other. See bug 2019 for more details. This method is public so that other objects (solvers, line searches, and directions) can use this test on their own values. Return Values: 0 = Finite Number -1 = NaN -2 = Inf
def PyTrilinos::NOX::StatusTest::FiniteValue::finiteNumberTest | ( | self, | ||
args | ||||
) |
finiteNumberTest(self, double x) -> int int NOX::StatusTest::FiniteValue::finiteNumberTest(double x) const The finite number test algorithm. Autoconf will test to see if the compiler implements the isnan() and isinf() functions in the cmath or math.h headers. If so, we will use these. If not, we supply a default implementation. The default implementation is only guaranteed to work if the code is IEEE 748/754 compliant. The checks for isnan and isinf are separate because compilers like the old sgi platforms support one but not the other. See bug 2019 for more details. This method is public so that other objects (solvers, line searches, and directions) can use this test on their own values. Return Values: 0 = Finite Number -1 = NaN -2 = Inf
def PyTrilinos::NOX::StatusTest::FiniteValue::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::FiniteValue::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::FiniteValue::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::FiniteValue::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.