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

#include <LOCA_MultiStepper.H>

Collaboration diagram for LOCA::MultiStepper:

Public Member Functions
	MultiStepper (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)
	Constructor.
virtual	~MultiStepper ()
	Destructor.
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 LOCA::Abstract::Iterator::IteratorStatus	run ()
	Run continuation.
virtual Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup >	getSolutionGroup ()
	Return the current solution group.
virtual Teuchos::RCP< const Teuchos::ParameterList >	getList () const
	Return the output parameters from the stepper algorithm.

Protected Member Functions
virtual void	printInitializationInfo ()
	Print to the screen the initialization information.
virtual void	getConParamData ()
	Parses parameter list to get continuation parameter data.
Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup >	buildConstrainedGroup (const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &grp)
	Builds a constrained group is specified through parameter lists.

Protected Attributes
Teuchos::RCP< LOCA::GlobalData >	globalData
	Global data.
Teuchos::RCP< LOCA::Parameter::SublistParser >	parsedParams
	Parsed parameter list.
Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy >	predictor
	Predictor strategy.
Teuchos::RCP< LOCA::MultiContinuation::AbstractStrategy >	curGroupPtr
	Current continuation group.
Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup >	bifGroupPtr
	Pointer to bifurcation group.
Teuchos::RCP< NOX::StatusTest::Generic >	statusTestPtr
	Pointer to the status test.
Teuchos::RCP< Teuchos::ParameterList >	paramListPtr
	Pointer to parameter list passed in constructor/reset method.
Teuchos::RCP< Teuchos::ParameterList >	stepperList
	Pointer to stepper parameters.
Teuchos::RCP< NOX::Solver::Generic >	solverPtr
	Solver (a.k.a corrector).
LOCA::ParameterVector	paramVec
	Stores continuation parameter vector.
std::vector< int >	conParamIDVec
	Stores vector of continuation parameter IDs.
std::list< ParamData >	conParamData
	Stores list of continuation parameter data.

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.

Constructor & Destructor Documentation

◆ MultiStepper()

LOCA::MultiStepper::MultiStepper	(	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 )

Constructor.

References bifGroupPtr, conParamData, conParamIDVec, curGroupPtr, globalData, paramListPtr, paramVec, parsedParams, predictor, reset(), solverPtr, statusTestPtr, and stepperList.

Member Function Documentation

◆ buildConstrainedGroup()

Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > LOCA::MultiStepper::buildConstrainedGroup ( const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > & grp )

protected

Builds a constrained group is specified through parameter lists.

References LOCA::ParameterVector::getIndex(), globalData, and parsedParams.

Referenced by reset().

◆ getConParamData()

void LOCA::MultiStepper::getConParamData ( )

protectedvirtual

Parses parameter list to get continuation parameter data.

References conParamData, conParamIDVec, globalData, paramVec, and stepperList.

Referenced by reset().

◆ getList()

Teuchos::RCP< const Teuchos::ParameterList > LOCA::MultiStepper::getList ( ) const

virtual

Return the output parameters from the stepper algorithm.

References paramListPtr.

◆ getSolutionGroup()

Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup > LOCA::MultiStepper::getSolutionGroup ( )

virtual

Return the current solution group.

References curGroupPtr.

◆ printInitializationInfo()

void LOCA::MultiStepper::printInitializationInfo ( )

protectedvirtual

Print to the screen the initialization information.

References globalData, and NOX::Utils::StepperIteration.

Referenced by reset().

◆ reset()

bool LOCA::MultiStepper::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 )

virtual

Reset the Stepper to start a new continuation run.

References bifGroupPtr, buildConstrainedGroup(), conParamIDVec, curGroupPtr, getConParamData(), globalData, paramListPtr, paramVec, parsedParams, predictor, printInitializationInfo(), solverPtr, statusTestPtr, stepperList, and NOX::Utils::StepperParameters.

Referenced by MultiStepper().

◆ run()

LOCA::Abstract::Iterator::IteratorStatus LOCA::MultiStepper::run ( )

virtual

Run continuation.

References conParamData, conParamIDVec, NOX::StatusTest::Converged, curGroupPtr, LOCA::Abstract::Iterator::Failed, LOCA::Abstract::Iterator::Finished, LOCA::MultiContinuation::ExtendedGroup::getUnderlyingGroup(), globalData, paramListPtr, parsedParams, predictor, solverPtr, statusTestPtr, and stepperList.

Member Data Documentation

◆ bifGroupPtr

Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup> LOCA::MultiStepper::bifGroupPtr

protected

Pointer to bifurcation group.

Referenced by MultiStepper(), and reset().

◆ conParamData

std::list<ParamData> LOCA::MultiStepper::conParamData

protected

Stores list of continuation parameter data.

Referenced by getConParamData(), MultiStepper(), and run().

◆ conParamIDVec

std::vector<int> LOCA::MultiStepper::conParamIDVec

protected

Stores vector of continuation parameter IDs.

Referenced by getConParamData(), MultiStepper(), reset(), and run().

◆ curGroupPtr

Teuchos::RCP<LOCA::MultiContinuation::AbstractStrategy> LOCA::MultiStepper::curGroupPtr

protected

Current continuation group.

Referenced by getSolutionGroup(), MultiStepper(), reset(), and run().

◆ globalData

Teuchos::RCP<LOCA::GlobalData> LOCA::MultiStepper::globalData

protected

Global data.

Referenced by buildConstrainedGroup(), getConParamData(), MultiStepper(), printInitializationInfo(), reset(), and run().

◆ paramListPtr

Teuchos::RCP<Teuchos::ParameterList> LOCA::MultiStepper::paramListPtr

protected

Pointer to parameter list passed in constructor/reset method.

Referenced by getList(), MultiStepper(), reset(), and run().

◆ paramVec

LOCA::ParameterVector LOCA::MultiStepper::paramVec

protected

Stores continuation parameter vector.

Referenced by getConParamData(), MultiStepper(), and reset().

◆ parsedParams

Teuchos::RCP<LOCA::Parameter::SublistParser> LOCA::MultiStepper::parsedParams

protected

Parsed parameter list.

Referenced by buildConstrainedGroup(), MultiStepper(), reset(), and run().

◆ predictor

Teuchos::RCP<LOCA::MultiPredictor::AbstractStrategy> LOCA::MultiStepper::predictor

protected

Predictor strategy.

Referenced by MultiStepper(), reset(), and run().

◆ solverPtr

Teuchos::RCP<NOX::Solver::Generic> LOCA::MultiStepper::solverPtr

protected

Solver (a.k.a corrector).

Referenced by MultiStepper(), reset(), and run().

◆ statusTestPtr

Teuchos::RCP<NOX::StatusTest::Generic> LOCA::MultiStepper::statusTestPtr

protected

Pointer to the status test.

Referenced by MultiStepper(), reset(), and run().

◆ stepperList

Teuchos::RCP<Teuchos::ParameterList> LOCA::MultiStepper::stepperList

protected

Pointer to stepper parameters.

Referenced by getConParamData(), MultiStepper(), reset(), and run().

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

LOCA_MultiStepper.H
LOCA_MultiStepper.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultiStepper()

Member Function Documentation

◆ buildConstrainedGroup()

◆ getConParamData()

◆ getList()

◆ getSolutionGroup()

◆ printInitializationInfo()

◆ reset()

◆ run()

Member Data Documentation

◆ bifGroupPtr

◆ conParamData

◆ conParamIDVec

◆ curGroupPtr

◆ globalData

◆ paramListPtr

◆ paramVec

◆ parsedParams

◆ predictor

◆ solverPtr

◆ statusTestPtr

◆ stepperList