Kaskade::HypIP Class Reference

#include <hyp_ip.hh>

Detailed Description

Definition at line 62 of file hyp_ip.hh.

Inheritance diagram for Kaskade::HypIP:

Public Member Functions
virtual	~HypIP ()
	HypIP (SearchSpaceCreator &searchSpace_, AbstractScalarProduct &nL, AbstractScalarProduct &nC, AbstractChart &chart_, HypIPParameters &p_, int dimx_, AbstractAdaptiveGrid *grid_=0, AbstractCompositeStepErrorEstimator *errorEstimator_=0)
	Create Newton's Method, providing a solver, a norm and algorithmic parameters. More...
void	solve (AbstractFunctional *fN, AbstractFunctional *fT, AbstractFunctionSpaceElement &x)
	Solve the system f=0 with starting value x. On (successful) exit, the solution is x, otherwise it is left unmodified. More...
virtual IterationParameters const &	getParameters ()
void	setDesiredAccuracy (double da)
	set the desired accuracy More...
virtual void	setDesiredRelativeAccuracy (double ra)
	set the desired accuracy More...
void	resetParameters ()
	Reset all algorithmic parameters to their default values. More...
int	stepsPerformed ()
int	maxSteps ()
void	performTiming (bool doit)
void	reportOnIteration (int level)

Protected Member Functions
void	dampingLoop ()
int	refinementLoop ()
virtual AcceptanceTest	evaluateCorrection (AbstractFunctionSpaceElement &correction, AbstractLinearization &lin, CUBThetaModelFunction &mF, double f0, std::vector< double > &coeff)
virtual Convergence	convergenceTest (AbstractFunctionSpaceElement const &correction, AbstractFunctionSpaceElement const &iterate, std::vector< double > &coeff)
	Return true, if convergence is detected, false otherwise. More...
virtual void	updateIterate (AbstractFunctionSpaceElement &iterate, AbstractFunctionSpaceElement &trialIterate, AbstractLinearization const &lin)
virtual RegularityTest	regularityTest (double scalingFactor)
void	terminationMessage (int flag)
virtual void	initialize ()
virtual void	finalize (int)
int	algorithmWrapper ()
	Run algorithm, completely with initialization and finalization. More...
int	oneStepWrapper ()
	Run one step of algorithm. More...

Protected Attributes
int	report

Constructor & Destructor Documentation

~HypIP()

virtual Kaskade::HypIP::~HypIP ( )

inlinevirtual

Definition at line 66 of file hyp_ip.hh.

HypIP()

Kaskade::HypIP::HypIP ( SearchSpaceCreator &  searchSpace_, AbstractScalarProduct &  nL, AbstractScalarProduct &  nC, AbstractChart &  chart_, HypIPParameters &  p_, int  dimx_, AbstractAdaptiveGrid *  grid_ = 0, AbstractCompositeStepErrorEstimator *  errorEstimator_ = 0  )

inline

Create Newton's Method, providing a solver, a norm and algorithmic parameters.

Definition at line 69 of file hyp_ip.hh.

Member Function Documentation

algorithmWrapper()

int Kaskade::Algorithm::algorithmWrapper ( )

protectedinherited

Run algorithm, completely with initialization and finalization.

convergenceTest()

virtual Convergence Kaskade::HypIP::convergenceTest ( AbstractFunctionSpaceElement const &  correction, AbstractFunctionSpaceElement const &  iterate, std::vector< double > &  coeff  )

protectedvirtual

Return true, if convergence is detected, false otherwise.

dampingLoop()

void Kaskade::HypIP::dampingLoop ( )

protected

evaluateCorrection()

virtual AcceptanceTest Kaskade::HypIP::evaluateCorrection ( AbstractFunctionSpaceElement &  correction, AbstractLinearization &  lin, CUBThetaModelFunction &  mF, double  f0, std::vector< double > &  coeff  )

protectedvirtual

finalize()

virtual void Kaskade::Algorithm::finalize ( int  )

inlineprotectedvirtualinherited

Reimplemented in Kaskade::SimpleAdaptiveRefinement, Kaskade::TestErrorEstimator, and Kaskade::NewtonsMethod.

Definition at line 186 of file algorithm_base.hh.

getParameters()

virtual IterationParameters const & Kaskade::HypIP::getParameters ( )

inlinevirtual

Definition at line 79 of file hyp_ip.hh.

initialize()

virtual void Kaskade::Algorithm::initialize ( )

inlineprotectedvirtualinherited

Reimplemented in Kaskade::SimpleAdaptiveRefinement, Kaskade::TestErrorEstimator, Kaskade::HomotopyBase, Kaskade::InteriorPointSqrtModel, Kaskade::InteriorPointSlopeEstimate, Kaskade::NewtonsMethod, Kaskade::DampedCovariantNewtonMethod, and Kaskade::StateConstraintsNewtonMethod.

Definition at line 185 of file algorithm_base.hh.

maxSteps()

int Kaskade::HypIP::maxSteps ( )

inline

Definition at line 88 of file hyp_ip.hh.

oneStepWrapper()

int Kaskade::Algorithm::oneStepWrapper ( )

protectedinherited

Run one step of algorithm.

performTiming()

void Kaskade::Algorithm::performTiming ( bool  doit )

inlineinherited

Definition at line 181 of file algorithm_base.hh.

refinementLoop()

int Kaskade::HypIP::refinementLoop ( )

protected

regularityTest()

virtual RegularityTest Kaskade::HypIP::regularityTest ( double  scalingFactor )

inlineprotectedvirtual

Definition at line 120 of file hyp_ip.hh.

reportOnIteration()

void Kaskade::Algorithm::reportOnIteration ( int  level )

inlineinherited

Definition at line 182 of file algorithm_base.hh.

resetParameters()

void Kaskade::HypIP::resetParameters ( )

inline

Reset all algorithmic parameters to their default values.

Definition at line 85 of file hyp_ip.hh.

setDesiredAccuracy()

void Kaskade::HypIP::setDesiredAccuracy ( double  da )

inline

set the desired accuracy

Definition at line 81 of file hyp_ip.hh.

setDesiredRelativeAccuracy()

virtual void Kaskade::HypIP::setDesiredRelativeAccuracy ( double  ra )

inlinevirtual

set the desired accuracy

Definition at line 83 of file hyp_ip.hh.

solve()

void Kaskade::HypIP::solve	(	AbstractFunctional *	fN,
		AbstractFunctional *	fT,
		AbstractFunctionSpaceElement &	x
	)

Solve the system f=0 with starting value x. On (successful) exit, the solution is x, otherwise it is left unmodified.

stepsPerformed()

int Kaskade::HypIP::stepsPerformed ( )

inline

Definition at line 87 of file hyp_ip.hh.

terminationMessage()

void Kaskade::HypIP::terminationMessage ( int  flag )

protectedvirtual

Reimplemented from Kaskade::Algorithm.

updateIterate()

virtual void Kaskade::HypIP::updateIterate ( AbstractFunctionSpaceElement &  iterate, AbstractFunctionSpaceElement &  trialIterate, AbstractLinearization const &  lin  )

inlineprotectedvirtual

Definition at line 111 of file hyp_ip.hh.

Member Data Documentation

report

int Kaskade::Algorithm::report

protectedinherited

Definition at line 193 of file algorithm_base.hh.

Referenced by Kaskade::Algorithm::reportOnIteration().

---

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

• hyp_ip.hh