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 refernece to the solver parameters.
virtual double getStepSize () const
 Return the line search step size from the current iteration.

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)

Definition at line 117 of file NOX_Solver_LineSearchBased.H.


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

Definition at line 56 of file NOX_Solver_LineSearchBased.C.

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

NOX::Solver::LineSearchBased::~LineSearchBased (  )  [virtual]

Destructor.

Definition at line 112 of file NOX_Solver_LineSearchBased.C.


Member Function Documentation

void NOX::Solver::LineSearchBased::reset ( const NOX::Abstract::Vector initial_guess,
const Teuchos::RCP< NOX::StatusTest::Generic > &  test 
) [virtual]

Resets the solver, sets a new status test, and sets a new initial guess.

Implements NOX::Solver::Generic.

Definition at line 97 of file NOX_Solver_LineSearchBased.C.

References init(), solnPtr, and testPtr.

void NOX::Solver::LineSearchBased::reset ( const NOX::Abstract::Vector initial_guess  )  [virtual]

Resets the solver and sets a new initial guess.

Implements NOX::Solver::Generic.

Definition at line 106 of file NOX_Solver_LineSearchBased.C.

References init(), and solnPtr.

NOX::StatusTest::StatusType NOX::Solver::LineSearchBased::getStatus (  )  [virtual]

Check current convergence and failure status.

Implements NOX::Solver::Generic.

Definition at line 118 of file NOX_Solver_LineSearchBased.C.

References status.

NOX::StatusTest::StatusType NOX::Solver::LineSearchBased::step (  )  [virtual]

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.

Definition at line 218 of file NOX_Solver_LineSearchBased.C.

References nIter, paramsPtr, prePostOperator, NOX::Solver::PrePostOperator::runPostSolve(), NOX::Solver::PrePostOperator::runPreSolve(), solnPtr, status, step(), and NOX::StatusTest::Unconverged.

const NOX::Abstract::Group & NOX::Solver::LineSearchBased::getSolutionGroup (  )  const [virtual]

Return a reference to the current solution group.

Implements NOX::Solver::Generic.

Definition at line 236 of file NOX_Solver_LineSearchBased.C.

References solnPtr.

const NOX::Abstract::Group & NOX::Solver::LineSearchBased::getPreviousSolutionGroup (  )  const [virtual]

Return a reference to the previous solution group.

Implements NOX::Solver::Generic.

Definition at line 242 of file NOX_Solver_LineSearchBased.C.

References oldSolnPtr.

Referenced by NOX::Direction::Broyden::compute(), and NOX::Direction::Broyden::doRestart().

int NOX::Solver::LineSearchBased::getNumIterations (  )  const [virtual]

Get number of iterations.

Implements NOX::Solver::Generic.

Definition at line 247 of file NOX_Solver_LineSearchBased.C.

References nIter.

Referenced by NOX::Direction::Broyden::compute(), and NOX::Direction::Broyden::doRestart().

const Teuchos::ParameterList & NOX::Solver::LineSearchBased::getList (  )  const [virtual]

Return a refernece to the solver parameters.

Implements NOX::Solver::Generic.

Definition at line 253 of file NOX_Solver_LineSearchBased.C.

References paramsPtr.

double NOX::Solver::LineSearchBased::getStepSize (  )  const [virtual]

void NOX::Solver::LineSearchBased::init (  )  [protected, virtual]

void NOX::Solver::LineSearchBased::printUpdate (  )  [protected, virtual]


Member Data Documentation

Pointer to the global data object.

Definition at line 157 of file NOX_Solver_LineSearchBased.H.

Referenced by init().

Utils.

Definition at line 160 of file NOX_Solver_LineSearchBased.H.

Referenced by init(), printUpdate(), and step().

Current solution.

Definition at line 163 of file NOX_Solver_LineSearchBased.H.

Referenced by getSolutionGroup(), printUpdate(), reset(), solve(), and step().

Previous solution pointer.

Definition at line 166 of file NOX_Solver_LineSearchBased.H.

Referenced by getPreviousSolutionGroup(), and step().

Current search direction pointer.

Definition at line 169 of file NOX_Solver_LineSearchBased.H.

Referenced by printUpdate(), and step().

Stopping test.

Definition at line 172 of file NOX_Solver_LineSearchBased.H.

Referenced by printUpdate(), reset(), and step().

Teuchos::RCP<Teuchos::ParameterList> NOX::Solver::LineSearchBased::paramsPtr [protected]

Input parameters.

Definition at line 175 of file NOX_Solver_LineSearchBased.H.

Referenced by getList(), init(), and solve().

Linesearch.

Definition at line 178 of file NOX_Solver_LineSearchBased.H.

Referenced by init(), and step().

Search Direction.

Definition at line 181 of file NOX_Solver_LineSearchBased.H.

Referenced by init(), and step().

Current step.

Definition at line 184 of file NOX_Solver_LineSearchBased.H.

Referenced by getStepSize(), init(), printUpdate(), and step().

Number of nonlinear iterations.

Definition at line 187 of file NOX_Solver_LineSearchBased.H.

Referenced by getNumIterations(), init(), printUpdate(), solve(), and step().

Status of nonlinear solver.

Definition at line 190 of file NOX_Solver_LineSearchBased.H.

Referenced by getStatus(), init(), printUpdate(), solve(), and step().

Type of check to use for status tests. See NOX::StatusTest for more details.

Definition at line 193 of file NOX_Solver_LineSearchBased.H.

Referenced by init(), and step().

Pointer to a user defined NOX::Abstract::PrePostOperator object.

Definition at line 196 of file NOX_Solver_LineSearchBased.H.

Referenced by solve(), and step().


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

Generated on Thu Dec 17 11:03:09 2009 for Nonlinear Solver Project by  doxygen 1.5.9