NOX::Multiphysics::Solver::Manager Class Reference

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

#include <NOX_Multiphysics_Solver_Manager.H>

Inheritance diagram for NOX::Multiphysics::Solver::Manager:

Collaboration diagram for NOX::Multiphysics::Solver::Manager:

List of all members.

Public Member Functions
	Manager ()
	Empty constructor - reset called later to really construct it.
	Manager (const Teuchos::RCP< std::vector< Teuchos::RCP< NOX::Solver::Generic > > > &solvers, const Teuchos::RCP< NOX::Multiphysics::DataExchange::Interface > &i, const Teuchos::RCP< NOX::StatusTest::Generic > &t, const Teuchos::RCP< Teuchos::ParameterList > &p)
	Constructor.
	Manager (const Teuchos::RCP< NOX::Abstract::Group > &grp, const Teuchos::RCP< NOX::StatusTest::Generic > &t, const Teuchos::RCP< Teuchos::ParameterList > &p)
	Constructor.
virtual	~Manager ()
	Destructor.
virtual bool	reset (const Teuchos::RCP< std::vector< Teuchos::RCP< NOX::Solver::Generic > > > &solvers, const Teuchos::RCP< NOX::Multiphysics::DataExchange::Interface > &i, const Teuchos::RCP< NOX::StatusTest::Generic > &tests, const Teuchos::RCP< Teuchos::ParameterList > &params)
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 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 Attributes
NOX::Multiphysics::Solver::Generic *	cplPtr
	Pointer to the coupling solver object.

---

Detailed Description

Manager class to control the instantiation 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:

Russell Hooper (SNL 1416)

---

Constructor & Destructor Documentation

NOX::Multiphysics::Solver::Manager::Manager	(	const Teuchos::RCP< std::vector< Teuchos::RCP< NOX::Solver::Generic > > > &	solvers,
		const Teuchos::RCP< NOX::Multiphysics::DataExchange::Interface > &	i,
		const Teuchos::RCP< NOX::StatusTest::Generic > &	t,
		const Teuchos::RCP< Teuchos::ParameterList > &	p
	)

Constructor.

See reset() for a full description.

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

Constructor.

See reset() for a full description.

---

Member Function Documentation

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

---

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

• NOX_Multiphysics_Solver_Manager.H
• NOX_Multiphysics_Solver_Manager.C