NOX Development
Public Member Functions | Protected Attributes
LOCA::Bifurcation::TPBord::StatusTest::ParameterUpdateNorm Class Reference

A convergence test based on the update of the parameter component for turning point location. More...

#include <LOCA_Bifurcation_TPBord_StatusTest_ParameterUpdateNorm.H>

Inheritance diagram for LOCA::Bifurcation::TPBord::StatusTest::ParameterUpdateNorm:
Inheritance graph
Collaboration diagram for LOCA::Bifurcation::TPBord::StatusTest::ParameterUpdateNorm:
Collaboration graph

List of all members.

Public Member Functions

 ParameterUpdateNorm (double rtol, double atol, double tol)
virtual ~ParameterUpdateNorm ()
virtual NOX::StatusTest::StatusType checkStatus (const NOX::Solver::Generic &problem)
 Evaluates convergence criteria specified above.
virtual NOX::StatusTest::StatusType getStatus () const
 Returns status as defined above.
virtual std::ostream & print (ostream &stream, int indent=0) const
 Prints current status.
double getUpdateNorm () const
 Returns the value of weighted parameter update norm.
double getRTOL () const
 Returns the realative tolerance set in the constructor.
double getATOL () const
 Returns the absolute tolerance set in the constructor.
double getTOL () const
 Returns the tolerance set in the constructor.

Protected Attributes

double rtol
 Relative tolerance for convergence.
double atol
 Absolute tolerance for convergence.
double tol
 Tolerance for convergence.
double paramUpdateNorm
 Current value of the parameter update norm.
NOX::StatusTest::StatusType status
 Status of entire status test.

Detailed Description

A convergence test based on the update of the parameter component for turning point location.

Let $p$ be the turning point parameter (see LOCA::Bifurcation::TPBord::ExtendedGroup). This convergence test defines convergence for the parameter when the following is true

\[ \frac{|p-p_0|}{\epsilon_r|p| + \epsilon_a} < \tau \]

where $p_0$ is the previous parameter value, $\epsilon_r$ is the relative tolerance, $\epsilon_a$ is the absolute tolerance, and $\tau$ is an overall scale factor (typically $\tau = 1$).

Note that this status test deals only with the parameter component of the turning point equations. This status test should be combined with other status tests for the solution and null vector components (using NOX::StatusTest::Combo and LOCA::StatusTest::Wrapper) to build a composite status test for the entire system.

Also note that if the group returned by the getSolutionGroup() method of the solver supplied in checkStatus() is not a turning point group (i.e., not derived from LOCA::Bifurcation::TPBord::ExtendedGroup), checkStatus() returns NOX::StatusTest::Converged. This allows the status test to be used in situations other than turning point tracking, e.g., steady-state solves, without raising error conditions.

Constructor & Destructor Documentation

LOCA::Bifurcation::TPBord::StatusTest::ParameterUpdateNorm::ParameterUpdateNorm ( double  rtol,
double  atol,
double  tol 


rtol is the relative tolerance $\epsilon_r$, atol is the absolute tolerance $\epsilon_a$, and tol is the overall scale factor $\tau$ defined above.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends