#include <LOCA_Solver_Wrapper.H>
Inheritance diagram for LOCA::Solver::Wrapper:
Public Member Functions  
Wrapper (NOX::Solver::Generic &solver)  
Constructor with a nonconst reference to a NOX solver.  
Wrapper (const NOX::Solver::Generic &solver)  
Constructor with a const reference to a NOX solver.  
~Wrapper ()  
Destructor.  
bool  reset (NOX::Abstract::Group &grp, NOX::StatusTest::Generic &tests, NOX::Parameter::List ¶ms) 
Implementation of reset method (forwarded to wrapped solver).  
bool  reset (NOX::Abstract::Group &grp, NOX::StatusTest::Generic &tests) 
Implementation of reset method (forwarded to wrapped solver).  
NOX::StatusTest::StatusType  getStatus () 
Implementation of getStatus method (forwarded to wrapped solver).  
NOX::StatusTest::StatusType  iterate () 
Implementation of iterate method (forwarded to wrapped solver).  
NOX::StatusTest::StatusType  solve () 
Implementation of solve method (forwarded to wrapped solver).  
const NOX::Abstract::Group &  getSolutionGroup () const 
Returns underlying group if solution group is extended, solution group otherwise.  
const NOX::Abstract::Group &  getPreviousSolutionGroup () const 
Returns underlying group if previous solution group is extended, previous solution group otherwise.  
int  getNumIterations () const 
Implementation of getNumIterations method (forwarded to wrapped solver).  
const NOX::Parameter::List &  getParameterList () const 
Implementation of getParameterList method (forwarded to wrapped solver).  
Protected Member Functions  
void  resetWrapper () 
Grabs appropriate solution groups from solver.  
Protected Attributes  
NOX::Solver::Generic *  solverPtr 
Pointer to the solver object.  
const NOX::Abstract::Group *  solnGrpPtr 
Pointer to solution group.  
const NOX::Abstract::Group *  oldSolnGrpPtr 
Pointer to previous solution group. 
The LOCA::Solver::Wrapper class provides a wrapper for NOX solvers to change the group data returned by getSolutionGroup() and getPreviousSolutionGroup() so that status tests can operate correctly. LOCA continuation and bifurcation algorithms are implemented by extended groups which augment the nonlinear equations defining equilibrium solutions with appropriate continuation/bifurcation equations. Therefore the groups returned by getSolutionGroup() and getPreviousSolutionGroup() will be groups corresponding to the continuation/bifurcation equations, not the underlying group. Status tests that are designed to use concrete data from the original underlying group (e.g., NOX::StatusTest::NormWRMS) will then fail (usually via a segmentation fault or raised exception) when applied to the extended continuation or bifurcation groups.
This solver wrapper class fixes this problem by reimplementing the solution group accessor methods to return the underlying groups of the solution groups (via LOCA::Extended::AbstractGroup::getUnderlyingGroup()) if they are extended groups (derived from LOCA::Extended::AbstractGroup). If the groups are not extended groups, the original solution groups are returned. All other NOX::Solver::Generic methods are passed to the wrapped solver.
The LOCA::StatusTest::Wrapper class uses this wrapper class to wrap the solver supplied via the checkStatus method which is then forwarded to the original status test. When used properly, the group "seen" by the status test is of the appropriate type for the status test.

Constructor with a nonconst reference to a NOX solver. The constructor calls resetWrapper() to grab the proper solution groups. 

Constructor with a const reference to a NOX solver. The constructor calls resetWrapper() to grab the proper solution groups. 