NOX::Solver::Generic Class Reference

Abstract nonlinear solver method interface. More...

#include <NOX_Solver_Generic.H>

Inheritance diagram for NOX::Solver::Generic:

Inheritance graph
[legend]
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::GroupgetSolutionGroup () const =0
 Return a reference to the current solution group.
virtual const NOX::Abstract::GroupgetPreviousSolutionGroup () const =0
 Return a reference to the previous solution group.
virtual int getNumIterations () const =0
 Get number of iterations.
virtual const Teuchos::ParameterListgetList () 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.


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::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.


The documentation for this class was generated from the following file:
Generated on Tue Oct 20 12:46:36 2009 for NOX by doxygen 1.4.7