LOCA::Abstract::Factory Class Reference

Abstract interface for providing a user-defined factory More...

#include <LOCA_Abstract_Factory.H>

Inheritance diagram for LOCA::Abstract::Factory:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 Factory ()
 Constructor.
virtual ~Factory ()
 Destructor.
virtual void init (const Teuchos::RCP< LOCA::GlobalData > &global_data)=0
 Initialize factory.
Strategy create methods
virtual bool createPredictorStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &predictorParams, Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > &strategy)
 Create predictor strategy.
virtual bool createContinuationStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &stepperParams, const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &grp, const Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > &pred, const vector< int > &paramIDs, Teuchos::RCP< LOCA::MultiContinuation::AbstractStrategy > &strategy)
 Create continuation strategy.
virtual bool createBifurcationStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &bifurcationParams, const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &grp, Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &strategy)
 Create bifurcation strategy.
virtual bool createStepSizeStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &stepsizeParams, Teuchos::RCP< LOCA::StepSize::AbstractStrategy > &strategy)
 Create step size strategy.
virtual bool createBorderedSolverStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, Teuchos::RCP< LOCA::BorderedSolver::AbstractStrategy > &strategy)
 Create bordered system solver strategy.
virtual bool createEigensolverStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams, Teuchos::RCP< LOCA::Eigensolver::AbstractStrategy > &strategy)
 Create eigensolver strategy.
virtual bool createEigenvalueSortStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams, Teuchos::RCP< LOCA::EigenvalueSort::AbstractStrategy > &strategy)
 Create eigenvalue sorting strategy.
virtual bool createSaveEigenDataStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams, Teuchos::RCP< LOCA::SaveEigenData::AbstractStrategy > &strategy)
 Create strategy to save eigenvector/value data.
virtual bool createAnasaziOperatorStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, const Teuchos::RCP< NOX::Abstract::Group > &grp, Teuchos::RCP< LOCA::AnasaziOperator::AbstractStrategy > &strategy)
 Create Anasazi operator.
virtual bool createMooreSpenceTurningPointSolverStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, Teuchos::RCP< LOCA::TurningPoint::MooreSpence::SolverStrategy > &strategy)
 Create Moore-Spence turning point solver strategy.
virtual bool createMooreSpencePitchforkSolverStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, Teuchos::RCP< LOCA::Pitchfork::MooreSpence::SolverStrategy > &strategy)
 Create Moore-Spence pitchfork solver strategy.
virtual bool createMooreSpenceHopfSolverStrategy (const string &strategyName, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &solverParams, Teuchos::RCP< LOCA::Hopf::MooreSpence::SolverStrategy > &strategy)
 Create Moore-Spence Hopf solver strategy.


Detailed Description

Abstract interface for providing a user-defined factory

LOCAAbstract::Factory provides an abstract interface for providing user-defined factories to the LOCA::Factory. The LOCA::Factory provides a mechanism for instantiating different strategies based on parameter list choices. This class allows additional strategies to be instantiated by the factory without modifying the factory itself. This is done by deriving a user-defined factory from this interface, implementing any of the create methods for the user-defined strategies, and passing an instance of the derived factory to the LOCA::Factory object. Any derived class must implement the init() method to set the global data object which the factory can then pass to any instantiated strategies.

Definition at line 118 of file LOCA_Abstract_Factory.H.


Constructor & Destructor Documentation

LOCA::Abstract::Factory::Factory (  )  [inline]

Constructor.

Reimplemented in LOCA::LAPACK::Factory, and LOCA::Epetra::Factory.

Definition at line 123 of file LOCA_Abstract_Factory.H.

virtual LOCA::Abstract::Factory::~Factory (  )  [inline, virtual]

Destructor.

Reimplemented in LOCA::LAPACK::Factory, and LOCA::Epetra::Factory.

Definition at line 126 of file LOCA_Abstract_Factory.H.


Member Function Documentation

virtual void LOCA::Abstract::Factory::init ( const Teuchos::RCP< LOCA::GlobalData > &  global_data  )  [pure virtual]

Initialize factory.

The LOCA::Factory will call this method to initialize the user provided factory. The user-provided factory should perform any needed initialization here that cannot occur at construction.

Implemented in LOCA::LAPACK::Factory, and LOCA::Epetra::Factory.

bool LOCA::Abstract::Factory::createPredictorStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  predictorParams,
Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > &  strategy 
) [virtual]

Create predictor strategy.

Definition at line 45 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createContinuationStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  stepperParams,
const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &  grp,
const Teuchos::RCP< LOCA::MultiPredictor::AbstractStrategy > &  pred,
const vector< int > &  paramIDs,
Teuchos::RCP< LOCA::MultiContinuation::AbstractStrategy > &  strategy 
) [virtual]

Create continuation strategy.

Definition at line 55 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createBifurcationStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  bifurcationParams,
const Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &  grp,
Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > &  strategy 
) [virtual]

Create bifurcation strategy.

Definition at line 68 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createStepSizeStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  stepsizeParams,
Teuchos::RCP< LOCA::StepSize::AbstractStrategy > &  strategy 
) [virtual]

Create step size strategy.

Definition at line 79 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createBorderedSolverStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
Teuchos::RCP< LOCA::BorderedSolver::AbstractStrategy > &  strategy 
) [virtual]

Create bordered system solver strategy.

Reimplemented in LOCA::LAPACK::Factory, and LOCA::Epetra::Factory.

Definition at line 89 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createEigensolverStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams,
Teuchos::RCP< LOCA::Eigensolver::AbstractStrategy > &  strategy 
) [virtual]

Create eigensolver strategy.

Reimplemented in LOCA::LAPACK::Factory.

Definition at line 99 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createEigenvalueSortStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams,
Teuchos::RCP< LOCA::EigenvalueSort::AbstractStrategy > &  strategy 
) [virtual]

Create eigenvalue sorting strategy.

Definition at line 109 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createSaveEigenDataStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams,
Teuchos::RCP< LOCA::SaveEigenData::AbstractStrategy > &  strategy 
) [virtual]

Create strategy to save eigenvector/value data.

Definition at line 119 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createAnasaziOperatorStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  eigenParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
const Teuchos::RCP< NOX::Abstract::Group > &  grp,
Teuchos::RCP< LOCA::AnasaziOperator::AbstractStrategy > &  strategy 
) [virtual]

Create Anasazi operator.

Definition at line 129 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createMooreSpenceTurningPointSolverStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
Teuchos::RCP< LOCA::TurningPoint::MooreSpence::SolverStrategy > &  strategy 
) [virtual]

Create Moore-Spence turning point solver strategy.

Definition at line 141 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createMooreSpencePitchforkSolverStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
Teuchos::RCP< LOCA::Pitchfork::MooreSpence::SolverStrategy > &  strategy 
) [virtual]

Create Moore-Spence pitchfork solver strategy.

Definition at line 151 of file LOCA_Abstract_Factory.C.

bool LOCA::Abstract::Factory::createMooreSpenceHopfSolverStrategy ( const string &  strategyName,
const Teuchos::RCP< LOCA::Parameter::SublistParser > &  topParams,
const Teuchos::RCP< Teuchos::ParameterList > &  solverParams,
Teuchos::RCP< LOCA::Hopf::MooreSpence::SolverStrategy > &  strategy 
) [virtual]

Create Moore-Spence Hopf solver strategy.

Definition at line 161 of file LOCA_Abstract_Factory.C.


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

Generated on Thu Dec 17 11:02:45 2009 for Nonlinear Solver Project by  doxygen 1.5.9