This class specifies the default factory that should generate some data on a Level if the data does not exist and the generating factory has not been specified. More...

#include <MueLu_FactoryManager_decl.hpp>

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

Helper functions
std::map< std::string, RCP< const FactoryBase > >	factoryTable_
	User-defined factories.

std::map< std::string, RCP< const FactoryBase > >	defaultFactoryTable_
	Table that holds default factories.

bool	useKokkos_
	Whether or not to use kokkos factories.

const RCP< const FactoryBase >	SetAndReturnDefaultFactory (const std::string &varName, const RCP< const FactoryBase > &factory) const

Constructor/Destructors
	FactoryManager ()
	Constructor.

	FactoryManager (const std::map< std::string, RCP< const FactoryBase > > &factoryTable)
	Constructor used by HierarchyFactory (temporary, will be removed)

virtual	~FactoryManager ()
	Destructor.

Get/Set functions.
void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
	Set Factory.

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Get factory associated with a particular data name.

const RCP< FactoryBase >	GetFactoryNonConst (const std::string &varName)
	Get factory associated with a particular data name (NONCONST version)

bool	hasFactory (const std::string &varName) const
	Check.

const RCP< const FactoryBase >	GetDefaultFactory (const std::string &varName) const

void	SetKokkosRefactor (const bool useKokkos)

bool	GetKokkosRefactor () const

void	Clean () const

void	Print () const

Additional Inherited Members
Public Member Functions inherited from MueLu::FactoryManagerBase
	FactoryManagerBase ()

virtual	~FactoryManagerBase ()
	Destructor.

bool	IgnoreUserData () const
	get IgnoreUserData flag

void	SetIgnoreUserData (bool bIgnoreUserData=false)
	set IgnoreUserData flag

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.

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::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >

This class specifies the default factory that should generate some data on a Level if the data does not exist and the generating factory has not been specified.

Consider the following example.

RCP<SingleLevelFactory> Afact;
Level currentLevel;
RCP<Matrix> thisLevelA;
thisLevelA = currentLevel.Get<Matrix>("A", Afact.get());

Todo:: If Afact is null (actually, Teuchos::null), then the FactoryManager associated with currentLevel will determine whether a default factory has been specified for creating A. If "yes", then that factory will be called, A will be stored in currentLevel, and an RCP will be returned by the Get call. If "no", then the FactoryManager will throw an exception indicating that it does not know how to generate A.

Definition at line 70 of file MueLu_FactoryManager_decl.hpp.

Constructor & Destructor Documentation

◆ FactoryManager() [1/2]

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

MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryManager ( )

Constructor.

Definition at line 55 of file MueLu_FactoryManager_def.hpp.

◆ FactoryManager() [2/2]

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

MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactoryManager ( const std::map< std::string, RCP< const FactoryBase > > & factoryTable )

Constructor used by HierarchyFactory (temporary, will be removed)

Definition at line 61 of file MueLu_FactoryManager_def.hpp.

◆ ~FactoryManager()

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

MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~FactoryManager ( )

virtualdefault

Destructor.

Member Function Documentation

◆ SetFactory()

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

void MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetFactory	(	const std::string &	varName,
		const RCP< const FactoryBase > &	factory
	)

Set Factory.

Register the factory that should generate data if said factory is not specified in the request.

Parameters

[in]	name	of variable
[in]	factory	that generates the data

Definition at line 71 of file MueLu_FactoryManager_def.hpp.

◆ GetFactory()

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

const RCP< const FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetFactory ( const std::string & varName ) const

virtual

Get factory associated with a particular data name.

Parameters

[in] varName name of variable.

Implements MueLu::FactoryManagerBase.

Definition at line 76 of file MueLu_FactoryManager_def.hpp.

◆ GetFactoryNonConst()

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

const RCP< FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetFactoryNonConst ( const std::string & varName )

Get factory associated with a particular data name (NONCONST version)

Parameters

[in] varName name of variable.

Definition at line 87 of file MueLu_FactoryManager_def.hpp.

◆ hasFactory()

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

bool MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasFactory ( const std::string & varName ) const

virtual

Check.

Implements MueLu::FactoryManagerBase.

Definition at line 92 of file MueLu_FactoryManager_def.hpp.

◆ GetDefaultFactory()

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

const RCP< const FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDefaultFactory ( const std::string & varName ) const

Definition at line 98 of file MueLu_FactoryManager_def.hpp.

◆ SetKokkosRefactor()

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

void MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetKokkosRefactor ( const bool useKokkos )

inline

Definition at line 122 of file MueLu_FactoryManager_decl.hpp.

◆ GetKokkosRefactor()

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

bool MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetKokkosRefactor ( ) const

inline

Definition at line 126 of file MueLu_FactoryManager_decl.hpp.

◆ Clean()

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

void MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Clean ( ) const

inlinevirtual

Reimplemented from MueLu::FactoryManagerBase.

Definition at line 130 of file MueLu_FactoryManager_decl.hpp.

◆ Print()

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

void MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Print ( ) const

Definition at line 226 of file MueLu_FactoryManager_def.hpp.

◆ SetAndReturnDefaultFactory()

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

const RCP< const FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetAndReturnDefaultFactory	(	const std::string &	varName,
		const RCP< const FactoryBase > &	factory
	)		const

private

Add a factory to the default factory list and return it. This helper function is used by GetDefaultFactory()

Todo:: TODO factory->setObjectLabel("Default " + varName + "Factory");

Definition at line 215 of file MueLu_FactoryManager_def.hpp.

Member Data Documentation

◆ factoryTable_

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

std::map<std::string, RCP<const FactoryBase> > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::factoryTable_

private

User-defined factories.

User may overwrite default behaviour. The user provided factories are stored in a separate table. When we try to determine which factory generates the data, this table is searched first.

Note: we distinguish 'user defined factory' and 'default factory' to allow the deallocation of default factories separately.

Definition at line 157 of file MueLu_FactoryManager_decl.hpp.

◆ defaultFactoryTable_

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

std::map<std::string, RCP<const FactoryBase> > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::defaultFactoryTable_

mutableprivate

Table that holds default factories.

We distinguish 'user defined factory' and 'default factory' to allow the deallocation of default factories separately.
defaultFactoryTable_ is mutable because default factories are only added to the list when they are requested to avoid allocation of unused factories.

Definition at line 165 of file MueLu_FactoryManager_decl.hpp.

◆ useKokkos_

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

bool MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::useKokkos_

private

Whether or not to use kokkos factories.

Definition at line 168 of file MueLu_FactoryManager_decl.hpp.

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

Helper functions

Constructor/Destructors

Get/Set functions.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FactoryManager() [1/2]

◆ FactoryManager() [2/2]

◆ ~FactoryManager()

Member Function Documentation

◆ SetFactory()

◆ GetFactory()

◆ GetFactoryNonConst()

◆ hasFactory()

◆ GetDefaultFactory()

◆ SetKokkosRefactor()

◆ GetKokkosRefactor()

◆ Clean()

◆ Print()

◆ SetAndReturnDefaultFactory()

Member Data Documentation

◆ factoryTable_

◆ defaultFactoryTable_

◆ useKokkos_