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:

Inheritance graph
[legend]
Collaboration diagram for LOCA::StatusTest::Wrapper:

Collaboration graph
[legend]

List of all members.

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 ostream & print (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.

Protected Attributes

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

Private Member Functions

 Wrapper (const Wrapper &)
 Private to prohibit copying.
Wrapperoperator= (const Wrapper &)
 Private to prohibit copying.


Detailed Description

A wrapper class for wrapping a NOX status test.

The LOCAStatusTest::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.)

Definition at line 68 of file LOCA_StatusTest_Wrapper.H.


Constructor & Destructor Documentation

LOCA::StatusTest::Wrapper::Wrapper ( const Teuchos::RCP< NOX::StatusTest::Generic > &  s  ) 

Constructor.

Definition at line 45 of file LOCA_StatusTest_Wrapper.C.

LOCA::StatusTest::Wrapper::~Wrapper (  )  [virtual]

Destructor.

Definition at line 51 of file LOCA_StatusTest_Wrapper.C.

LOCA::StatusTest::Wrapper::Wrapper ( const Wrapper  )  [private]

Private to prohibit copying.


Member Function Documentation

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

Calls checkStatus of underlying status test.

Implements NOX::StatusTest::Generic.

Definition at line 56 of file LOCA_StatusTest_Wrapper.C.

References statusTestPtr.

NOX::StatusTest::StatusType LOCA::StatusTest::Wrapper::getStatus (  )  const [virtual]

Calls getStatus of underlying status test.

Implements NOX::StatusTest::Generic.

Definition at line 65 of file LOCA_StatusTest_Wrapper.C.

References statusTestPtr.

ostream & LOCA::StatusTest::Wrapper::print ( ostream &  stream,
int  indent = 0 
) const [virtual]

Calls print of underlying status test.

Implements NOX::StatusTest::Generic.

Definition at line 70 of file LOCA_StatusTest_Wrapper.C.

References statusTestPtr.

Teuchos::RCP< NOX::StatusTest::Generic > LOCA::StatusTest::Wrapper::getUnderlyingStatusTest (  ) 

Returns underlying status test.

Definition at line 76 of file LOCA_StatusTest_Wrapper.C.

References statusTestPtr.

Teuchos::RCP< const NOX::StatusTest::Generic > LOCA::StatusTest::Wrapper::getUnderlyingStatusTest (  )  const

Returns underlying status test.

Definition at line 82 of file LOCA_StatusTest_Wrapper.C.

References statusTestPtr.

Wrapper& LOCA::StatusTest::Wrapper::operator= ( const Wrapper  )  [private]

Private to prohibit copying.


Member Data Documentation

Stores pointer to underlying status test.

Definition at line 108 of file LOCA_StatusTest_Wrapper.H.

Referenced by checkStatus(), getStatus(), getUnderlyingStatusTest(), and print().


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

Generated on Thu Dec 17 11:03:00 2009 for Nonlinear Solver Project by  doxygen 1.5.9