Kaskade::ModifiedCovariantNewtonParameters Class Reference

#include <newton_damped.hh>

Detailed Description

Definition at line 154 of file newton_damped.hh.

Inheritance diagram for Kaskade::ModifiedCovariantNewtonParameters:

Public Member Functions
	ModifiedCovariantNewtonParameters (double desiredAccuracy_, int maxSteps_, double ThetaMaxAllowed_, double mdf_=1e-12)
virtual void	reset ()
	Reset all quantities in this class. More...

Public Attributes
double	initDampingFactor
double	minDampingFactor
double	reduceOnOutsideDomain
double	dampingForDomain
LoggedQuantity< double >	dampingFactor
LoggedQuantity< double >	SCorrByCorr
LoggedQuantity< double >	absoluteAccuracyLast
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
virtual void	doForAll (LQAction::ToDo td)
	To be overloaded by derived class. More...
void	logStep ()

Protected Attributes
LoggedQuantity< double >	Theta0
LoggedQuantity< double >	normModCorr
LoggedQuantity< double >	normModSCorr
LoggedQuantity< double >	totalCorrection
double	relativeAccuracy
double	ThetaMaxAllowed
LoggedQuantity< double >	Theta
LoggedQuantity< double >	normSCorr
LoggedQuantity< double >	normCorrLast
LoggedQuantity< double >	normCorr

Friends
class	ModifiedCovariantNewtonMethod
class	StateConstraintsNewtonMethod

Constructor & Destructor Documentation

ModifiedCovariantNewtonParameters()

Kaskade::ModifiedCovariantNewtonParameters::ModifiedCovariantNewtonParameters ( double  desiredAccuracy_, int  maxSteps_, double  ThetaMaxAllowed_, double  mdf_ = 1e-12  )

inline

Definition at line 157 of file newton_damped.hh.

Member Function Documentation

doForAll()

virtual void Kaskade::ModifiedCovariantNewtonParameters::doForAll ( LQAction::ToDo  td )

inlineprotectedvirtual

To be overloaded by derived class.

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

Reimplemented from Kaskade::DampedCovariantNewtonParameters.

Definition at line 165 of file newton_damped.hh.

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 Kaskade::DampedCovariantNewtonParameters::DampedCovariantNewtonParameters(), Kaskade::GuardedCovariantNewtonParameters::GuardedCovariantNewtonParameters(), Kaskade::NewtonParameters::NewtonParameters(), and Kaskade::NewtonsMethod::resetParameters().

Friends And Related Function Documentation

ModifiedCovariantNewtonMethod

friend class ModifiedCovariantNewtonMethod

friend

Definition at line 162 of file newton_damped.hh.

StateConstraintsNewtonMethod

friend class StateConstraintsNewtonMethod

friend

Definition at line 163 of file newton_damped.hh.

Member Data Documentation

absoluteAccuracyLast

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::absoluteAccuracyLast

inherited

Definition at line 91 of file newton_damped.hh.

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

accuracyReached

double Kaskade::GuardedCovariantNewtonParameters::accuracyReached

inherited

Definition at line 26 of file newton_damped.hh.

dampingFactor

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::dampingFactor

inherited

Definition at line 89 of file newton_damped.hh.

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

dampingForDomain

double Kaskade::DampedCovariantNewtonParameters::dampingForDomain

inherited

Definition at line 85 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::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

inherited

Definition at line 79 of file newton_damped.hh.

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

lastrejected

LastRejected Kaskade::DampedCovariantNewtonParameters::lastrejected

inherited

Definition at line 101 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::DampedCovariantNewtonParameters(), and Kaskade::DampedCovariantNewtonParameters::doForAll().

lengthOfStep

LoggedQuantity<double> Kaskade::DampedCovariantNewtonParameters::lengthOfStep

inherited

Definition at line 93 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::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

inherited

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().

normModCorr

LoggedQuantity<double> Kaskade::ModifiedCovariantNewtonParameters::normModCorr

protected

Definition at line 174 of file newton_damped.hh.

Referenced by doForAll().

normModSCorr

LoggedQuantity<double> Kaskade::ModifiedCovariantNewtonParameters::normModSCorr

protected

Definition at line 175 of file newton_damped.hh.

Referenced by 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

inherited

Definition at line 83 of file newton_damped.hh.

relativeAccuracy

double Kaskade::ModifiedCovariantNewtonParameters::relativeAccuracy

protected

Definition at line 177 of file newton_damped.hh.

Referenced by Kaskade::StateConstraintsNewtonMethod::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

inherited

Definition at line 90 of file newton_damped.hh.

Referenced by Kaskade::DampedCovariantNewtonParameters::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().

Theta0

LoggedQuantity<double> Kaskade::ModifiedCovariantNewtonParameters::Theta0

protected

Definition at line 173 of file newton_damped.hh.

Referenced by doForAll().

ThetaMaxAllowed

double Kaskade::ModifiedCovariantNewtonParameters::ThetaMaxAllowed

protected

Definition at line 177 of file newton_damped.hh.

totalCorrection

LoggedQuantity<double> Kaskade::ModifiedCovariantNewtonParameters::totalCorrection

protected

Definition at line 176 of file newton_damped.hh.

Referenced by doForAll().

---

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

• newton_damped.hh