NOX Development
Public Member Functions | Protected Member Functions | Protected Attributes
NOX::Solver::LineSearchBased Class Reference

Nonlinear solver based on a line search (i.e., damping) More...

#include <NOX_Solver_LineSearchBased.H>

Inheritance diagram for NOX::Solver::LineSearchBased:
Inheritance graph
[legend]
Collaboration diagram for NOX::Solver::LineSearchBased:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LineSearchBased (const Teuchos::RCP< NOX::Abstract::Group > &grp, const Teuchos::RCP< NOX::StatusTest::Generic > &tests, const Teuchos::RCP< Teuchos::ParameterList > &params)
 Constructor.
virtual ~LineSearchBased ()
 Destructor.
virtual void reset (const NOX::Abstract::Vector &initialGuess, const Teuchos::RCP< NOX::StatusTest::Generic > &tests)
 Resets the solver, sets a new status test, and sets a new initial guess.
virtual void reset (const NOX::Abstract::Vector &initialGuess)
 Resets the solver 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.
virtual const
NOX::Abstract::Group
getSolutionGroup () const
 Return a reference to the current solution group.
virtual const
NOX::Abstract::Group
getPreviousSolutionGroup () const
 Return a reference 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 double getStepSize () const
virtual Teuchos::RCP< const
NOX::Abstract::Group
getSolutionGroupPtr () const
 Return a RCP to the solution group.
virtual Teuchos::RCP< const
NOX::Abstract::Group
getPreviousSolutionGroupPtr () const
 Return a RCP to the previous solution group.
virtual Teuchos::RCP< const
Teuchos::ParameterList
getListPtr () const
 Return a RCP to the solver parameters.

Protected Member Functions

virtual void init ()
 Print out initialization information and calcuation the RHS.
virtual void printUpdate ()
 Prints the current iteration information.

Protected Attributes

Teuchos::RCP< NOX::GlobalDataglobalDataPtr
 Pointer to the global data object.
Teuchos::RCP< NOX::UtilsutilsPtr
 Utils.
Teuchos::RCP
< NOX::Abstract::Group
solnPtr
 Current solution.
Teuchos::RCP
< NOX::Abstract::Group
oldSolnPtr
 Previous solution pointer.
Teuchos::RCP
< NOX::Abstract::Vector
dirPtr
 Current search direction pointer.
Teuchos::RCP
< NOX::StatusTest::Generic
testPtr
 Stopping test.
Teuchos::RCP
< Teuchos::ParameterList
paramsPtr
 Input parameters.
Teuchos::RCP
< NOX::LineSearch::Generic
lineSearchPtr
 Linesearch.
Teuchos::RCP
< NOX::Direction::Generic
directionPtr
 Search Direction.
double stepSize
 Current step.
int nIter
 Number of nonlinear iterations.
NOX::StatusTest::StatusType status
 Status of nonlinear solver.
NOX::StatusTest::CheckType checkType
 Type of check to use for status tests. See NOX::StatusTest for more details.
NOX::Solver::PrePostOperator prePostOperator
 Pointer to a user defined NOX::Abstract::PrePostOperator object.

Detailed Description

Nonlinear solver based on a line search (i.e., damping)

Solves $F(x)=0$ using an iterative line-search-based method.

Each iteration, the solver does the following.

The iterations progress until the status tests (see NOX::StatusTest) determine either failure or convergence.

Note:
To support several line searches and status tests, this version of the solver has a getStepSize() function that returns $\lambda$.

Input Parameters

The following parameter list entries are valid for this solver:

Output Parameters

Every time solve() is called, a sublist for output parameters called "Output" will be created and contain the following parameters.

"Output":

Author:
Tammy Kolda (SNL 8950), Roger Pawlowski (SNL 9233)

Constructor & Destructor Documentation

NOX::Solver::LineSearchBased::LineSearchBased ( const Teuchos::RCP< NOX::Abstract::Group > &  grp,
const Teuchos::RCP< NOX::StatusTest::Generic > &  tests,
const Teuchos::RCP< Teuchos::ParameterList > &  params 
)

Constructor.

See reset(NOX::Abstract::Group&, NOX::StatusTest::Generic&, Teuchos::ParameterList&) for description

References NOX::DeepCopy, init(), rcp(), and NOX::ShapeCopy.


Member Function Documentation

NOX::StatusTest::StatusType NOX::Solver::LineSearchBased::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 Teuchos::ParameterList::set(), Teuchos::ParameterList::sublist(), and NOX::StatusTest::Unconverged.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends