LOCA::MultiPredictor::Factory Class Reference

Factory for creating Predictor strategy objects. More...

#include <LOCA_MultiPredictor_Factory.H>

List of all members.

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 string & strategyName (Teuchos::ParameterList &predictorParams) const
 Return strategy name given by predictorParams.

Protected Attributes

Teuchos::RCP< LOCA::GlobalDataglobalData
 Global data.

Private Member Functions

 Factory (const Factory &)
 Private to prohibit copying.
Factoryoperator= (const Factory &)
 Private to prohibit copying.


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.

Definition at line 82 of file LOCA_MultiPredictor_Factory.H.


Constructor & Destructor Documentation

LOCA::MultiPredictor::Factory::Factory ( const Teuchos::RCP< LOCA::GlobalData > &  global_data  ) 

Constructor.

Definition at line 55 of file LOCA_MultiPredictor_Factory.C.

LOCA::MultiPredictor::Factory::~Factory (  )  [virtual]

Destructor.

Definition at line 61 of file LOCA_MultiPredictor_Factory.C.

LOCA::MultiPredictor::Factory::Factory ( const Factory  )  [private]

Private to prohibit copying.


Member Function Documentation

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

Definition at line 66 of file LOCA_MultiPredictor_Factory.C.

References globalData, and strategyName().

Referenced by LOCA::Factory::createPredictorStrategy().

const string & LOCA::MultiPredictor::Factory::strategyName ( Teuchos::ParameterList &  predictorParams  )  const

Return strategy name given by predictorParams.

Definition at line 129 of file LOCA_MultiPredictor_Factory.C.

Referenced by create(), and LOCA::Factory::createPredictorStrategy().

Factory& LOCA::MultiPredictor::Factory::operator= ( const Factory  )  [private]

Private to prohibit copying.


Member Data Documentation

Global data.

Definition at line 116 of file LOCA_MultiPredictor_Factory.H.

Referenced by create().


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

Generated on Wed Oct 21 14:28:38 2009 for Nonlinear Solver Project by  doxygen 1.5.9