Playa::NewtonArmijoSolver< Scalar > Class Template Reference

Inheritance diagram for Playa::NewtonArmijoSolver< Scalar >:

List of all members.

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag
Public Member Functions
	NewtonArmijoSolver (const ParameterList &params, const LinearSolver< Scalar > &linSolver)
virtual	~NewtonArmijoSolver ()
SolverState< Scalar >	solve (const NonlinearOperator< Scalar > &F, Vector< Scalar > &soln) const
Private Attributes
Handleable interface
LinearSolver< Scalar >	linSolver_
ScalarMag	tauR_
ScalarMag	tauA_
ScalarMag	alpha_
ScalarMag	stepReduction_
int	maxIters_
int	maxLineSearch_
int	verb_

---

Detailed Description

template<class Scalar>
class Playa::NewtonArmijoSolver< Scalar >

Playa implementation of Newton's method with Armijo line search.

The solver's behavior is controlled by parameters in a ParameterList.

• Scalar "Tau Relative" tolerance for relative error. Default value: 10 times machine epsilon
• Scalar "Tau Absolute" tolerance for absolute error. Default value 10 times machine epsilon
• Scalar "Alpha" constant in Armijo sufficient decrease condition. Default value 1.0e-4
• double "Step Reduction" factor by which to reduce step during line search. Default value: 0.5
• int "Max Iterations" number of iterations to allow before failure. Default value 20.
• int "Max Backtracks" number of step reductions to allow before failure. Default value 20.
• int "Verbosity" amount of diagnostic output. Default value 0.

Definition at line 69 of file PlayaNewtonArmijoSolverDecl.hpp.

---

Member Typedef Documentation

template<class Scalar>

typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Playa::NewtonArmijoSolver< Scalar >::ScalarMag

Definition at line 73 of file PlayaNewtonArmijoSolverDecl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver	(	const ParameterList &	params,
		const LinearSolver< Scalar > &	linSolver
	)		[inline]

Definition at line 66 of file PlayaNewtonArmijoSolverImpl.hpp.

References Playa::NewtonArmijoSolver< Scalar >::alpha_, Playa::NewtonArmijoSolver< Scalar >::maxIters_, Playa::NewtonArmijoSolver< Scalar >::maxLineSearch_, Playa::NewtonArmijoSolver< Scalar >::stepReduction_, Playa::NewtonArmijoSolver< Scalar >::tauA_, Playa::NewtonArmijoSolver< Scalar >::tauR_, and Playa::NewtonArmijoSolver< Scalar >::verb_.

template<class Scalar>

virtual Playa::NewtonArmijoSolver< Scalar >::~NewtonArmijoSolver

(

)

[inline, virtual]

Definition at line 80 of file PlayaNewtonArmijoSolverDecl.hpp.

---

Member Function Documentation

template<class Scalar >

SolverState< Scalar > Playa::NewtonArmijoSolver< Scalar >::solve	(	const NonlinearOperator< Scalar > &	F,
		Vector< Scalar > &	soln
	)		const [inline, virtual]

Implements Playa::NonlinearSolverBase< Scalar >.

Definition at line 89 of file PlayaNewtonArmijoSolverImpl.hpp.

References Playa::Vector< Scalar >::copy(), Playa::NonlinearOperator< Scalar >::currentEvalPt(), Playa::SolverState< Scalar >::finalMsg(), Playa::SolverState< Scalar >::finalState(), Playa::NonlinearOperator< Scalar >::getFunctionValue(), Playa::NonlinearOperator< Scalar >::getInitialGuess(), Playa::NonlinearOperator< Scalar >::getJacobian(), Playa::Vector< Scalar >::norm2(), PLAYA_MSG1, PLAYA_MSG2, PLAYA_MSG3, Playa::NonlinearOperator< Scalar >::setEvalPt(), Playa::SolveConverged, Playa::SolveCrashed, Playa::SolveFailedToConverge, and Teuchos::toString().

---

Member Data Documentation

template<class Scalar>

ScalarMag Playa::NewtonArmijoSolver< Scalar >::alpha_ [private]

Definition at line 93 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

LinearSolver<Scalar> Playa::NewtonArmijoSolver< Scalar >::linSolver_ [private]

Definition at line 90 of file PlayaNewtonArmijoSolverDecl.hpp.

template<class Scalar>

int Playa::NewtonArmijoSolver< Scalar >::maxIters_ [private]

Definition at line 95 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

int Playa::NewtonArmijoSolver< Scalar >::maxLineSearch_ [private]

Definition at line 96 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

ScalarMag Playa::NewtonArmijoSolver< Scalar >::stepReduction_ [private]

Definition at line 94 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

ScalarMag Playa::NewtonArmijoSolver< Scalar >::tauA_ [private]

Definition at line 92 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

ScalarMag Playa::NewtonArmijoSolver< Scalar >::tauR_ [private]

Definition at line 91 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().

template<class Scalar>

int Playa::NewtonArmijoSolver< Scalar >::verb_ [private]

Definition at line 97 of file PlayaNewtonArmijoSolverDecl.hpp.

Referenced by Playa::NewtonArmijoSolver< Scalar >::NewtonArmijoSolver().