Public Member Functions | |
def | __init__ |
def | checkStatus |
def | getStatus |
def | getMaxNumSteps |
def | getCurrentNumSteps |
def | getTolerance |
def | getConvRate |
def | __init__ |
def | checkStatus |
def | getStatus |
def | getMaxNumSteps |
def | getCurrentNumSteps |
def | getTolerance |
def | getConvRate |
Public Attributes | |
this |
Failure test based on the convergence rate between nonlinear iterations. This status test returns NOX::StatusTest::Failed if we fail to reduce the norm of $F$ by a specified tolerance for n consecutive iterations. In other words, if \\[ \\frac{\\| F_k \\|}{\\| F_{k-1} \\|} \\geq {\\rm tolerance}\\] for n consecutive iterations, the status is set to NOX::StatusTest::Failed and returned. Otherwise, the status is set to NOX::StatusTest::Uncoverged and returned. Both n and the tolerance are specified in the constructor, by n and tol, respectively. Based on experience the following values are recommended: For Newton solves: n = 50, tolerance = 1.0 For Newton solves with a line search: n = 15, tolerance = 0.99 C++ includes: NOX_StatusTest_Stagnation.H
def PyTrilinos::NOX::StatusTest::Stagnation::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, int n = 50, double tol = 1.0) -> Stagnation NOX::StatusTest::Stagnation::Stagnation(int n=50, double tol=1.0) Constructor. Parameters: ----------- n: - Number of consecutive nonlinear iterations tol: - Tolerance for stagnation test
def PyTrilinos::NOX::StatusTest::Stagnation::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, int n = 50, double tol = 1.0) -> Stagnation NOX::StatusTest::Stagnation::Stagnation(int n=50, double tol=1.0) Constructor. Parameters: ----------- n: - Number of consecutive nonlinear iterations tol: - Tolerance for stagnation test
def PyTrilinos::NOX::StatusTest::Stagnation::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, Generic problem, CheckType checkType) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::Stagnation::checkStatus(const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType) Tests the stopping criterion. The nature of this test is such that it must be executed at every nonlinear iteration, so we don't use the checkType argument.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::Stagnation::checkStatus | ( | self, | ||
args | ||||
) |
checkStatus(self, Generic problem, CheckType checkType) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::Stagnation::checkStatus(const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType) Tests the stopping criterion. The nature of this test is such that it must be executed at every nonlinear iteration, so we don't use the checkType argument.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::Stagnation::getConvRate | ( | self, | ||
args | ||||
) |
getConvRate(self) -> double double NOX::StatusTest::Stagnation::getConvRate() const Returns the current convergence rate.
def PyTrilinos::NOX::StatusTest::Stagnation::getConvRate | ( | self, | ||
args | ||||
) |
getConvRate(self) -> double double NOX::StatusTest::Stagnation::getConvRate() const Returns the current convergence rate.
def PyTrilinos::NOX::StatusTest::Stagnation::getCurrentNumSteps | ( | self, | ||
args | ||||
) |
getCurrentNumSteps(self) -> int int NOX::StatusTest::Stagnation::getCurrentNumSteps() const Returns the current number of steps that have consecutively failed the tolerance test.
def PyTrilinos::NOX::StatusTest::Stagnation::getCurrentNumSteps | ( | self, | ||
args | ||||
) |
getCurrentNumSteps(self) -> int int NOX::StatusTest::Stagnation::getCurrentNumSteps() const Returns the current number of steps that have consecutively failed the tolerance test.
def PyTrilinos::NOX::StatusTest::Stagnation::getMaxNumSteps | ( | self, | ||
args | ||||
) |
getMaxNumSteps(self) -> int int NOX::StatusTest::Stagnation::getMaxNumSteps() const Returns the used specified number of steps that can consecutively fail the tolerance test before the test returns a failed status.
def PyTrilinos::NOX::StatusTest::Stagnation::getMaxNumSteps | ( | self, | ||
args | ||||
) |
getMaxNumSteps(self) -> int int NOX::StatusTest::Stagnation::getMaxNumSteps() const Returns the used specified number of steps that can consecutively fail the tolerance test before the test returns a failed status.
def PyTrilinos::NOX::StatusTest::Stagnation::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::Stagnation::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::Stagnation::getStatus | ( | self, | ||
args | ||||
) |
getStatus(self) -> StatusType NOX::StatusTest::StatusType NOX::StatusTest::Stagnation::getStatus() const Return the result of the most recent checkStatus call.
Reimplemented from PyTrilinos::NOX::StatusTest::Generic.
def PyTrilinos::NOX::StatusTest::Stagnation::getTolerance | ( | self, | ||
args | ||||
) |
getTolerance(self) -> double double NOX::StatusTest::Stagnation::getTolerance() const Returns the user specified tolerance.
def PyTrilinos::NOX::StatusTest::Stagnation::getTolerance | ( | self, | ||
args | ||||
) |
getTolerance(self) -> double double NOX::StatusTest::Stagnation::getTolerance() const Returns the user specified tolerance.