NOX::Solver::Generic Class Reference

Abstract nonlinear solver method interface. More...

#include <NOX_Solver_Generic.H>

Inheritance diagram for NOX::Solver::Generic:

[legend]List of all members.

Public Member Functions
	Generic ()
	Constructor (does nothing).
virtual	~Generic ()
	Destructor (does nothing).
virtual bool	reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &params)=0
	Reset the nonlinear solver for a new solve.
virtual bool	reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp)=0
	An even softer reset of the nonlinear solver for a new problem.
virtual bool	reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests)=0
	A soft reset of the nonlinear solver for a new problem.
virtual NOX::StatusTest::StatusType	getStatus ()=0
	Check current convergence and failure status.
virtual NOX::StatusTest::StatusType	step ()=0
	Do one nonlinear step in the iteration sequence and return status.
virtual NOX::StatusTest::StatusType	solve ()=0
	Solve the nonlinear problem and return final status.
virtual const NOX::Abstract::Group &	getSolutionGroup () const =0
	Return a reference to the current solution group.
virtual const NOX::Abstract::Group &	getPreviousSolutionGroup () const =0
	Return a reference to the previous solution group.
virtual int	getNumIterations () const =0
	Get number of iterations.
virtual const Teuchos::ParameterList &	getList () const =0
	Return a refernece to the solver parameters.

---

Detailed Description

Abstract nonlinear solver method interface.

Defines the type of access methods into the iterative nonlinear solvers.

• Instantiate or reset() the solver.
• Find the solution via solve() or perform a single iterations via iterate().
• Get information about the current solver state via getSolutionGroup(), getPreviousSolutionGroup(), getNumIterations(), and getList() --- particularily useful for NOX::StatusTest methods.
• Get the current status of the solver via getStatus().

---

Member Function Documentation

virtual bool NOX::Solver::Generic::reset (  const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests )  [pure virtual]

A soft reset of the nonlinear solver for a new problem. This is a light-weight version of reset that takes no parameter list. Therefore, this reset only resets counters, the initial guess (contained in the grp argument) and new status tests (contained in the tests argument). This reset allows problems to bypass the potentially time consuming parsing of the parameter lists. Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Generic, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::Manager, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.

virtual bool NOX::Solver::Generic::reset (  const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp  )  [pure virtual]

An even softer reset of the nonlinear solver for a new problem. This is a light-weight version of reset that takes no parameter list or status tests. Therefore, this reset only resets counters and the initial guess (contained in the grp argument). This reset allows problems to bypass the potentially time consuming parsing of the parameter lists and to re-use existing status tests. Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Generic, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::Manager, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.

virtual bool NOX::Solver::Generic::reset (  const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &  params )  [pure virtual]

Reset the nonlinear solver for a new solve. Parameters: grp  On input, contains the intial guess. On output, contains the solution. tests  Status tests to check for convergence or failure. These tests will be modified by the solver. params  List of parameters. These parameters will be modified by the solver. Note: All the objects passed to reset() will be modified. The group object will be cloned via NOX::Abstract::Group::clone(), and the vectors within will also be individually cloned via NOX::Abstract::Vector::clone(). Warning: If the contents of grp, tests, or params are modified by the calling program after calling reset(), then the behavior of iterate() and solve() are completely undefined. To remedy this, call reset() again with the modified objects. Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Generic, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::Manager, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.

virtual NOX::StatusTest::StatusType NOX::Solver::Generic::solve (   )  [pure virtual]

Solve the nonlinear problem and return final status. By "solve", we call iterate() until the NOX::StatusTest value is either NOX::StatusTest::Converged or NOX::StatusTest::Failed. Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::Manager, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.

---

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

• NOX_Solver_Generic.H

---