LOCA::Stepper Class Reference

Implementation of LOCA::Abstract::Iterator for computing points along a continuation curve. More...

#include <LOCA_Stepper.H>

Inheritance diagram for LOCA::Stepper:

[legend]Collaboration diagram for LOCA::Stepper:[legend]List of all members.

Public Member Functions
	Stepper (LOCA::Continuation::AbstractGroup &initialGuess, NOX::StatusTest::Generic &t, NOX::Parameter::List &p)
	Constructor.
virtual	~Stepper ()
	Destructor.
virtual bool	reset (LOCA::Continuation::AbstractGroup &initialGuess, NOX::StatusTest::Generic &t, NOX::Parameter::List &p)
	Reset the Stepper to start a new continuation run.
virtual LOCA::Continuation::AbstractGroup &	getSolutionGroup ()
	Return the current solution group.
virtual LOCA::Continuation::AbstractGroup &	getBifurcationGroup ()
	Return the current bifurcation group.
virtual const NOX::Parameter::List &	getParameterList () const
	Return the output parameters from the stepper algorithm.
virtual const NOX::Solver::Generic &	getSolver () const
	Return the current nonlinear solver pointer.
Protected Member Functions
	Stepper (const Stepper &s)
	Copy Constructor: Not implemented, but put here to prevent compiler form generating one.
virtual LOCA::Abstract::Iterator::IteratorStatus	start ()
	Intialize iterator.
virtual LOCA::Abstract::Iterator::IteratorStatus	finish (LOCA::Abstract::Iterator::IteratorStatus iteratorStatus)
	Finalize iterator.
virtual LOCA::Abstract::Iterator::StepStatus	preprocess (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Preprocess step.
virtual LOCA::Abstract::Iterator::StepStatus	compute (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Compute step.
virtual LOCA::Abstract::Iterator::StepStatus	postprocess (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Postprocess step.
virtual LOCA::Abstract::Iterator::IteratorStatus	stop (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Check stopping criteria.
LOCA::Abstract::Iterator::StepStatus	computeStepSize (LOCA::Abstract::Iterator::StepStatus stepStatus, double &stepSize)
	Compute a new step size based on results from the previous step.
virtual void	printInitializationInfo ()
	Print to the screen the initialization information.
virtual void	printStartStep ()
	Print to the screen information for the beginning of a new continuation step.
virtual void	printEndStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Print to the screen information for the end of a successful continuation step.
virtual void	printEndInfo ()
	Print to the screen the concluding information.
virtual bool	withinThreshold ()
	Checks to see if continuation parameter is within threshold of bound.
Protected Attributes
LOCA::Bifurcation::Manager *	bifGroupManagerPtr
	Bifurcation group manager.
LOCA::Continuation::AbstractGroup *	bifGroupPtr
	Pointer to bifurcation group.
LOCA::Continuation::Manager *	conGroupManagerPtr
	Continuation group manager.
LOCA::Continuation::ExtendedGroup *	curGroupPtr
	Pointer to the Group with the initial guess for the nonlinear solver. This is used for resetting the nonlinear solver in between successful steps.
LOCA::Continuation::ExtendedGroup *	prevGroupPtr
	Pointer to the a Group with the solution for the previous continuation step. This is used for resetting the nonlinear solver in between failed steps.
NOX::StatusTest::Generic *	statusTestPtr
	Pointer to the status test.
NOX::Parameter::List *	paramListPtr
	Pointer to parameter list passed in constructor/reset method.
NOX::Solver::Manager *	solverPtr
	Solver (a.k.a corrector).
LOCA::Predictor::Manager *	predictorManagerPtr
	Predictor.
LOCA::Continuation::ExtendedVector *	curPredictorPtr
	Current predictor direction.
LOCA::Continuation::ExtendedVector *	prevPredictorPtr
	previous predictor direction
LOCA::StepSize::Manager *	stepSizeManagerPtr
	Step size manager.
double	startValue
	Starting value of continuation parameter, .
double	maxValue
	Largest allowable value of continuation parameter.
double	minValue
	Smallest allowable value of continuation parameter.
double	stepSize
	Current step size (change in the continuation parameter), .
int	maxNonlinearSteps
	Maximum number of newton iterations per continuation step,. Defaults to 15.
double	targetValue
	Target parameter value for last step (either maxValue or minValue).
bool	isTargetStep
	Flag indicating if this is an extra step to hit target value.
bool	doTangentFactorScaling
	Flag indicating whether to do tangent factor step size scaling.
double	tangentFactor
	Tangent factor.
double	minTangentFactor
	Minimum tangent factor.
double	tangentFactorExponent
	Tangent factor exponent.
bool	calcEigenvalues
	Flag indicating whether to compute eigenvalues after eachs step.

---

Detailed Description

Implementation of LOCA::Abstract::Iterator for computing points along a continuation curve.

The Stepper class implements the pure virtual methods of the LOCA::Abstract::Iterator for iteratively computing points along a continuation curve.

---

Member Function Documentation

LOCA::Continuation::AbstractGroup & LOCA::Stepper::getBifurcationGroup (   )  [virtual]

Return the current bifurcation group. If the current bifurcation method is "None", then the returned group is the same as getSolutionGroup(), otherwise this method returns the current bifurcation group (e.g., a turning point group).

const NOX::Solver::Generic & LOCA::Stepper::getSolver (   )  const [virtual]

Return the current nonlinear solver pointer. Will throw an error if the solver does not exist yet.

---

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

• LOCA_Stepper.H
• LOCA_Stepper.C

---