A wrapper class for wrapping a NOX solver. More...

#include <LOCA_Solver_Wrapper.H>

Inheritance diagram for LOCA::Solver::Wrapper:

Collaboration diagram for LOCA::Solver::Wrapper:

Public Member Functions
	Wrapper (const Teuchos::RCP< NOX::Solver::Generic > &solver)
	Constructor with a non-const ref-count pointer to a NOX solver. More...

	Wrapper (const Teuchos::RCP< const NOX::Solver::Generic > &solver)
	Constructor with a const ref-count pointer to a NOX solver. More...

	~Wrapper ()
	Destructor.

void	reset ()
	Implementation of reset method (forwarded to wrapped solver)

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 () const
	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)

Teuchos::RCP< const NOX::Abstract::Group >	getSolutionGroupPtr () const
	Returns underlying group if solution group is extended, solution group otherwise.

Teuchos::RCP< const NOX::Abstract::Group >	getPreviousSolutionGroupPtr () const
	Returns underlying group if previous solution group is extended, previous solution group otherwise.

Teuchos::RCP< const Teuchos::ParameterList >	getListPtr () const
	Implementation of getListPtr method (forwarded to wrapped solver)

Teuchos::RCP< const NOX::SolverStats >	getSolverStatistics () const
	Returns the underlying nolinear solver statistics.

Public Member Functions inherited from NOX::Solver::Generic
	Generic ()
	Constructor (does nothing)

virtual	~Generic ()
	Destructor (does nothing)

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.

Detailed Description

A wrapper class for wrapping a NOX solver.

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::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.

Constructor & Destructor Documentation

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.

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.

References resetWrapper().

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

LOCA_Solver_Wrapper.H
LOCA_Solver_Wrapper.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation