NOX  Development
Public Member Functions | List of all members
NOX::Multiphysics::Solver::Generic Class Referenceabstract

Abstract nonlinear solver method interface. More...

#include <NOX_Multiphysics_Solver_Generic.H>

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

Public Member Functions

 Generic ()
 Constructor (does nothing)
 
virtual ~Generic ()
 Destructor (does nothing)
 
virtual bool reset (const Teuchos::RCP< std::vector< Teuchos::RCP< NOX::Solver::Generic > > > &solvers, const Teuchos::RCP< NOX::Multiphysics::DataExchange::Interface > &interface, const Teuchos::RCP< NOX::StatusTest::Generic > &tests, const Teuchos::RCP< Teuchos::ParameterList > &params)=0
 Reset the nonlinear solver for a new solve. More...
 
virtual void reset (const NOX::Abstract::Vector &initialGuess)=0
 reset methods inherited from NOX::Solver::Generic and needed here to avoid hiding this overloaded virtual method
 
virtual void reset (const NOX::Abstract::Vector &initialGuess, const Teuchos::RCP< NOX::StatusTest::Generic > &tests)=0
 Resets the solver, sets a new status test, and sets a new initial guess.
 
- Public Member Functions inherited from NOX::Solver::Generic
 Generic ()
 Constructor (does nothing)
 
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. More...
 
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 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::ParameterListgetListPtr () 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

◆ reset()

virtual bool NOX::Multiphysics::Solver::Generic::reset ( const Teuchos::RCP< std::vector< Teuchos::RCP< NOX::Solver::Generic > > > &  solvers,
const Teuchos::RCP< NOX::Multiphysics::DataExchange::Interface > &  interface,
const Teuchos::RCP< NOX::StatusTest::Generic > &  tests,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)
pure virtual

Reset the nonlinear solver for a new solve.

Parameters
testsStatus tests to check for convergence or failure. These tests will be modified by the solver.
paramsList of parameters. These parameters will be modified by the solver.
Note
All the objects passed to reset() will be modified.
The group object will be cloned via NOX::Abstract::Group::clone(), and the vectors within will also be individually cloned via NOX::Abstract::Vector::clone().
Warning
If the contents of grp, tests, or params are modified by the calling program after calling reset(), then the behavior of iterate() and solve() are completely undefined. To remedy this, call reset() again with the modified objects.

Implemented in NOX::Multiphysics::Solver::FixedPointBased.


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