NOX::Solver::Generic Class Reference

Abstract nonlinear solver method interface. More...

#include <NOX_Solver_Generic.H>

Inheritance diagram for NOX::Solver::Generic:

List of all members.

Public Member Functions
	Generic ()
	Constructor (does nothing)
virtual	~Generic ()
	Destructor (does nothing)
virtual void	reset (const NOX::Abstract::Vector &initial_guess)=0
	Resets the solver and sets a new initial guess.
virtual void	reset (const NOX::Abstract::Vector &initial_guess, const Teuchos::RCP< NOX::StatusTest::Generic > &test)=0
	Resets the solver, sets a new status test, and sets a new initial guess.
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 reference to the solver parameters.
virtual Teuchos::RCP< const NOX::Abstract::Group >	getSolutionGroupPtr () const
	Return a RCP to the solution group.
virtual Teuchos::RCP< const NOX::Abstract::Group >	getPreviousSolutionGroupPtr () const
	Return a RCP to the previous solution group.
virtual Teuchos::RCP< const Teuchos::ParameterList >	getListPtr () const
	Return a RCP 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 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::Solver::InexactTrustRegionBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, NOX::Solver::AndersonAcceleration, NOX::Multiphysics::Solver::FixedPointBased, NOX::Solver::LineSearchBased, LOCA::Solver::Wrapper, NOX::Multiphysics::Solver::Manager, and NOX::Solver::PseudoTransient.

---

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

• NOX_Solver_Generic.H