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:

Inheritance graph
Collaboration diagram for LOCA::Stepper:

Collaboration graph
List of all members.

Public Member Functions

 Stepper (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &initialGuess, const Teuchos::RCP< NOX::StatusTest::Generic > &t, const Teuchos::RCP< Teuchos::ParameterList > &p)
virtual ~Stepper ()
virtual bool reset (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &initialGuess, const Teuchos::RCP< NOX::StatusTest::Generic > &t, const Teuchos::RCP< Teuchos::ParameterList > &p)
 Reset the Stepper to start a new continuation run.
virtual Teuchos::RCP< const
getSolutionGroup () const
 Return the current solution group.
virtual Teuchos::RCP< const
getBifurcationGroup () const
 Return the current bifurcation group.
virtual Teuchos::RCP< const
getList () const
 Return the output parameters from the stepper algorithm.
virtual Teuchos::RCP< const
getSolver () const
 Return the current nonlinear solver pointer.

Protected Member Functions

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.
Teuchos::RCP< LOCA::MultiContinuation::AbstractGroupbuildConstrainedGroup (const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &grp)
 Builds a constrained group is specified through parameter lists.
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

Teuchos::RCP< LOCA::GlobalDataglobalData
 Global data.
Teuchos::RCP< LOCA::Parameter::SublistParserparsedParams
 Parsed parameter list.
Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategypredictor
 Predictor strategy.
Teuchos::RCP< LOCA::MultiContinuation::AbstractStrategycurGroupPtr
 Current continuation group.
Teuchos::RCP< LOCA::MultiContinuation::AbstractStrategyprevGroupPtr
 Continuation group from previous step.
Teuchos::RCP< LOCA::Eigensolver::AbstractStrategyeigensolver
 Eigensolver for computing eigenvalues after each continuation step.
Teuchos::RCP< LOCA::SaveEigenData::AbstractStrategysaveEigenData
 Strategy for saving eigenvectors/values.
Teuchos::RCP< LOCA::MultiContinuation::AbstractGroupbifGroupPtr
 Pointer to bifurcation group.
Teuchos::RCP< NOX::StatusTest::GenericstatusTestPtr
 Pointer to the status test.
Teuchos::RCP< Teuchos::ParameterListparamListPtr
 Pointer to parameter list passed in constructor/reset method.
Teuchos::RCP< Teuchos::ParameterListstepperList
 Pointer to stepper parameters.
Teuchos::RCP< NOX::Solver::GenericsolverPtr
 Solver (a.k.a corrector).
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVectorcurPredictorPtr
 Current predictor direction.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVectorprevPredictorPtr
 previous predictor direction
Teuchos::RCP< LOCA::StepSize::AbstractStrategystepSizeStrategyPtr
 Step size control strategy.
string conParamName
 Name of continuation parameter.
vector< int > conParamIDs
 Index of continuation parameter.
double startValue
 Starting value of continuation parameter, $\lambda_b $.
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), $\Delta \lambda_i $.
int maxNonlinearSteps
 Maximum number of newton iterations per continuation step,$ N_{max} $. 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 each step.
bool return_failed_on_max_steps
 Flag indicating whether to return failed upon reaching max steps.

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

Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup > LOCA::Stepper::getBifurcationGroup (  )  const [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).

Teuchos::RCP< 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:
Generated on Wed May 12 21:41:54 2010 for NOX by  doxygen 1.4.7