NumLib::DampingPolicy Class Reference

Detailed Description

Optional plug-in for FixedDampingStrategy: given the current iterate and the proposed Newton update, return a (possibly reduced) damping factor. A null pointer means "no extra clamping"; the strategy uses its base damping unchanged.

Definition at line 14 of file DampingPolicy.h.

#include <DampingPolicy.h>

Inheritance diagram for NumLib::DampingPolicy:

Public Member Functions
virtual double	apply (GlobalVector const &minus_delta_x, GlobalVector const &x, double const base_damping) const =0
virtual	~DampingPolicy ()=default

Constructor & Destructor Documentation

~DampingPolicy()

virtual NumLib::DampingPolicy::~DampingPolicy ( )

virtualdefault

Member Function Documentation

apply()

virtual double NumLib::DampingPolicy::apply ( GlobalVector const & minus_delta_x, GlobalVector const & x, double const base_damping ) const

pure virtual

Implemented in NumLib::ConvergenceCriterionPerComponentDeltaX, and NumLib::ConvergenceCriterionPerComponentResidual.

---

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

• DampingPolicy.h