Thyra::NOXNonlinearSolver Class Reference

Concrete nonlinear solver for NOX. More...

#include <Thyra_NonlinearSolver_NOX.hpp>

Inheritance diagram for Thyra::NOXNonlinearSolver:

Collaboration diagram for Thyra::NOXNonlinearSolver:

Public Member Functions
void	setBasePoint (const ModelEvaluatorBase::InArgs< double > &modelInArgs)
void	setPrecOp (const Teuchos::RCP< ::Thyra::PreconditionerBase< double >> &precOp, const Teuchos::RCP< ::Thyra::PreconditionerFactoryBase< double >> &precFactory=Teuchos::null, const bool updatePreconditioner=true)
	Users can optionally set the preconditioner. More...
void	setGroup (const Teuchos::RCP< NOX::Abstract::Group > &group)
	Power user function to set the NOX solution Group. Normally, this will be created automatically but there are exceptional use cases where we need to set manually. More...
RCP< const NOX::Solver::Generic >	getNOXSolver () const
void	resetSolver ()
	Called to rebuild the solver if a new parameter list is set.
Overridden from ParameterListAcceptor
void	setParameterList (RCP< Teuchos::ParameterList > const &paramList)
RCP< Teuchos::ParameterList >	getNonconstParameterList ()
RCP< Teuchos::ParameterList >	unsetParameterList ()
RCP< const Teuchos::ParameterList >	getParameterList () const
RCP< const Teuchos::ParameterList >	getValidParameters () const
Overridden from NonlinearSolverBase
void	setModel (const RCP< const ModelEvaluator< double > > &model)
RCP< const ModelEvaluator < double > >	getModel () const
SolveStatus< double >	solve (VectorBase< double > *x, const SolveCriteria< double > *solveCriteria=nullptr, VectorBase< double > *delta=nullptr)
RCP< const VectorBase< double > >	get_current_x () const
bool	is_W_current () const
RCP< LinearOpWithSolveBase < double > >	get_nonconst_W (const bool forceUpToDate)
RCP< const LinearOpWithSolveBase< double > >	get_W () const
RCP< const LinearOpBase< double > >	get_W_op () const
RCP< LinearOpBase< double > >	get_nonconst_W_op (const bool forceUpToDate)
RCP< const PreconditionerBase < double > >	get_prec_op () const
RCP< PreconditionerBase< double > >	get_nonconst_prec_op ()

Detailed Description

Concrete nonlinear solver for NOX.

This class implemets a NOX nonlinear solver of type <double>.

Member Function Documentation

void Thyra::NOXNonlinearSolver::setGroup

(

const Teuchos::RCP< NOX::Abstract::Group > &

group

)

Power user function to set the NOX solution Group. Normally, this will be created automatically but there are exceptional use cases where we need to set manually.

Parameters

[in]

group

The nox group with the initial guess

void Thyra::NOXNonlinearSolver::setPrecOp	(	const Teuchos::RCP< ::Thyra::PreconditionerBase< double >> &	precOp,
		const Teuchos::RCP< ::Thyra::PreconditionerFactoryBase< double >> &	precFactory = Teuchos::null,
		const bool	updatePreconditioner = true
	)

Users can optionally set the preconditioner.

Parameters

[in]	precOp	The preconditioner operator
[in]	precFactory	Optional preconditioner factory
[in]	updatePreconditioner	Optional flag, if true the Group will automatically update the preconditioner using precFactory or model evalautor

References nonnull(), and TEUCHOS_TEST_FOR_EXCEPTION.

---

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

• Thyra_NonlinearSolver_NOX.hpp
• Thyra_NonlinearSolver_NOX.cpp