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

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 >	BuildTrilinosSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
	TrilinosSmoother.

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

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 &paramList, const FactoryMap &, const FactoryManagerMap &) const

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

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

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

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor.

VerbLevel	GetVerbLevel () const
	Get the verbosity level.

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

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

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

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

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

Teuchos::FancyOStream &	GetBlackHole () const

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

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.

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.

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

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	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level.

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

static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

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

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory that can generate other factories from.

class FactoryFactory

Definition at line 159 of file MueLu_FactoryFactory_decl.hpp.

Member Typedef Documentation

◆ FactoryMap

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

private

Definition at line 163 of file MueLu_FactoryFactory_decl.hpp.

◆ FactoryManagerMap

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

private

Definition at line 164 of file MueLu_FactoryFactory_decl.hpp.

Member Function Documentation

◆ BuildFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

: 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 129 of file MueLu_FactoryFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 324 of file MueLu_FactoryFactory_def.hpp.

◆ Build2()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 339 of file MueLu_FactoryFactory_def.hpp.

◆ BuildRAPFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 381 of file MueLu_FactoryFactory_def.hpp.

◆ BuildTogglePFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 405 of file MueLu_FactoryFactory_def.hpp.

◆ BuildToggleCoordinatesTransferFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Definition at line 497 of file MueLu_FactoryFactory_def.hpp.

◆ BuildTrilinosSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

TrilinosSmoother.

Definition at line 543 of file MueLu_FactoryFactory_def.hpp.

◆ BuildMatlabSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

MatlabSmoother.

Definition at line 593 of file MueLu_FactoryFactory_def.hpp.

◆ BuildDirectSolver()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Definition at line 610 of file MueLu_FactoryFactory_def.hpp.

◆ BuildBlockedSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 627 of file MueLu_FactoryFactory_def.hpp.

◆ BuildTekoSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Definition at line 692 of file MueLu_FactoryFactory_def.hpp.

◆ BuildBlockedDirectSolver()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

Definition at line 715 of file MueLu_FactoryFactory_def.hpp.

◆ BuildBlockedFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 732 of file MueLu_FactoryFactory_def.hpp.

◆ BuildBlockedCoordFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

template<class T >

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

Definition at line 794 of file MueLu_FactoryFactory_def.hpp.

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

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FactoryMap

◆ FactoryManagerMap

Member Function Documentation

◆ BuildFactory()

Parameter List Parsing:

◆ Build()

◆ Build2()

◆ BuildRAPFactory()

◆ BuildTogglePFactory()

◆ BuildToggleCoordinatesTransferFactory()

◆ BuildTrilinosSmoother()

◆ BuildMatlabSmoother()

◆ BuildDirectSolver()

◆ BuildBlockedSmoother()

◆ BuildTekoSmoother()

◆ BuildBlockedDirectSolver()

◆ BuildBlockedFactory()

◆ BuildBlockedCoordFactory()