LOCA::EigenvalueSort::Factory Class Reference

Factory for creating EigenvalueSort strategy objects. More...

#include <LOCA_EigenvalueSort_Factory.H>

Collaboration diagram for LOCA::EigenvalueSort::Factory:

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

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

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.

• "Sorting Order" - Name of the sorting method. Valid choices are
  • "LM" (LOCA::EigenvalueSort::LargestMagnitude) [Default]
  • "LR" (LOCA::EigenvalueSort::LargestReal)
  • "LI" (LOCA::EigenvalueSort::LargestImaginary)
  • "SM" (LOCA::EigenvalueSort::SmallestMagnitude)
  • "SR" (LOCA::EigenvalueSort::SmallestReal)
  • "SI" (LOCA::EigenvalueSort::SmallestImaginary)
  • "CA" (LOCA::EigenvalueSort::LargestRealInverseCayley)

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

References Teuchos::ParameterList::get(), and Teuchos::rcp().

---

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

• LOCA_EigenvalueSort_Factory.H
• LOCA_EigenvalueSort_Factory.C