NOX::Multiphysics::Solver::Generic Class Reference

Abstract nonlinear solver method interface. More...

#include <NOX_Multiphysics_Solver_Generic.H>

Inheritance diagram for NOX::Multiphysics::Solver::Generic:

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

Public Member Functions

 Generic ()
 Constructor (does nothing).
virtual ~Generic ()
 Destructor (does nothing).
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)=0
 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, const Teuchos::RefCountPtr< Teuchos::ParameterList > &params)=0
 reset methods inherited from NOX::Solver::Generic and needed here to avoid hiding this overloaded virtual method
virtual bool reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp)=0
 An even softer reset of the nonlinear solver for a new problem.
virtual bool reset (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &tests)=0
 A soft reset of the nonlinear solver for a new problem.

Detailed Description

Abstract nonlinear solver method interface.

Defines the type of access methods into the iterative nonlinear solvers.


Member Function Documentation

virtual bool NOX::Multiphysics::Solver::Generic::reset const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp,
const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests
[pure 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::Solver::Generic.

Implemented in NOX::Multiphysics::Solver::FixedPointBased.

virtual bool NOX::Multiphysics::Solver::Generic::reset const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp  )  [pure 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::Solver::Generic.

Implemented in NOX::Multiphysics::Solver::FixedPointBased.

virtual bool NOX::Multiphysics::Solver::Generic::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
[pure 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.

Implemented in NOX::Multiphysics::Solver::FixedPointBased.


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