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:

Inheritance graph
[legend]
Collaboration diagram for NOX::Multiphysics::Solver::Manager:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Manager ()
 Empty constructor - reset called later to really construct it.
 Manager (const Teuchos::RCP< 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< 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)
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.

Protected Attributes

NOX::Multiphysics::Solver::GenericcplPtr
 Pointer to the coupling solver object.

Private Member Functions

virtual void deprecated (const string &oldName, const string &newName) const
 Print a warning message that oldName is deprecated and newName should be used instead.
virtual void checkNullPtr (const string &fname) const
 Check that ptr is non-null. If it is null, print a message that prints fname and throw an error.

Private Attributes

NOX::Utils utils
 Printing utilities.
string method
 Name of method being used.


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.

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)

Definition at line 76 of file NOX_Multiphysics_Solver_Manager.H.


Constructor & Destructor Documentation

NOX::Multiphysics::Solver::Manager::Manager (  ) 

Empty constructor - reset called later to really construct it.

Definition at line 69 of file NOX_Multiphysics_Solver_Manager.C.

NOX::Multiphysics::Solver::Manager::Manager ( const Teuchos::RCP< 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.

Definition at line 46 of file NOX_Multiphysics_Solver_Manager.C.

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.

Definition at line 58 of file NOX_Multiphysics_Solver_Manager.C.

NOX::Multiphysics::Solver::Manager::~Manager (  )  [virtual]

Destructor.

Definition at line 75 of file NOX_Multiphysics_Solver_Manager.C.

References cplPtr.


Member Function Documentation

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

Resets the solver and sets a new initial guess.

Implements NOX::Solver::Generic.

Definition at line 130 of file NOX_Multiphysics_Solver_Manager.C.

References cplPtr, and NOX::Multiphysics::Solver::Generic::reset().

NOX::StatusTest::StatusType NOX::Multiphysics::Solver::Manager::getStatus (  )  [virtual]

Check current convergence and failure status.

Implements NOX::Solver::Generic.

Definition at line 145 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::getStatus().

NOX::StatusTest::StatusType NOX::Multiphysics::Solver::Manager::step (  )  [virtual]

Do one nonlinear step in the iteration sequence and return status.

Implements NOX::Solver::Generic.

Definition at line 151 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::step().

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.

Definition at line 157 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::solve().

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

Return a reference to the current solution group.

Implements NOX::Solver::Generic.

Definition at line 163 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::getSolutionGroup().

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

Return a reference to the previous solution group.

Implements NOX::Solver::Generic.

Definition at line 169 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::getPreviousSolutionGroup().

int NOX::Multiphysics::Solver::Manager::getNumIterations (  )  const [virtual]

Get number of iterations.

Implements NOX::Solver::Generic.

Definition at line 175 of file NOX_Multiphysics_Solver_Manager.C.

References cplPtr, and NOX::Solver::Generic::getNumIterations().

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

Return a refernece to the solver parameters.

Implements NOX::Solver::Generic.

Definition at line 183 of file NOX_Multiphysics_Solver_Manager.C.

References checkNullPtr(), cplPtr, and NOX::Solver::Generic::getList().

void NOX::Multiphysics::Solver::Manager::deprecated ( const string &  oldName,
const string &  newName 
) const [private, virtual]

Print a warning message that oldName is deprecated and newName should be used instead.

Definition at line 136 of file NOX_Multiphysics_Solver_Manager.C.

References NOX::Utils::out(), and utils.

void NOX::Multiphysics::Solver::Manager::checkNullPtr ( const string &  fname  )  const [private, virtual]

Check that ptr is non-null. If it is null, print a message that prints fname and throw an error.

Definition at line 190 of file NOX_Multiphysics_Solver_Manager.C.

References cplPtr, NOX::Utils::out(), and utils.

Referenced by getList(), getPreviousSolutionGroup(), getSolutionGroup(), getStatus(), solve(), and step().


Member Data Documentation

Printing utilities.

Definition at line 143 of file NOX_Multiphysics_Solver_Manager.H.

Referenced by checkNullPtr(), and deprecated().

Name of method being used.

Definition at line 146 of file NOX_Multiphysics_Solver_Manager.H.

Pointer to the coupling solver object.

Definition at line 152 of file NOX_Multiphysics_Solver_Manager.H.

Referenced by checkNullPtr(), getList(), getNumIterations(), getPreviousSolutionGroup(), getSolutionGroup(), getStatus(), reset(), solve(), step(), and ~Manager().


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

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