Factory that can generate other factories from. More...

#include <MueLu_FactoryFactory_decl.hpp>

Inheritance diagram for MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Member Functions
virtual RCP< const FactoryBase >	BuildFactory (const Teuchos::ParameterEntry &param, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
	: Interpret Factory parameter list and build new factory More...

template<class T >
RCP< T >	Build (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

template<class T >
RCP< T >	Build2 (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

template<class T >
RCP< T >	BuildRAPFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

template<class T >
RCP< T >	BuildTogglePFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

RCP < ToggleCoordinatesTransferFactory >	BuildToggleCoordinatesTransferFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

RCP< FactoryBase >	BuildCoupledAggregationFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
	CoupledAggregationFactory. More...

RCP< FactoryBase >	BuildTrilinosSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
	TrilinosSmoother. More...

RCP< FactoryBase >	BuildMatlabSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
	MatlabSmoother. More...

RCP< FactoryBase >	BuildDirectSolver (const Teuchos::ParameterList &paramList, const FactoryMap &, const FactoryManagerMap &) const

template<class T >
RCP< FactoryBase >	BuildBlockedSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

RCP< FactoryBase >	BuildTekoSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

RCP< FactoryBase >	BuildBlockedDirectSolver (const Teuchos::ParameterList &, const FactoryMap &, const FactoryManagerMap &) const

template<class T >
RCP< T >	BuildBlockedFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
VerbLevel	GetVerbLevel () const
	Get the verbosity level. More...

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object. More...

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose. More...

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing. More...

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type. More...

Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type. More...

Teuchos::FancyOStream &	GetBlackHole () const

	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. More...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

virtual void	describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const

virtual std::string	description () const
	Return a simple one-line description of this object. More...

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object. More...

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Private Types
typedef std::map< std::string, RCP< const FactoryBase > >	FactoryMap

typedef std::map< std::string, RCP< FactoryManagerBase > >	FactoryManagerMap

Additional Inherited Members
Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static Teuchos::RCP < Teuchos::FancyOStream >	GetMueLuOStream ()

static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory that can generate other factories from.

class FactoryFactory

Definition at line 183 of file MueLu_FactoryFactory_decl.hpp.

Member Typedef Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

typedef std::map<std::string, RCP<const FactoryBase> > MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryMap

private

Definition at line 187 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

typedef std::map<std::string, RCP<FactoryManagerBase> > MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryManagerMap

private

Definition at line 188 of file MueLu_FactoryFactory_decl.hpp.

Member Function Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

virtual RCP<const FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildFactory	(	const Teuchos::ParameterEntry &	param,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inlinevirtual

: Interpret Factory parameter list and build new factory

Parameters

param	[in]: ParameterEntry being either the parameter list containing the "factory" parameter declaring the factory type (e.g., "TrilinosSmoother") or being a plain Parameter containing the factory type as value
factoryMapIn	[in]: FactoryMap containing a map between factory name (e.g., "smootherFact1") and corresponding factory of all previously defined factories
factoryManagersIn	[in]: FactoryManagerMap containing a map between group names and Factory manager objects. Needed for factories with sub-factory managers.

Parameter List Parsing:

or:

<ParameterList name="smootherFact1">
  <Parameter name="factory" type="string" value="TrilinosSmoother"/>
  ...
</ParameterList>

Definition at line 209 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<T> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 395 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<T> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build2	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 408 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<T> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildRAPFactory	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 449 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<T> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildTogglePFactory	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 472 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<ToggleCoordinatesTransferFactory> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildToggleCoordinatesTransferFactory	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 563 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildCoupledAggregationFactory	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

CoupledAggregationFactory.

Definition at line 609 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildTrilinosSmoother	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

TrilinosSmoother.

Definition at line 637 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildMatlabSmoother	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

MatlabSmoother.

Definition at line 693 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildDirectSolver	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	,
		const FactoryManagerMap &
	)		const

inline

Definition at line 709 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildBlockedSmoother	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 723 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildTekoSmoother	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 788 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildBlockedDirectSolver	(	const Teuchos::ParameterList &	,
		const FactoryMap &	,
		const FactoryManagerMap &
	)		const

inline

Definition at line 810 of file MueLu_FactoryFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

template<class T >

RCP<T> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildBlockedFactory	(	const Teuchos::ParameterList &	paramList,
		const FactoryMap &	factoryMapIn,
		const FactoryManagerMap &	factoryManagersIn
	)		const

inline

Definition at line 827 of file MueLu_FactoryFactory_decl.hpp.

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

MueLu_FactoryFactory_decl.hpp

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType> class MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Member Typedef Documentation

Member Function Documentation

Parameter List Parsing:

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >