LOCA::StatusTest::Wrapper Class Reference

A wrapper class for wrapping a NOX status test. More...

#include <LOCA_StatusTest_Wrapper.H>

Inheritance diagram for LOCA::StatusTest::Wrapper:

Collaboration diagram for LOCA::StatusTest::Wrapper:

Public Member Functions
	Wrapper (const Teuchos::RCP< NOX::StatusTest::Generic > &s)
	Constructor.
virtual	~Wrapper ()
	Destructor.
virtual NOX::StatusTest::StatusType	checkStatus (const NOX::Solver::Generic &problem, NOX::StatusTest::CheckType checkType)
	Calls checkStatus of underlying status test.
virtual NOX::StatusTest::StatusType	getStatus () const
	Calls getStatus of underlying status test.
virtual std::ostream &	print (std::ostream &stream, int indent=0) const
	Calls print of underlying status test.
Teuchos::RCP < NOX::StatusTest::Generic >	getUnderlyingStatusTest ()
	Returns underlying status test.
Teuchos::RCP< const NOX::StatusTest::Generic >	getUnderlyingStatusTest () const
	Returns underlying status test.
Public Member Functions inherited from NOX::StatusTest::Generic
	Generic ()
	Constructor.
virtual	~Generic ()
	Destructor.

Protected Attributes
Teuchos::RCP < NOX::StatusTest::Generic >	statusTestPtr
	Stores pointer to underlying status test.

Detailed Description

A wrapper class for wrapping a NOX status test.

The LOCA::StatusTest::Wrapper class provides a wrapper for NOX status tests to change the solver passed to the wrapped status test. The solver passed through the checkStatus() method is wrapped via the LOCA::Solver::Wrapper class and then forwarded to the checkStatus() method of the wrapped status test. The purpose of this is to allow status tests that use concrete group data to function correctly when the group is stored in an extended continuation or bifurcation group. (See LOCA::Solver::Wrapper for more details or the LOCA status tests page for examples on how to effectively use this class.)

---

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

• LOCA_StatusTest_Wrapper.H
• LOCA_StatusTest_Wrapper.C