NOX Development
|
A convergence test based on the weighted root-mean-square norm of the update to the null vector component for pitchfork location. More...
#include <LOCA_Bifurcation_PitchforkBord_NullVectorNormWRMS.H>
Public Member Functions | |
NullVectorNormWRMS (double rtol, double atol, double tol) | |
Constructor. | |
virtual | ~NullVectorNormWRMS () |
Destructor. | |
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 | getNullVectorNormWRMS () 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. | |
![]() | |
Generic () | |
Constructor. | |
virtual | ~Generic () |
Destructor. | |
virtual NOX::StatusTest::StatusType | checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)=0 |
Test the stopping criterion | |
virtual std::ostream & | print (std::ostream &stream, int indent=0) const =0 |
Output formatted description of stopping test to output stream. | |
Protected Attributes | |
double | rtol |
Relative tolerance for convergence. | |
double | atol |
Absolute tolerance for convergence. | |
double | tol |
Tolerance for convergence. | |
double | normWRMS |
Current value of the parameter update norm. | |
NOX::StatusTest::StatusType | status |
Status of entire status test | |
A convergence test based on the weighted root-mean-square norm of the update to the null vector component for pitchfork location.
Let
where
Note that this status test deals only with the null vector component of the pitchfork equations. This status test should be combined with other status tests for the solution and parameter 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 pitchfork group (i.e., not derived from LOCA::Bifurcation::PitchforkBord::ExtendedGroup), checkStatus() returns NOX::StatusTest::Converged. This allows the status test to be used in situations other than pitchfork tracking, e.g., steady-state solves, without raising error conditions.
LOCA::Bifurcation::PitchforkBord::StatusTest::NullVectorNormWRMS::NullVectorNormWRMS | ( | double | rtol, |
double | atol, | ||
double | tol ) |
Constructor.
rtol is the relative tolerance
|
virtual |
Returns status as defined above.
Implements NOX::StatusTest::Generic.