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
virtual	~BaseClass ()
	Destructor.
	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
using	FactoryBase = MueLu::FactoryBase
using	Level = MueLu::Level
using	PFactory = MueLu::PFactory
using	FactoryManager = MueLu::FactoryManager<Scalar,LocalOrdinal,GlobalOrdinal,Node>
using	Hierarchy = MueLu::Hierarchy<Scalar,LocalOrdinal,GlobalOrdinal,Node>
using	HierarchyFactory = MueLu::HierarchyFactory<Scalar,LocalOrdinal,GlobalOrdinal,Node>
using	PerfUtils = MueLu::PerfUtils<Scalar,LocalOrdinal,GlobalOrdinal,Node>
using	SmootherBase = MueLu::SmootherBase<Scalar,LocalOrdinal,GlobalOrdinal,Node>
typedef MueLu::TwoLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >	TwoLevelMatlabFactory
typedef MueLu::SingleLevelMatlabFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >	SingleLevelMatlabFactory
typedef MueLu::MatlabSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >	MatlabSmoother
typedef std::map< std::string, RCP< const FactoryBase > >	FactoryMap
typedef std::map< std::string, RCP< FactoryManagerBase > >	FactoryManagerMap

Additional Inherited Members
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 200 of file MueLu_FactoryFactory_decl.hpp.

Member Typedef Documentation

◆ FactoryBase

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryBase = MueLu::FactoryBase

private

◆ Level

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Level = MueLu::Level

private

◆ PFactory

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PFactory = MueLu::PFactory

private

◆ FactoryManager

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryManager = MueLu::FactoryManager<Scalar,LocalOrdinal,GlobalOrdinal,Node>

private

◆ Hierarchy

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Hierarchy = MueLu::Hierarchy<Scalar,LocalOrdinal,GlobalOrdinal,Node>

private

◆ HierarchyFactory

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::HierarchyFactory = MueLu::HierarchyFactory<Scalar,LocalOrdinal,GlobalOrdinal,Node>

private

◆ PerfUtils

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PerfUtils = MueLu::PerfUtils<Scalar,LocalOrdinal,GlobalOrdinal,Node>

private

◆ SmootherBase

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

using MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SmootherBase = MueLu::SmootherBase<Scalar,LocalOrdinal,GlobalOrdinal,Node>

private

◆ TwoLevelMatlabFactory

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

typedef MueLu::TwoLevelMatlabFactory<Scalar,LocalOrdinal,GlobalOrdinal,Node> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TwoLevelMatlabFactory

private

Definition at line 445 of file MueLu_FactoryFactory_decl.hpp.

◆ SingleLevelMatlabFactory

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

typedef MueLu::SingleLevelMatlabFactory<Scalar,LocalOrdinal,GlobalOrdinal,Node> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SingleLevelMatlabFactory

private

Definition at line 448 of file MueLu_FactoryFactory_decl.hpp.

◆ MatlabSmoother

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

typedef MueLu::MatlabSmoother<Scalar,LocalOrdinal,GlobalOrdinal,Node> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatlabSmoother

private

Definition at line 451 of file MueLu_FactoryFactory_decl.hpp.

◆ 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 204 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 205 of file MueLu_FactoryFactory_decl.hpp.

Member Function Documentation

◆ BuildFactory()

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

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 226 of file MueLu_FactoryFactory_decl.hpp.

◆ Build()

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

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 431 of file MueLu_FactoryFactory_decl.hpp.

◆ Build2()

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

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 444 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildRAPFactory()

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

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 485 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildTogglePFactory()

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

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 508 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildToggleCoordinatesTransferFactory()

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

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

inline

Definition at line 599 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildTrilinosSmoother()

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

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 654 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildMatlabSmoother()

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

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 710 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildDirectSolver()

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

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

inline

Definition at line 726 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildBlockedSmoother()

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

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 740 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildTekoSmoother()

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

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

inline

Definition at line 805 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildBlockedDirectSolver()

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

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

inline

Definition at line 827 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildBlockedFactory()

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

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 844 of file MueLu_FactoryFactory_decl.hpp.

◆ BuildBlockedCoordFactory()

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

template<class T>

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

inline

Definition at line 907 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

Member Typedef Documentation

◆ FactoryBase

◆ Level

◆ PFactory

◆ FactoryManager

◆ Hierarchy

◆ HierarchyFactory

◆ PerfUtils

◆ SmootherBase

◆ TwoLevelMatlabFactory

◆ SingleLevelMatlabFactory

◆ MatlabSmoother

◆ FactoryMap

◆ FactoryManagerMap

Member Function Documentation

◆ BuildFactory()

Parameter List Parsing:

◆ Build()

◆ Build2()

◆ BuildRAPFactory()

◆ BuildTogglePFactory()

◆ BuildToggleCoordinatesTransferFactory()

◆ BuildTrilinosSmoother()

◆ BuildMatlabSmoother()

◆ BuildDirectSolver()

◆ BuildBlockedSmoother()

◆ BuildTekoSmoother()

◆ BuildBlockedDirectSolver()

◆ BuildBlockedFactory()

◆ BuildBlockedCoordFactory()