NOX  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
NOX::Solver::Generic Class Referenceabstract

Abstract nonlinear solver method interface. More...

#include <NOX_Solver_Generic.H>

Inheritance diagram for NOX::Solver::Generic:
Inheritance graph
[legend]

Public Member Functions

 Generic ()
 Constructor (does nothing)
 
virtual ~Generic ()
 Destructor (does nothing)
 
virtual void reset ()=0
 Resets the solver for another solve. This resets the counters and status only. Uses the final solution from the last solve as the initial guess for the next solve. More...
 
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 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. More...
 
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 NOX::StatusTest::StatusType getStatus () const =0
 Returns the current status of the solver.
 
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::SolverStats
getSolverStatistics () const =0
 Return a RCP to the solver statistics.
 
virtual Teuchos::RCP< const
NOX::Abstract::Group
getSolutionGroupPtr () const =0
 Return a RCP to the solution group.
 
virtual Teuchos::RCP< const
NOX::Abstract::Group
getPreviousSolutionGroupPtr () const =0
 Return a RCP to the previous solution group.
 
virtual Teuchos::RCP< const
Teuchos::ParameterList
getListPtr () const =0
 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.

Member Function Documentation

virtual void NOX::Solver::Generic::reset ( )
pure virtual

Resets the solver for another solve. This resets the counters and status only. Uses the final solution from the last solve as the initial guess for the next solve.

NOTE: All NOX solvers will call reset() automatically at teh beginning of the solve() method. We add the reset() method to the solver interface for the application to call in case the application needs to reset counters and status manually before the next call to solve() is made.

Implemented in NOX::Solver::InexactTrustRegionBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, NOX::Multiphysics::Solver::FixedPointBased, NOX::Solver::AndersonAcceleration, NOX::Solver::LineSearchBased, NOX::Multiphysics::Solver::Manager, LOCA::Solver::Wrapper, NOX::Solver::PseudoTransient, and NOX::Solver::SingleStep.

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

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