Kaskade::CompositeStep Class Reference

#include <composite_step.hh>

Detailed Description

Definition at line 233 of file composite_step.hh.

Inheritance diagram for Kaskade::CompositeStep:

Public Member Functions
virtual	~CompositeStep ()
	CompositeStep (NormalStep &normalStep_, TangentialStep &tangentialStep_, AbstractNorm &n, IterationParameters &p_)
	Create Newton's Method, providing a solver, a norm and algorithmic parameters. More...
void	solve (AbstractFunctional *f, 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
virtual NewtonsMethod::AcceptanceTest	evaluateTrialIterate (AbstractFunctionSpaceElement const &trialIterate, AbstractFunctionSpaceElement const &correction, AbstractLinearization const &lin)
virtual NewtonsMethod::Convergence	convergenceTest (AbstractFunctionSpaceElement const &correction, AbstractFunctionSpaceElement const &iterate)
	Return true, if convergence is detected, false otherwise. More...
virtual void	updateIterate (AbstractFunctionSpaceElement &iterate, AbstractFunctionSpaceElement &trialIterate, AbstractLinearization const &lin)
virtual NewtonsMethod::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

~CompositeStep()

virtual Kaskade::CompositeStep::~CompositeStep ( )

inlinevirtual

Definition at line 237 of file composite_step.hh.

CompositeStep()

Kaskade::CompositeStep::CompositeStep ( NormalStep &  normalStep_, TangentialStep &  tangentialStep_, AbstractNorm &  n, IterationParameters &  p_  )

inline

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

Definition at line 240 of file composite_step.hh.

Member Function Documentation

algorithmWrapper()

int Kaskade::Algorithm::algorithmWrapper ( )

protectedinherited

Run algorithm, completely with initialization and finalization.

convergenceTest()

virtual NewtonsMethod::Convergence Kaskade::CompositeStep::convergenceTest ( AbstractFunctionSpaceElement const &  correction, AbstractFunctionSpaceElement const &  iterate  )

protectedvirtual

Return true, if convergence is detected, false otherwise.

evaluateTrialIterate()

virtual NewtonsMethod::AcceptanceTest Kaskade::CompositeStep::evaluateTrialIterate ( AbstractFunctionSpaceElement const &  trialIterate, AbstractFunctionSpaceElement const &  correction, AbstractLinearization const &  lin  )

inlineprotectedvirtual

Definition at line 257 of file composite_step.hh.

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::CompositeStep::getParameters ( )

inlinevirtual

Definition at line 246 of file composite_step.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::CompositeStep::maxSteps ( )

inline

Definition at line 255 of file composite_step.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.

regularityTest()

virtual NewtonsMethod::RegularityTest Kaskade::CompositeStep::regularityTest ( double  scalingFactor )

inlineprotectedvirtual

Definition at line 274 of file composite_step.hh.

reportOnIteration()

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

inlineinherited

Definition at line 182 of file algorithm_base.hh.

resetParameters()

void Kaskade::CompositeStep::resetParameters ( )

inline

Reset all algorithmic parameters to their default values.

Definition at line 252 of file composite_step.hh.

setDesiredAccuracy()

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

inline

set the desired accuracy

Definition at line 248 of file composite_step.hh.

setDesiredRelativeAccuracy()

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

inlinevirtual

set the desired accuracy

Definition at line 250 of file composite_step.hh.

solve()

void Kaskade::CompositeStep::solve	(	AbstractFunctional *	f,
		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::CompositeStep::stepsPerformed ( )

inline

Definition at line 254 of file composite_step.hh.

terminationMessage()

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

protectedvirtual

Reimplemented from Kaskade::Algorithm.

updateIterate()

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

inlineprotectedvirtual

Definition at line 266 of file composite_step.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:

• composite_step.hh