NOX Development
Public Member Functions
NOX::StatusTest::RelativeNormF Class Reference

Requires reduction in residual norm compared to initial norm. More...

#include <NOX_StatusTest_RelativeNormF.H>

Inheritance diagram for NOX::StatusTest::RelativeNormF:
Inheritance graph
Collaboration diagram for NOX::StatusTest::RelativeNormF:
Collaboration graph

List of all members.

Public Member Functions

 RelativeNormF (double tolerance, bool scale_norms_by_vector_length=false, const NOX::Utils *u=NULL)
virtual NOX::StatusTest::StatusType checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)
 Test the stopping criterion
virtual NOX::StatusTest::StatusType getStatus () const
 Return the result of the most recent checkStatus call.
virtual ostream & print (ostream &stream, int indent=0) const
 Output formatted description of stopping test to output stream.

Detailed Description

Requires reduction in residual norm compared to initial norm.

At iteration zero, this computes $||F_0||$ and is unconverged.

Returns a converged status if $||F_k|| < ||F_0|| * \mbox{tolerance}$, where $k$ is the nonlinear iteration number.

Member Function Documentation

NOX::StatusTest::StatusType NOX::StatusTest::RelativeNormF::checkStatus ( const NOX::Solver::Generic problem,
NOX::StatusTest::CheckType  checkType 
) [virtual]

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