LOCA::SaveEigenData::Factory Class Reference

Factory for creating strategy objects to save eigenvectors/values. More...

#include <LOCA_SaveEigenData_Factory.H>

List of all members.

Public Member Functions

 Factory (const Teuchos::RCP< LOCA::GlobalData > &global_data)
 Constructor.
virtual ~Factory ()
 Destructor.
Teuchos::RCP
< LOCA::SaveEigenData::AbstractStrategy
create (const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams)
 Create strategy to save eigenvectors/values.
const string & strategyName (Teuchos::ParameterList &eigenParams) const
 Return strategy name given by eigenParams.

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 strategy objects to save eigenvectors/values.

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

User-defined strategies are defined by supplying the parameter "User-Defined Save Eigen Data Name" which is the string name of the strategy, and then a parameter with this name that is of the type Teuchos::RCP<LOCA::SaveEigenData::AbstractStrategy>. This allows the user to supply a user-defined strategy without providing a factory to instantiate it. By supplying the name of the parameter storing the strategy, the user can provide multiple strategies in the parameter list and select among them by setting "User-Defined Save Eigen Data Name" to be the name of the strategy.

Definition at line 88 of file LOCA_SaveEigenData_Factory.H.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 50 of file LOCA_SaveEigenData_Factory.C.

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

Destructor.

Definition at line 56 of file LOCA_SaveEigenData_Factory.C.

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

Private to prohibit copying.


Member Function Documentation

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

Create strategy to save eigenvectors/values.

Parameters:
topParams [in] Parsed top-level parameter list.
eigenParams [in] Eigensolver parameters as described above

Definition at line 61 of file LOCA_SaveEigenData_Factory.C.

References globalData, and strategyName().

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

const string & LOCA::SaveEigenData::Factory::strategyName ( Teuchos::ParameterList &  eigenParams  )  const

Return strategy name given by eigenParams.

Definition at line 102 of file LOCA_SaveEigenData_Factory.C.

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

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

Private to prohibit copying.


Member Data Documentation

Global data.

Definition at line 122 of file LOCA_SaveEigenData_Factory.H.

Referenced by create().


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

Generated on Thu Dec 17 11:03:00 2009 for Nonlinear Solver Project by  doxygen 1.5.9