NOX::Multiphysics::Solver::Generic Class Reference
Abstract nonlinear solver method interface. More...
#include <NOX_Multiphysics_Solver_Generic.H>
Public Member Functions | |
| Generic () | |
| Constructor (does nothing). | |
| virtual | ~Generic () |
| Destructor (does nothing). | |
| virtual bool | reset (const Teuchos::RCP< 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 > ¶ms)=0 |
| Reset the nonlinear solver for a new solve. | |
| 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 |
Detailed Description
Abstract nonlinear solver method interface.Defines the type of access methods into the iterative nonlinear solvers.
- Instantiate or reset() the solver.
- Find the solution via solve() or perform a single iterations via iterate().
- Get information about the current solver state via getSolutionGroup(), getPreviousSolutionGroup(), getNumIterations(), and getParameterList() --- particularily useful for NOX::StatusTest methods.
- Get the current status of the solver via getStatus().
Definition at line 84 of file NOX_Multiphysics_Solver_Generic.H.
Constructor & Destructor Documentation
| NOX::Multiphysics::Solver::Generic::Generic | ( | ) | [inline] |
Constructor (does nothing).
Reimplemented from NOX::Solver::Generic.
Definition at line 89 of file NOX_Multiphysics_Solver_Generic.H.
| virtual NOX::Multiphysics::Solver::Generic::~Generic | ( | ) | [inline, virtual] |
Destructor (does nothing).
Reimplemented from NOX::Solver::Generic.
Definition at line 92 of file NOX_Multiphysics_Solver_Generic.H.
Member Function Documentation
| virtual bool NOX::Multiphysics::Solver::Generic::reset | ( | const Teuchos::RCP< 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:
-
tests Status tests to check for convergence or failure. These tests will be modified by the solver. params List 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.
Referenced by NOX::Multiphysics::Solver::Manager::reset().
| virtual void NOX::Multiphysics::Solver::Generic::reset | ( | const NOX::Abstract::Vector & | initialGuess | ) | [pure virtual] |
reset methods inherited from NOX::Solver::Generic and needed here to avoid hiding this overloaded virtual method
Implements NOX::Solver::Generic.
Implemented in NOX::Multiphysics::Solver::FixedPointBased.
The documentation for this class was generated from the following file:
