NOX Development
Loading...
Searching...
No Matches
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.
 
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.
 
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 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::Abstract::GroupgetSolutionGroupPtr () const =0
 Return a RCP to the solution group.
 
virtual Teuchos::RCP< const NOX::Abstract::GroupgetPreviousSolutionGroupPtr () 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.
 
virtual Teuchos::RCP< const NOX::SolverStatsgetSolverStatistics () const =0
 Return a RCP to the solver statistics.
 

Detailed Description

Abstract nonlinear solver method interface.

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

Constructor & Destructor Documentation

◆ ~Generic()

virtual NOX::Solver::Generic::~Generic ( )
inlinevirtual

Destructor (does nothing)

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

Member Function Documentation

◆ getList()

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

◆ getListPtr()

virtual Teuchos::RCP< const Teuchos::ParameterList > NOX::Solver::Generic::getListPtr ( ) const
pure virtual

◆ getNumIterations()

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

◆ getPreviousSolutionGroup()

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

◆ getPreviousSolutionGroupPtr()

virtual Teuchos::RCP< const NOX::Abstract::Group > NOX::Solver::Generic::getPreviousSolutionGroupPtr ( ) const
pure virtual

◆ getSolutionGroup()

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

◆ getSolutionGroupPtr()

virtual Teuchos::RCP< const NOX::Abstract::Group > NOX::Solver::Generic::getSolutionGroupPtr ( ) const
pure virtual

◆ getSolverStatistics()

virtual Teuchos::RCP< const NOX::SolverStats > NOX::Solver::Generic::getSolverStatistics ( ) const
pure virtual

◆ getStatus()

virtual NOX::StatusTest::StatusType NOX::Solver::Generic::getStatus ( ) const
pure virtual

◆ reset() [1/3]

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

◆ reset() [2/3]

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

◆ reset() [3/3]

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

◆ solve()

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

◆ step()

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

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