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

Definition at line 85 of file NOX_Solver_Generic.H.


Constructor & Destructor Documentation

NOX::Solver::Generic::Generic (  )  [inline]

Constructor (does nothing).

Reimplemented in NOX::Multiphysics::Solver::Generic.

Definition at line 90 of file NOX_Solver_Generic.H.

virtual NOX::Solver::Generic::~Generic (  )  [inline, virtual]

Destructor (does nothing).

Reimplemented in NOX::Multiphysics::Solver::Generic.

Definition at line 93 of file NOX_Solver_Generic.H.


Member Function Documentation

virtual void NOX::Solver::Generic::reset ( const NOX::Abstract::Vector initial_guess  )  [pure virtual]

virtual void NOX::Solver::Generic::reset ( const NOX::Abstract::Vector initial_guess,
const Teuchos::RCP< NOX::StatusTest::Generic > &  test 
) [pure virtual]

Resets the solver, sets a new status test, and sets a new initial guess.

Implemented in NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, and NOX::Solver::TrustRegionBased.

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

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

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

virtual const NOX::Abstract::Group& NOX::Solver::Generic::getSolutionGroup (  )  const [pure virtual]

virtual const NOX::Abstract::Group& NOX::Solver::Generic::getPreviousSolutionGroup (  )  const [pure virtual]

virtual int NOX::Solver::Generic::getNumIterations (  )  const [pure virtual]

virtual const Teuchos::ParameterList& NOX::Solver::Generic::getList (  )  const [pure virtual]


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

Generated on Thu Dec 17 11:03:08 2009 for Nonlinear Solver Project by  doxygen 1.5.9