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:

[legend]

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)
virtual void	reset (const NOX::Abstract::Vector &initialGuess)
	Resets the solver and sets a new initial guess.
virtual void	reset ()
	Resets the solver for another solve. This resets the counters and status only. Uses the final solution from the last solve as the initial guess for the next solve.
virtual NOX::StatusTest::StatusType	getStatus () const
	Returns the current status of the solver.
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.
Public Member Functions inherited from NOX::Solver::Generic
	Generic ()
	Constructor (does nothing).
virtual	~Generic ()
	Destructor (does nothing).
virtual void	reset (const NOX::Abstract::Vector &initial_guess, const Teuchos::RCP< NOX::StatusTest::Generic > &test)=0
	Resets the solver, sets a new status test, and sets a new initial guess.
virtual Teuchos::RCP< const NOX::SolverStats >	getSolverStatistics () const =0
	Return a RCP to the solver statistics.

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

◆ Manager() [1/2]

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.

References cplPtr, and reset().

◆ Manager() [2/2]

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.

References cplPtr.

Member Function Documentation

◆ getList()

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

virtual

Return a reference to the solver parameters.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getListPtr()

Teuchos::RCP< const Teuchos::ParameterList > NOX::Multiphysics::Solver::Manager::getListPtr ( ) const

virtual

Return a RCP to the solver parameters.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getNumIterations()

int NOX::Multiphysics::Solver::Manager::getNumIterations ( ) const

virtual

Get number of iterations.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getPreviousSolutionGroup()

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

virtual

Return a reference to the previous solution group.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getPreviousSolutionGroupPtr()

Teuchos::RCP< const NOX::Abstract::Group > NOX::Multiphysics::Solver::Manager::getPreviousSolutionGroupPtr ( ) const

virtual

Return a RCP to the previous solution group.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getSolutionGroup()

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

virtual

Return a reference to the current solution group.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getSolutionGroupPtr()

Teuchos::RCP< const NOX::Abstract::Group > NOX::Multiphysics::Solver::Manager::getSolutionGroupPtr ( ) const

virtual

Return a RCP to the solution group.

Implements NOX::Solver::Generic.

References cplPtr.

◆ getStatus()

NOX::StatusTest::StatusType NOX::Multiphysics::Solver::Manager::getStatus ( ) const

virtual

Returns the current status of the solver.

Implements NOX::Solver::Generic.

References cplPtr.

◆ reset() [1/2]

void NOX::Multiphysics::Solver::Manager::reset ( )

virtual

Resets the solver for another solve. This resets the counters and status only. Uses the final solution from the last solve as the initial guess for the next solve.

NOTE: All NOX solvers will call reset() automatically at teh beginning of the solve() method. We add the reset() method to the solver interface for the application to call in case the application needs to reset counters and status manually before the next call to solve() is made.

Implements NOX::Solver::Generic.

Referenced by Manager().

◆ reset() [2/2]

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.

References cplPtr.

◆ solve()

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.

References cplPtr.

◆ step()

NOX::StatusTest::StatusType NOX::Multiphysics::Solver::Manager::step ( )

virtual

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

Implements NOX::Solver::Generic.

References cplPtr.

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

NOX_Multiphysics_Solver_Manager.H
NOX_Multiphysics_Solver_Manager.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Manager() [1/2]

◆ Manager() [2/2]

Member Function Documentation

◆ getList()

◆ getListPtr()

◆ getNumIterations()

◆ getPreviousSolutionGroup()

◆ getPreviousSolutionGroupPtr()

◆ getSolutionGroup()

◆ getSolutionGroupPtr()

◆ getStatus()

◆ reset() [1/2]

◆ reset() [2/2]

◆ solve()

◆ step()