Light wrapper over linear solver, executes exactly one iteration. More...
#include <NOX_Solver_SingleStep.H>
Public Member Functions | |
| SingleStep (const Teuchos::RCP< NOX::Abstract::Group > &grp, const Teuchos::RCP< Teuchos::ParameterList > ¶ms) | |
| virtual void | reset (const NOX::Abstract::Vector &initial_guess) |
| 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) |
| Resets the solver, sets a new status test, and sets a new initial guess. | |
| virtual NOX::StatusTest::StatusType | getStatus () |
| Check current convergence and failure status. | |
| virtual NOX::StatusTest::StatusType | step () |
| Do one nonlinear step in the iteration sequence and return status. | |
| virtual NOX::StatusTest::StatusType | solve () |
| Solve the nonlinear problem and return final status. More... | |
| virtual const NOX::Abstract::Group & | getSolutionGroup () const |
| Return a reference to the current solution group. | |
| virtual Teuchos::RCP< const NOX::Abstract::Group > | getSolutionGroupPtr () const |
| Return a RCP to the solution group. | |
| virtual const NOX::Abstract::Group & | getPreviousSolutionGroup () const |
| Return a reference to the previous solution group. | |
| virtual Teuchos::RCP< const NOX::Abstract::Group > | getPreviousSolutionGroupPtr () const |
| Return a RCP to the previous solution group. | |
| virtual int | getNumIterations () const |
| Get number of iterations. | |
| virtual const Teuchos::ParameterList & | getList () const |
| Return a reference to the solver parameters. | |
| virtual Teuchos::RCP< const Teuchos::ParameterList > | getListPtr () const |
| Return a RCP to the solver parameters. | |
 Public Member Functions inherited from NOX::Solver::Generic | |
| Generic () | |
| Constructor (does nothing) | |
| virtual | ~Generic () |
| Destructor (does nothing) | |
Protected Member Functions | |
| virtual void | init () |
| Print out initialization information and calcuation the RHS. | |
| virtual void | printUpdate () |
| Prints some status information. | |
| bool | check (Abstract::Group::ReturnType ret, const std::string &task) |
| Prints some status information. | |
| bool | try_step () |
| Prints some status information. | |
Protected Attributes | |
| Teuchos::RCP< NOX::GlobalData > | globalDataPtr |
| Pointer to the global data object. | |
| Teuchos::RCP< NOX::Utils > | utilsPtr |
| Utils. | |
| Teuchos::RCP< NOX::Abstract::Group > | solnPtr |
| Current solution. | |
| Teuchos::RCP< NOX::Abstract::Group > | oldSolnPtr |
| Previous solution pointer. | |
| Teuchos::RCP< Teuchos::ParameterList > | paramsPtr |
| Input parameters. | |
| int | nIter |
| Number of nonlinear iterations. | |
| NOX::StatusTest::StatusType | status |
| Status of nonlinear solver. | |
| NOX::Solver::PrePostOperator | prePostOperator |
| Pointer to a user defined NOX::Abstract::PrePostOperator object. | |
Detailed Description
Light wrapper over linear solver, executes exactly one iteration.
This class exists to support applications which always instantiate a NOX Nonlinear solver via the NOX::Solver::Factory, but may be used to solve known linear problems. In that case, it is convenient to create a NOX::Solver object which requires no status tests and simply executes the linear solver.
Member Function Documentation
◆ solve()
|
virtual |
Solve the nonlinear problem and return final status.
By "solve", we call iterate() until the NOX::StatusTest value is either NOX::StatusTest::Converged or NOX::StatusTest::Failed.
Implements NOX::Solver::Generic.
References NOX::Solver::PseudoTransient::prePostOperator, NOX::Solver::PrePostOperator::runPostSolve(), NOX::Solver::PrePostOperator::runPreSolve(), NOX::Solver::PseudoTransient::status, and NOX::Solver::PseudoTransient::step().
The documentation for this class was generated from the following files:
- NOX_Solver_SingleStep.H
- NOX_Solver_SingleStep.C
