#include <LOCA_Solver_Wrapper.H>
Public Member Functions | |
Wrapper (const Teuchos::RCP< NOX::Solver::Generic > &solver) | |
Constructor with a non-const ref-count pointer to a NOX solver. | |
Wrapper (const Teuchos::RCP< const NOX::Solver::Generic > &solver) | |
Constructor with a const ref-count pointer to a NOX solver. | |
~Wrapper () | |
Destructor. | |
void | reset (const NOX::Abstract::Vector &initialGuess) |
Implementation of reset method (forwarded to wrapped solver). | |
void | reset (const NOX::Abstract::Vector &initialGuess, const Teuchos::RCP< 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 | step () |
Implementation of step 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 Teuchos::ParameterList & | getList () const |
Implementation of getList method (forwarded to wrapped solver). | |
Protected Member Functions | |
void | resetWrapper () |
Grabs appropriate solution groups from solver. | |
Protected Attributes | |
Teuchos::RCP < NOX::Solver::Generic > | solverPtr |
Pointer to the solver object. | |
Teuchos::RCP< const NOX::Solver::Generic > | constSolverPtr |
Pointer to the const solver object. | |
Teuchos::RCP< const NOX::Abstract::Group > | solnGrpPtr |
Pointer to solution group. | |
Teuchos::RCP< const NOX::Abstract::Group > | oldSolnGrpPtr |
Pointer to previous solution group. |
The LOCASolver::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::MultiAbstractGroup::getUnderlyingGroup()) if they are extended groups (derived from LOCA::Extended::MultiAbstractGroup). 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.
Definition at line 84 of file LOCA_Solver_Wrapper.H.
LOCA::Solver::Wrapper::Wrapper | ( | const Teuchos::RCP< NOX::Solver::Generic > & | solver | ) |
Constructor with a non-const ref-count pointer to a NOX solver.
The constructor calls resetWrapper() to grab the proper solution groups.
Definition at line 47 of file LOCA_Solver_Wrapper.C.
References resetWrapper().
LOCA::Solver::Wrapper::Wrapper | ( | const Teuchos::RCP< const NOX::Solver::Generic > & | solver | ) |
Constructor with a const ref-count pointer to a NOX solver.
The constructor calls resetWrapper() to grab the proper solution groups.
Definition at line 55 of file LOCA_Solver_Wrapper.C.
References resetWrapper().
LOCA::Solver::Wrapper::~Wrapper | ( | ) |
void LOCA::Solver::Wrapper::reset | ( | const NOX::Abstract::Vector & | initialGuess | ) | [virtual] |
Implementation of reset method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 77 of file LOCA_Solver_Wrapper.C.
References resetWrapper(), and solverPtr.
void LOCA::Solver::Wrapper::reset | ( | const NOX::Abstract::Vector & | initialGuess, | |
const Teuchos::RCP< NOX::StatusTest::Generic > & | tests | |||
) |
Implementation of reset method (forwarded to wrapped solver).
Definition at line 68 of file LOCA_Solver_Wrapper.C.
References resetWrapper(), and solverPtr.
NOX::StatusTest::StatusType LOCA::Solver::Wrapper::getStatus | ( | ) | [virtual] |
Implementation of getStatus method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 84 of file LOCA_Solver_Wrapper.C.
References solverPtr.
NOX::StatusTest::StatusType LOCA::Solver::Wrapper::step | ( | ) | [virtual] |
Implementation of step method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 90 of file LOCA_Solver_Wrapper.C.
References resetWrapper(), and solverPtr.
NOX::StatusTest::StatusType LOCA::Solver::Wrapper::solve | ( | ) | [virtual] |
Implementation of solve method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 98 of file LOCA_Solver_Wrapper.C.
References resetWrapper(), and solverPtr.
const NOX::Abstract::Group & LOCA::Solver::Wrapper::getSolutionGroup | ( | ) | const [virtual] |
Returns underlying group if solution group is extended, solution group otherwise.
Implements NOX::Solver::Generic.
Definition at line 106 of file LOCA_Solver_Wrapper.C.
References solnGrpPtr.
const NOX::Abstract::Group & LOCA::Solver::Wrapper::getPreviousSolutionGroup | ( | ) | const [virtual] |
Returns underlying group if previous solution group is extended, previous solution group otherwise.
Implements NOX::Solver::Generic.
Definition at line 112 of file LOCA_Solver_Wrapper.C.
References oldSolnGrpPtr.
int LOCA::Solver::Wrapper::getNumIterations | ( | ) | const [virtual] |
Implementation of getNumIterations method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 118 of file LOCA_Solver_Wrapper.C.
References constSolverPtr.
const Teuchos::ParameterList & LOCA::Solver::Wrapper::getList | ( | ) | const [virtual] |
Implementation of getList method (forwarded to wrapped solver).
Implements NOX::Solver::Generic.
Definition at line 124 of file LOCA_Solver_Wrapper.C.
References constSolverPtr.
void LOCA::Solver::Wrapper::resetWrapper | ( | ) | [protected] |
Grabs appropriate solution groups from solver.
Definition at line 130 of file LOCA_Solver_Wrapper.C.
References constSolverPtr, LOCA::Extended::MultiAbstractGroup::getUnderlyingGroup(), oldSolnGrpPtr, and solnGrpPtr.
Teuchos::RCP<NOX::Solver::Generic> LOCA::Solver::Wrapper::solverPtr [protected] |
Pointer to the solver object.
Definition at line 153 of file LOCA_Solver_Wrapper.H.
Referenced by getStatus(), reset(), solve(), and step().
Teuchos::RCP<const NOX::Solver::Generic> LOCA::Solver::Wrapper::constSolverPtr [protected] |
Pointer to the const solver object.
Definition at line 156 of file LOCA_Solver_Wrapper.H.
Referenced by getList(), getNumIterations(), and resetWrapper().
Teuchos::RCP<const NOX::Abstract::Group> LOCA::Solver::Wrapper::solnGrpPtr [protected] |
Pointer to solution group.
Definition at line 159 of file LOCA_Solver_Wrapper.H.
Referenced by getSolutionGroup(), and resetWrapper().
Teuchos::RCP<const NOX::Abstract::Group> LOCA::Solver::Wrapper::oldSolnGrpPtr [protected] |
Pointer to previous solution group.
Definition at line 162 of file LOCA_Solver_Wrapper.H.
Referenced by getPreviousSolutionGroup(), and resetWrapper().