Playa::NewtonArmijoSolver< Scalar > Class Template Reference
#include <PlayaNewtonArmijoSolverDecl.hpp>
Inheritance diagram for Playa::NewtonArmijoSolver< Scalar >:
Public Types | |
| typedef Teuchos::ScalarTraits < Scalar >::magnitudeType | ScalarMag |
Public Member Functions | |
| NewtonArmijoSolver (const ParameterList ¶ms, const LinearSolver< Scalar > &linSolver) | |
| virtual | ~NewtonArmijoSolver () |
| SolverState< Scalar > | solve (const NonlinearOperator< Scalar > &F, Vector< Scalar > &soln) const |
| virtual Teuchos::RCP < NonlinearSolverBase< Scalar > > | getRcp () |
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 32 of file PlayaNewtonArmijoSolverDecl.hpp.
Member Typedef Documentation
template<class Scalar>
| typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Playa::NewtonArmijoSolver< Scalar >::ScalarMag |
Definition at line 36 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 29 of file PlayaNewtonArmijoSolverImpl.hpp.
template<class Scalar>
| virtual Playa::NewtonArmijoSolver< Scalar >::~NewtonArmijoSolver | ( | ) | [inline, virtual] |
Definition at line 43 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 52 of file PlayaNewtonArmijoSolverImpl.hpp.
template<class Scalar>
| virtual Teuchos::RCP< NonlinearSolverBase<Scalar> > Playa::NewtonArmijoSolver< Scalar >::getRcp | ( | ) | [inline, virtual] |
Handleable<NonlinearSolverBase<Scalar> > interface
Implements Playa::Handleable< NonlinearSolverBase< Scalar > >.
Definition at line 50 of file PlayaNewtonArmijoSolverDecl.hpp.
The documentation for this class was generated from the following files:
