NOX::Multiphysics::Solver::FixedPointBased Class Reference

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

#include <NOX_Multiphysics_Solver_FixedPointBased.H>

Inheritance diagram for NOX::Multiphysics::Solver::FixedPointBased:

[legend]
Collaboration diagram for NOX::Multiphysics::Solver::FixedPointBased:
[legend]
List of all members.

Public Types

enum  SOLVE_TYPE { JACOBI, SEIDEL }

Public Member Functions

 FixedPointBased (const Teuchos::RefCountPtr< vector< Teuchos::RefCountPtr< NOX::Solver::Manager > > > &solvers, const Teuchos::RefCountPtr< NOX::Multiphysics::DataExchange::Interface > &interface, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &params)
 Constructor.
virtual ~FixedPointBased ()
 Destructor.
virtual bool reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &params)
 reset methods inherited from NOX::Solver::Generic and needed here to avoid hiding this overloaded virtual method
virtual bool reset (const Teuchos::RefCountPtr< vector< Teuchos::RefCountPtr< NOX::Solver::Manager > > > &solvers, const Teuchos::RefCountPtr< NOX::Multiphysics::DataExchange::Interface > &interface, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &params)
 Reset the nonlinear solver for a new solve.
virtual bool reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests)
 A soft reset of the nonlinear solver for a new problem.
virtual bool reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp)
 An even softer reset of the nonlinear solver for a new problem.
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::GroupgetSolutionGroup () const
 Return a reference to the current solution group.
virtual const NOX::Abstract::GroupgetPreviousSolutionGroup () const
 Return a reference to the previous solution group.
virtual int getNumIterations () const
 Get number of iterations.
virtual const Teuchos::ParameterListgetList () 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 calcuate the RHS.
virtual void printUpdate ()
 Prints the current iteration information.

Protected Attributes

SOLVE_TYPE solveType
 Type of fixed-point solve to perform.
Teuchos::RefCountPtr< vector<
Teuchos::RefCountPtr< NOX::Solver::Manager > > > 
solversVecPtr
 Pointer to the container of solvers for each problem to be coupled.
Teuchos::RefCountPtr< NOX::Multiphysics::DataExchange::InterfacedataExInterface
 Pointer to the callback interface needed to echange data among solvers.
Teuchos::RefCountPtr< NOX::GlobalDataglobalDataPtr
 Pointer to the global data object.
Teuchos::RefCountPtr< NOX::UtilsutilsPtr
 Utils.
Teuchos::RefCountPtr< NOX::Multiphysics::GroupsolnPtr
 Current solution.
Teuchos::RefCountPtr< NOX::Multiphysics::GroupoldSolnPtr
 Previous solution pointer.
Teuchos::RefCountPtr< NOX::Abstract::VectordirPtr
 Current search direction pointer.
Teuchos::RefCountPtr< NOX::StatusTest::GenerictestPtr
 Stopping test.
Teuchos::RefCountPtr< Teuchos::ParameterListparamsPtr
 Input parameters.
NOX::LineSearch::Manager lineSearch
 Linesearch.
NOX::Direction::Manager direction
 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::Multiphysics::Solver::FixedPointBased::FixedPointBased const Teuchos::RefCountPtr< vector< Teuchos::RefCountPtr< NOX::Solver::Manager > > > &  solvers,
const Teuchos::RefCountPtr< NOX::Multiphysics::DataExchange::Interface > &  interface,
const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests,
const Teuchos::RefCountPtr< Teuchos::ParameterList > &  params
 

Constructor.

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


Member Function Documentation

bool NOX::Multiphysics::Solver::FixedPointBased::reset const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp  )  [virtual]
 

An even softer reset of the nonlinear solver for a new problem.

This is a light-weight version of reset that takes no parameter list or status tests. Therefore, this reset only resets counters and the initial guess (contained in the grp argument).

This reset allows problems to bypass the potentially time consuming parsing of the parameter lists and to re-use existing status tests.

Implements NOX::Multiphysics::Solver::Generic.

bool NOX::Multiphysics::Solver::FixedPointBased::reset const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp,
const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests
[virtual]
 

A soft reset of the nonlinear solver for a new problem.

This is a light-weight version of reset that takes no parameter list. Therefore, this reset only resets counters, the initial guess (contained in the grp argument) and new status tests (contained in the tests argument).

This reset allows problems to bypass the potentially time consuming parsing of the parameter lists.

Implements NOX::Multiphysics::Solver::Generic.

bool NOX::Multiphysics::Solver::FixedPointBased::reset const Teuchos::RefCountPtr< vector< Teuchos::RefCountPtr< NOX::Solver::Manager > > > &  solvers,
const Teuchos::RefCountPtr< NOX::Multiphysics::DataExchange::Interface > &  interface,
const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests,
const Teuchos::RefCountPtr< Teuchos::ParameterList > &  params
[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.

Implements NOX::Multiphysics::Solver::Generic.

NOX::StatusTest::StatusType NOX::Multiphysics::Solver::FixedPointBased::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.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:39 2008 for NOX by doxygen 1.3.9.1