NOX Development
Loading...
Searching...
No Matches
Public Member Functions | List of all members
LOCA::StatusTest::Abstract Class Referenceabstract
Inheritance diagram for LOCA::StatusTest::Abstract:
Inheritance graph
[legend]

Public Member Functions

 Abstract ()
 Constructor.
 
virtual ~Abstract ()
 Destructor.
 
virtual LOCA::StatusTest::StatusType checkStatus (const LOCA::Abstract::Iterator &stepper, LOCA::StatusTest::CheckType checkType)=0
 Test the stopping criterion
 
virtual LOCA::StatusTest::StatusType getStatus () const =0
 Return the result of the most recent checkStatus call.
 
virtual std::ostream & print (std::ostream &stream, int indent=0) const =0
 Output formatted description of stopping test to output stream.
 

Member Function Documentation

◆ checkStatus()

virtual LOCA::StatusTest::StatusType LOCA::StatusTest::Abstract::checkStatus ( const LOCA::Abstract::Iterator stepper,
LOCA::StatusTest::CheckType  checkType 
)
pure virtual

Test the stopping criterion

The test can (and should, if possible) be skipped if checkType is LOCA::StatusType::None. If the test is skipped, then the status should be set to LOCA::StatusTest::Unevaluated.

Implemented in LOCA::StatusTest::Combo, and LOCA::StatusTest::MaxIters.

◆ getStatus()

virtual LOCA::StatusTest::StatusType LOCA::StatusTest::Abstract::getStatus ( ) const
pure virtual

Return the result of the most recent checkStatus call.

Implemented in LOCA::StatusTest::Combo, and LOCA::StatusTest::MaxIters.

◆ print()

virtual std::ostream & LOCA::StatusTest::Abstract::print ( std::ostream &  stream,
int  indent = 0 
) const
pure virtual

Output formatted description of stopping test to output stream.

Implemented in LOCA::StatusTest::Combo, and LOCA::StatusTest::MaxIters.


The documentation for this class was generated from the following file: