Simple dampended Newton solver using a Armijo line search :-) More...

#include <Thyra_DampenedNewtonNonlinearSolver.hpp>

Inheritance diagram for Thyra::DampenedNewtonNonlinearSolver< Scalar >:

Public Types
typedef Teuchos::ScalarTraits < Scalar >	ST

typedef ST::magnitudeType	ScalarMag

typedef Teuchos::ScalarTraits < ScalarMag >	SMT

Public Member Functions
	STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, defaultTol)
	The default solution tolerance. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (int, defaultMaxNewtonIterations)
	The default maximum number of iterations. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, useDampenedLineSearch)
	The default maximum number of iterations. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (Scalar, armijoConstant)
	Set the armijo constant for the line search. More...

	STANDARD_MEMBER_COMPOSITION_MEMBERS (int, maxLineSearchIterations)
	Set the maximum number of backtracking line search iterations to take. More...

	DampenedNewtonNonlinearSolver (const ScalarMag defaultTol=1e-2, const int defaultMaxNewtonIterations=1000, const bool useDampenedLineSearch=true, const Scalar armijoConstant=1e-4, const int maxLineSearchIterations=20)

Public Member Functions inherited from Thyra::NonlinearSolverBase< Scalar >
virtual bool	supportsCloning () const
	Return if this solver object supports cloning or not. More...

virtual RCP < NonlinearSolverBase< Scalar > >	cloneNonlinearSolver () const
	Clone the solver algorithm if supported. More...

Static Public Member Functions
static RCP< const Teuchos::ParameterList >	getValidSolveCriteriaExtraParameters ()

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< Scalar > > &model)

RCP< const ModelEvaluator < Scalar > >	getModel () const

SolveStatus< Scalar >	solve (VectorBase< Scalar > x, const SolveCriteria< Scalar > solveCriteria, VectorBase< Scalar > *delta)

RCP< const VectorBase< Scalar > >	get_current_x () const

bool	is_W_current () const

RCP< LinearOpWithSolveBase < Scalar > >	get_nonconst_W (const bool forceUpToDate)

RCP< const LinearOpWithSolveBase< Scalar > >	get_W () const

void	set_W_is_current (bool W_is_current)

Additional Inherited Members
Related Functions inherited from Thyra::NonlinearSolverBase< Scalar >
template<class Scalar >
const SolveStatus< Scalar >	solve (NonlinearSolverBase< Scalar > &nonlinearSolver, VectorBase< Scalar > x, const SolveCriteria< Scalar > solveCriteria=NULL, VectorBase< Scalar > *delta=NULL)

Detailed Description

template<class Scalar>
class Thyra::DampenedNewtonNonlinearSolver< Scalar >

Simple dampended Newton solver using a Armijo line search :-)

This class derives from Teuchos::VerboseObject and therefore will send output to *this->getOStream() if !Teuchos::isNull(this->getOStream()). The amount of output sent to *this->getOStream() depends on the verbosity level returned by this->getVerbLevel():

Teuchos::VERB_DEFAULT: Same as Teuchos::VERB_LOW.
Teuchos::VERB_NONE: Output nothing
Teuchos::VERB_LOW: Ouput only two lines of output for each Newton iteration
Teuchos::VERB_MEDIUM: Output lines for each Newton iteration and line search iteration
Teuchos::VERB_HIGH: Output more details about the Newton and line search iterations (good for basic debugging)
Teuchos::VERB_EXTREME: Dump all the matrices and vectors that are computed.

ToDo: Finish documentation.

Definition at line 48 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

Member Typedef Documentation

template<class Scalar >

typedef Teuchos::ScalarTraits<Scalar> Thyra::DampenedNewtonNonlinearSolver< Scalar >::ST

Definition at line 52 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

typedef ST::magnitudeType Thyra::DampenedNewtonNonlinearSolver< Scalar >::ScalarMag

Definition at line 54 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

typedef Teuchos::ScalarTraits<ScalarMag> Thyra::DampenedNewtonNonlinearSolver< Scalar >::SMT

Definition at line 56 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::DampenedNewtonNonlinearSolver	(	const ScalarMag	defaultTol = `1e-2`,
		const int	defaultMaxNewtonIterations = `1000`,
		const bool	useDampenedLineSearch = `true`,
		const Scalar	armijoConstant = `1e-4`,
		const int	maxLineSearchIterations = `20`
	)

Definition at line 144 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

Member Function Documentation

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	ScalarMag	,
		defaultTol
	)

The default solution tolerance.

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	int	,
		defaultMaxNewtonIterations
	)

The default maximum number of iterations.

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	bool	,
		useDampenedLineSearch
	)

The default maximum number of iterations.

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	Scalar	,
		armijoConstant
	)

Set the armijo constant for the line search.

template<class Scalar >

Thyra::DampenedNewtonNonlinearSolver< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS	(	int	,
		maxLineSearchIterations
	)

Set the maximum number of backtracking line search iterations to take.

template<class Scalar >

RCP< const Teuchos::ParameterList > Thyra::DampenedNewtonNonlinearSolver< Scalar >::getValidSolveCriteriaExtraParameters ( )

static

Definition at line 161 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

void Thyra::DampenedNewtonNonlinearSolver< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 176 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Thyra::DampenedNewtonNonlinearSolver< Scalar >::getNonconstParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 193 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

RCP< Teuchos::ParameterList > Thyra::DampenedNewtonNonlinearSolver< Scalar >::unsetParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 200 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Thyra::DampenedNewtonNonlinearSolver< Scalar >::getParameterList ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 209 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

RCP< const Teuchos::ParameterList > Thyra::DampenedNewtonNonlinearSolver< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 216 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

void Thyra::DampenedNewtonNonlinearSolver< Scalar >::setModel ( const RCP< const ModelEvaluator< Scalar > > & model )

virtual

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 233 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

RCP< const ModelEvaluator< Scalar > > Thyra::DampenedNewtonNonlinearSolver< Scalar >::getModel ( ) const

virtual

Implements Thyra::NonlinearSolverBase< Scalar >.

Definition at line 246 of file Thyra_DampenedNewtonNonlinearSolver.hpp.

template<class Scalar >

SolveStatus< Scalar > Thyra::DampenedNewtonNonlinearSolver< Scalar >::solve	(	VectorBase< Scalar > *	x,
		const SolveCriteria< Scalar > *	solveCriteria,
		VectorBase< Scalar > *	delta
	)