LOCA::MultiPredictor::Factory Class Reference

Factory for creating Predictor strategy objects. More...

#include <LOCA_MultiPredictor_Factory.H>

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

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

Detailed Description

Factory for creating Predictor strategy objects.

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

• "Method" - Name of the predictor method. Valid choices are
  • "Constant" (LOCA::MultiPredictor::Constant)
  • "Tangent" (LOCA::MultiPredictor::Tangent)
  • "Secant" (LOCA::MultiPredictor::Secant) [Default]
  • "Random" (LOCA::MultiPredictor::Random)
  • "Restart" (LOCA::MultiPredictor::Restart)

Constructor & Destructor Documentation

Factory()

LOCA::MultiPredictor::Factory::Factory

(

const Teuchos::RCP< LOCA::GlobalData > &

global_data

)

Constructor.

References globalData.

Member Function Documentation

create()

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

Create predictor strategy.

Parameters

topParams	[in] Parsed top-level parameter list.
predictorParams	[in] Predictor parameters as described above

References globalData, and strategyName().

strategyName()

const std::string & LOCA::MultiPredictor::Factory::strategyName

(

Teuchos::ParameterList &

predictorParams

)

const

Return strategy name given by predictorParams.

Referenced by create().

Member Data Documentation

globalData

Teuchos::RCP<LOCA::GlobalData> LOCA::MultiPredictor::Factory::globalData

protected

Global data.

Referenced by create(), and Factory().

---

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

• LOCA_MultiPredictor_Factory.H
• LOCA_MultiPredictor_Factory.C