ptems::DampingParameters< real_type > Struct Template Reference

Specifies the damping parameters for damped Newton. More...

#include <ptems/solvers/nonlinearsolver.hpp>

Public Member Functions
	DampingParameters (real_type initial, real_type increment, real_type minimum)
	Creates the damping Newton parameters. More...

Public Attributes
real_type	Initial
	The initial damping parameter. More...
real_type	Increment
	The increment for the damping parameter. More...
real_type	Minimum
	The minimum value for the damping parameter. More...

Detailed Description

template<typename real_type>
struct ptems::DampingParameters< real_type >

Specifies the damping parameters for damped Newton.

Template Parameters

real_type

The real-valued type for the parameters (underlying type of the nonlinear system)

Constructor & Destructor Documentation

DampingParameters()

template<typename real_type >

ptems::DampingParameters< real_type >::DampingParameters ( real_type  initial, real_type  increment, real_type  minimum  )

inline

Creates the damping Newton parameters.

Parameters

initial	The initial damping parameter
increment	The increment for the damping parameter
minimum	The minimum value for the damping parameter

Member Data Documentation

Increment

template<typename real_type >

real_type ptems::DampingParameters< real_type >::Increment

The increment for the damping parameter.

Initial

template<typename real_type >

real_type ptems::DampingParameters< real_type >::Initial

The initial damping parameter.

Minimum

template<typename real_type >

real_type ptems::DampingParameters< real_type >::Minimum

The minimum value for the damping parameter.

---

The documentation for this struct was generated from the following file:

• ptems/solvers/nonlinearsolver.hpp