NOX::Solver::Manager Class Reference

Manager class to control the instatiation of the objects derived from the NOX::Solver::Generic object. More...

#include <NOX_Solver_Manager.H>

Inheritance diagram for NOX::Solver::Manager:

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

Public Member Functions
	Manager ()
	Empty constructor - reset called later to really construct it.
	Manager (const Teuchos::RefCountPtr< NOX::Abstract::Group > &grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &t, const Teuchos::RefCountPtr< Teuchos::ParameterList > &p)
	Constructor.
virtual	~Manager ()
	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 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::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.
Protected Attributes
NOX::Utils	utils
	Printing utilities.
string	method
	Name of method being used.
NOX::Solver::Generic *	ptr
	Pointer to the solver object.

---

Detailed Description

Manager class to control the instatiation of the objects derived from the NOX::Solver::Generic object.

Parameters

The following entries may be specified in the parameter list.

• "Nonlinear %Solver" - Name of the solver method. Valid choices are
  • "Line Search Based" (NOX::Solver::LineSearchBased) [Default]
  • "Trust Region Based" (NOX::Solver::TrustRegionBased)

Deprecated:

The "Nonlinear %Solver" choices "Newton" and "Line Search" are deprecated and revert to "Line Search Based". Likewise, the choice "Trust Region" is deprecated and reverts to "Trust Region Based".

Author:

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

---

Constructor & Destructor Documentation

NOX::Solver::Manager::Manager (  const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  t, const Teuchos::RefCountPtr< Teuchos::ParameterList > &  p )

Constructor. See reset() for a full description. Reimplemented in NOX::Multiphysics::Solver::Manager.

---

Member Function Documentation

bool NOX::Solver::Manager::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::Solver::Generic. Reimplemented in NOX::Multiphysics::Solver::Manager.

bool NOX::Solver::Manager::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::Solver::Generic. Reimplemented in NOX::Multiphysics::Solver::Manager.

bool NOX::Solver::Manager::reset (  const Teuchos::RefCountPtr< NOX::Abstract::Group > &  grp, const Teuchos::RefCountPtr< NOX::StatusTest::Generic > &  tests, const Teuchos::RefCountPtr< Teuchos::ParameterList > &  params )  [virtual]

Reset the nonlinear solver for a new solve. Parameters: grp  On input, contains the intial guess. On output, contains the solution. 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::Solver::Generic. Reimplemented in NOX::Multiphysics::Solver::Manager.

NOX::StatusTest::StatusType NOX::Solver::Manager::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. Reimplemented in NOX::Multiphysics::Solver::Manager.

---

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

• NOX_Solver_Manager.H
• NOX_Solver_Manager.C

---