Kaskade::DampedCovariantNewtonParameters Class Reference

Paramters that are used and Logged by GuardedCovariantNewtonMethod. More...

#include <newton_damped.hh>

Detailed Description

Paramters that are used and Logged by GuardedCovariantNewtonMethod.

Definition at line 52 of file newton_damped.hh.

Inheritance diagram for Kaskade::DampedCovariantNewtonParameters:

Classes
struct	LastRejected

Public Member Functions
	DampedCovariantNewtonParameters (double desiredAccuracy_, int maxSteps_, double minDampingFactor_=1e-12)
void	doForAll (LQAction::ToDo td)
	To be overloaded by derived class. More...
virtual void	reset ()
	Reset all quantities in this class. More...

Public Attributes
double	initDampingFactor
double	minDampingFactor
double	reduceOnOutsideDomain
double	dampingForDomain
double	relativeAccuracy
LoggedQuantity< double >	dampingFactor
LoggedQuantity< double >	SCorrByCorr
LoggedQuantity< double >	absoluteAccuracyLast
LoggedQuantity< double >	totalCorrection
LoggedQuantity< double >	lengthOfStep
LastRejected	lastrejected
double	maxContraction
LoggedQuantity< double >	omega0
LoggedQuantity< double >	omega
double	accuracyReached
bool	reuseFactorization
double	desiredAccuracy
int	maxSteps
int	termination

Protected Member Functions
void	logStep ()

Protected Attributes
LoggedQuantity< double >	Theta
LoggedQuantity< double >	normSCorr
LoggedQuantity< double >	normCorrLast
LoggedQuantity< double >	normCorr

Friends
class	DampedCovariantNewtonMethod

Constructor & Destructor Documentation

DampedCovariantNewtonParameters()

Kaskade::DampedCovariantNewtonParameters::DampedCovariantNewtonParameters ( double  desiredAccuracy_, int  maxSteps_, double  minDampingFactor_ = 1e-12  )

inline

Definition at line 55 of file newton_damped.hh.

Member Function Documentation

doForAll()

void Kaskade::DampedCovariantNewtonParameters::doForAll ( LQAction::ToDo  td )

inlinevirtual

To be overloaded by derived class.

For any LoggedQuantity quant, declared in the derived class, insert quant.doAction(td)

Reimplemented from Kaskade::GuardedCovariantNewtonParameters.

Reimplemented in Kaskade::ModifiedCovariantNewtonParameters.

Definition at line 68 of file newton_damped.hh.

Referenced by Kaskade::ModifiedCovariantNewtonParameters::doForAll().

logStep()

void Kaskade::NewtonParameters::logStep ( )

inlineprotectedinherited

Definition at line 45 of file newton_base.hh.

Referenced by Kaskade::NewtonsMethod::logQuantities().

reset()

virtual void Kaskade::NewtonParameters::reset ( )

inlinevirtualinherited

Reset all quantities in this class.

Reimplemented from Kaskade::IterationParameters.

Definition at line 35 of file newton_base.hh.

Referenced by DampedCovariantNewtonParameters(), Kaskade::GuardedCovariantNewtonParameters::GuardedCovariantNewtonParameters(), Kaskade::NewtonParameters::NewtonParameters(), and Kaskade::NewtonsMethod::resetParameters().

Friends And Related Function Documentation

DampedCovariantNewtonMethod

friend class DampedCovariantNewtonMethod

friend

Definition at line 66 of file newton_damped.hh.

Member Data Documentation

absoluteAccuracyLast

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::absoluteAccuracyLast

Definition at line 91 of file newton_damped.hh.

Referenced by doForAll().

accuracyReached

double Kaskade::GuardedCovariantNewtonParameters::accuracyReached

inherited

Definition at line 26 of file newton_damped.hh.

dampingFactor

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::dampingFactor

Definition at line 89 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonMethod::dampingFactor(), and doForAll().

dampingForDomain

double Kaskade::DampedCovariantNewtonParameters::dampingForDomain

Definition at line 85 of file newton_damped.hh.

Referenced by doForAll().

desiredAccuracy

double Kaskade::IterationParameters::desiredAccuracy

inherited

Definition at line 139 of file algorithm_base.hh.

Referenced by Kaskade::CompositeStep::setDesiredAccuracy(), Kaskade::HypIP::setDesiredAccuracy(), and Kaskade::NewtonsMethod::setDesiredAccuracy().

initDampingFactor

double Kaskade::DampedCovariantNewtonParameters::initDampingFactor

Definition at line 79 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonMethod::setDampingFactorStart().

lastrejected

LastRejected Kaskade::DampedCovariantNewtonParameters::lastrejected

Definition at line 101 of file newton_damped.hh.

Referenced by DampedCovariantNewtonParameters(), and doForAll().

lengthOfStep

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::lengthOfStep

Definition at line 93 of file newton_damped.hh.

Referenced by doForAll().

maxContraction

double Kaskade::GuardedCovariantNewtonParameters::maxContraction

inherited

Definition at line 23 of file newton_damped.hh.

maxSteps

int Kaskade::IterationParameters::maxSteps

inherited

Definition at line 140 of file algorithm_base.hh.

Referenced by Kaskade::CompositeStep::maxSteps(), Kaskade::HypIP::maxSteps(), and Kaskade::NewtonsMethod::maxSteps().

minDampingFactor

double Kaskade::DampedCovariantNewtonParameters::minDampingFactor

Definition at line 81 of file newton_damped.hh.

normCorr

LoggedQuantity<double> Kaskade::NewtonParameters::normCorr

protectedinherited

Definition at line 54 of file newton_base.hh.

Referenced by Kaskade::NewtonParameters::doForAll(), and Kaskade::StateConstraintsNewtonMethod::predictNextDampingFactor().

normCorrLast

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::normCorrLast

protectedinherited

Definition at line 43 of file newton_damped.hh.

Referenced by Kaskade::GuardedCovariantNewtonParameters::doForAll().

normSCorr

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::normSCorr

protectedinherited

Definition at line 42 of file newton_damped.hh.

Referenced by Kaskade::GuardedCovariantNewtonParameters::doForAll().

omega

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::omega

inherited

Definition at line 25 of file newton_damped.hh.

Referenced by Kaskade::GuardedCovariantNewtonParameters::doForAll().

omega0

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::omega0

inherited

Definition at line 24 of file newton_damped.hh.

Referenced by Kaskade::GuardedCovariantNewtonParameters::doForAll().

reduceOnOutsideDomain

double Kaskade::DampedCovariantNewtonParameters::reduceOnOutsideDomain

Definition at line 83 of file newton_damped.hh.

relativeAccuracy

double Kaskade::DampedCovariantNewtonParameters::relativeAccuracy

Definition at line 87 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonMethod::setDesiredRelativeAccuracy().

reuseFactorization

bool Kaskade::NewtonParameters::reuseFactorization

inherited

Definition at line 39 of file newton_base.hh.

Referenced by Kaskade::NewtonsMethod::resolve().

SCorrByCorr

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::SCorrByCorr

Definition at line 90 of file newton_damped.hh.

Referenced by doForAll().

termination

int Kaskade::IterationParameters::termination

inherited

Definition at line 141 of file algorithm_base.hh.

Theta

LoggedQuantity<double> Kaskade::GuardedCovariantNewtonParameters::Theta

protectedinherited

Definition at line 41 of file newton_damped.hh.

Referenced by Kaskade::GuardedCovariantNewtonParameters::doForAll().

totalCorrection

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::totalCorrection

Definition at line 92 of file newton_damped.hh.

Referenced by doForAll().

---

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

• newton_damped.hh