NOX::Solver::Generic Class Reference
Abstract nonlinear solver method interface. More...
#include <NOX_Solver_Generic.H>
Public Member Functions | |
| Generic () | |
| Constructor (does nothing). | |
| virtual | ~Generic () |
| Destructor (does nothing). | |
| 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 | 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. | |
| 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 int | getNumIterations () const =0 |
| Get number of iterations. | |
| virtual const Teuchos::ParameterList & | getList () const =0 |
| Return a refernece to the solver parameters. | |
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 getList() --- particularily useful for NOX::StatusTest methods.
- Get the current status of the solver via getStatus().
Definition at line 85 of file NOX_Solver_Generic.H.
Constructor & Destructor Documentation
| NOX::Solver::Generic::Generic | ( | ) | [inline] |
Constructor (does nothing).
Reimplemented in NOX::Multiphysics::Solver::Generic.
Definition at line 90 of file NOX_Solver_Generic.H.
| virtual NOX::Solver::Generic::~Generic | ( | ) | [inline, virtual] |
Destructor (does nothing).
Reimplemented in NOX::Multiphysics::Solver::Generic.
Definition at line 93 of file NOX_Solver_Generic.H.
Member Function Documentation
| virtual void NOX::Solver::Generic::reset | ( | const NOX::Abstract::Vector & | initial_guess | ) | [pure virtual] |
Resets the solver and sets a new initial guess.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Generic, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
| virtual void NOX::Solver::Generic::reset | ( | const NOX::Abstract::Vector & | initial_guess, | |
| const Teuchos::RCP< NOX::StatusTest::Generic > & | test | |||
| ) | [pure virtual] |
Resets the solver, sets a new status test, and sets a new initial guess.
Implemented in NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, and NOX::Solver::TrustRegionBased.
| virtual NOX::StatusTest::StatusType NOX::Solver::Generic::getStatus | ( | ) | [pure virtual] |
Check current convergence and failure status.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::Multiphysics::Solver::Manager::getStatus().
| virtual NOX::StatusTest::StatusType NOX::Solver::Generic::step | ( | ) | [pure virtual] |
Do one nonlinear step in the iteration sequence and return status.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::Multiphysics::Solver::Manager::step().
| virtual NOX::StatusTest::StatusType NOX::Solver::Generic::solve | ( | ) | [pure 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.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::Multiphysics::Solver::Manager::solve().
| virtual const NOX::Abstract::Group& NOX::Solver::Generic::getSolutionGroup | ( | ) | const [pure virtual] |
Return a reference to the current solution group.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::StatusTest::Stagnation::checkStatus(), NOX::StatusTest::NormWRMS::checkStatus(), NOX::StatusTest::NormUpdate::checkStatus(), NOX::StatusTest::NormF::checkStatus(), NOX::StatusTest::FiniteValue::checkStatus(), NOX::StatusTest::Divergence::checkStatus(), NOX::Multiphysics::Solver::Manager::getSolutionGroup(), and NOX::Epetra::BroydenOperator::runPostIterate().
| virtual const NOX::Abstract::Group& NOX::Solver::Generic::getPreviousSolutionGroup | ( | ) | const [pure virtual] |
Return a reference to the previous solution group.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::StatusTest::Stagnation::checkStatus(), NOX::StatusTest::NormWRMS::checkStatus(), NOX::StatusTest::NormUpdate::checkStatus(), NOX::LineSearch::Polynomial::compute(), NOX::LineSearch::NonlinearCG::compute(), NOX::LineSearch::MoreThuente::compute(), NOX::LineSearch::FullStep::compute(), NOX::LineSearch::Backtrack::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Newton::compute(), NOX::Solver::TensorBased::computeTensorDirection(), NOX::Multiphysics::Solver::Manager::getPreviousSolutionGroup(), NOX::Solver::TensorBased::implementGlobalStrategy(), NOX::Solver::TensorBased::performLinesearch(), and NOX::Epetra::BroydenOperator::runPostIterate().
| virtual int NOX::Solver::Generic::getNumIterations | ( | ) | const [pure virtual] |
Get number of iterations.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::StatusTest::Stagnation::checkStatus(), NOX::StatusTest::NormWRMS::checkStatus(), NOX::StatusTest::NormUpdate::checkStatus(), NOX::StatusTest::MaxIters::checkStatus(), NOX::StatusTest::Divergence::checkStatus(), NOX::LineSearch::Polynomial::compute(), NOX::Direction::NonlinearCG::compute(), NOX::Direction::Newton::compute(), LOCA::StepSize::Adaptive::computeStepSize(), NOX::Multiphysics::Solver::Manager::getNumIterations(), and NOX::Epetra::BroydenOperator::runPostIterate().
| virtual const Teuchos::ParameterList& NOX::Solver::Generic::getList | ( | ) | const [pure virtual] |
Return a refernece to the solver parameters.
Implemented in NOX::Multiphysics::Solver::FixedPointBased, NOX::Multiphysics::Solver::Manager, NOX::Solver::InexactTrustRegionBased, NOX::Solver::LineSearchBased, NOX::Solver::TensorBased, NOX::Solver::TrustRegionBased, and LOCA::Solver::Wrapper.
Referenced by NOX::StatusTest::NormWRMS::checkStatus(), NOX::LineSearch::Polynomial::compute(), NOX::LineSearch::MoreThuente::cvsrch(), and NOX::Multiphysics::Solver::Manager::getList().
The documentation for this class was generated from the following file:
