LOCA::StepSize::Factory Class Reference

Factory for creating step size control strategy objects. More...

#include <LOCA_StepSize_Factory.H>

Collaboration diagram for LOCA::StepSize::Factory:

Public Member Functions
	Factory (const Teuchos::RCP< LOCA::GlobalData > &global_data)
	Constructor.
virtual	~Factory ()
	Destructor.
Teuchos::RCP < LOCA::StepSize::AbstractStrategy >	create (const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &stepsizeParams)
	Create step size control strategy. More...
const std::string &	strategyName (Teuchos::ParameterList &stepsizeParams) const
	Return strategy name given by stepsizeParams.

Protected Attributes
Teuchos::RCP< LOCA::GlobalData >	globalData
	Global data.

Detailed Description

Factory for creating step size control strategy objects.

The parameters passed to the create() through the stepsizeParams argument method should specify the "Method" as described below, as well as any additional parameters for the particular strategy.

• "Method" - Name of the step size control method. Valid choices are
  • "Constant" (LOCA::StepSize::Constant)
  • "Adaptive" LOCA::StepSize::Adaptive) [Default]

Member Function Documentation

Teuchos::RCP< LOCA::StepSize::AbstractStrategy > LOCA::StepSize::Factory::create	(	const Teuchos::RCP< LOCA::Parameter::SublistParser > &	topParams,
		const Teuchos::RCP< Teuchos::ParameterList > &	stepsizeParams
	)

Create step size control strategy.

Parameters

topParams	[in] Parsed top-level parameter list.
stepsizeParams	[in] Step size parameters as described above

References Teuchos::ParameterList::get(), and Teuchos::rcp().

---

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

• LOCA_StepSize_Factory.H
• LOCA_StepSize_Factory.C