LOCA::EigenvalueSort::Factory Class Reference

Factory for creating EigenvalueSort strategy objects. More...

#include <LOCA_EigenvalueSort_Factory.H>

List of all members.

Public Member Functions

 Factory (const Teuchos::RCP< LOCA::GlobalData > &global_data)
 Constructor.
virtual ~Factory ()
 Destructor.
Teuchos::RCP
< LOCA::EigenvalueSort::AbstractStrategy
create (const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &eigenParams)
 Create sorting strategy.
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 EigenvalueSort strategy objects.

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

Definition at line 84 of file LOCA_EigenvalueSort_Factory.H.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 49 of file LOCA_EigenvalueSort_Factory.C.

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

Destructor.

Definition at line 55 of file LOCA_EigenvalueSort_Factory.C.

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

Private to prohibit copying.


Member Function Documentation

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

Create sorting strategy.

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

Definition at line 60 of file LOCA_EigenvalueSort_Factory.C.

References globalData, and strategyName().

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

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

Return strategy name given by eigenParams.

Definition at line 132 of file LOCA_EigenvalueSort_Factory.C.

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

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

Private to prohibit copying.


Member Data Documentation

Global data.

Definition at line 118 of file LOCA_EigenvalueSort_Factory.H.

Referenced by create().


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

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