MueLu
Version of the Day
|
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>
Public Member Functions | |
void | Clean () const |
void | Print () const |
Public Member Functions inherited from MueLu::FactoryManagerBase | |
bool | IgnoreUserData () const |
get IgnoreUserData flag More... | |
void | SetIgnoreUserData (bool bIgnoreUserData=false) |
set IgnoreUserData flag More... | |
FactoryManagerBase () | |
virtual | ~FactoryManagerBase () |
Destructor. More... | |
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 Attributes | |
std::map< std::string, RCP < const FactoryBase > > | factoryTable_ |
User-defined factories. More... | |
std::map< std::string, RCP < const FactoryBase > > | defaultFactoryTable_ |
Table that holds default factories. More... | |
bool | useKokkos_ |
Whether or not to use kokkos factories. More... | |
Constructor/Destructors | |
FactoryManager () | |
Constructor. More... | |
FactoryManager (const std::map< std::string, RCP< const FactoryBase > > &factoryTable) | |
Constructor used by HierarchyFactory (temporary, will be removed) More... | |
virtual | ~FactoryManager () |
Destructor. More... | |
Get/Set functions. | |
void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Set Factory. More... | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Get factory associated with a particular data name. More... | |
const RCP< FactoryBase > | GetFactoryNonConst (const std::string &varName) |
Get factory associated with a particular data name (NONCONST version) More... | |
bool | hasFactory (const std::string &varName) const |
Check. More... | |
const RCP< const FactoryBase > | GetDefaultFactory (const std::string &varName) const |
void | SetKokkosRefactor (const bool useKokkos) |
Helper functions | |
const RCP< const FactoryBase > | SetAndReturnDefaultFactory (const std::string &varName, const RCP< const FactoryBase > &factory) const |
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 |
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.
Definition at line 103 of file MueLu_FactoryManager_decl.hpp.
|
inline |
Constructor.
Definition at line 113 of file MueLu_FactoryManager_decl.hpp.
|
inline |
Constructor used by HierarchyFactory (temporary, will be removed)
Definition at line 123 of file MueLu_FactoryManager_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 134 of file MueLu_FactoryManager_decl.hpp.
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.
[in] | name | of variable |
[in] | factory | that generates the data |
Definition at line 100 of file MueLu_FactoryManager_def.hpp.
|
virtual |
Get factory associated with a particular data name.
[in] | varName | name of variable. |
Implements MueLu::FactoryManagerBase.
Definition at line 105 of file MueLu_FactoryManager_def.hpp.
const RCP< FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetFactoryNonConst | ( | const std::string & | varName | ) |
Get factory associated with a particular data name (NONCONST version)
[in] | varName | name of variable. |
Definition at line 116 of file MueLu_FactoryManager_def.hpp.
|
virtual |
Check.
Implements MueLu::FactoryManagerBase.
Definition at line 121 of file MueLu_FactoryManager_def.hpp.
const RCP< const FactoryBase > MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDefaultFactory | ( | const std::string & | varName | ) | const |
Definition at line 127 of file MueLu_FactoryManager_def.hpp.
|
inline |
Definition at line 172 of file MueLu_FactoryManager_decl.hpp.
|
inlinevirtual |
Reimplemented from MueLu::FactoryManagerBase.
Definition at line 178 of file MueLu_FactoryManager_decl.hpp.
void MueLu::FactoryManager< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Print | ( | ) | const |
Definition at line 243 of file MueLu_FactoryManager_def.hpp.
|
private |
Add a factory to the default factory list and return it. This helper function is used by GetDefaultFactory()
Definition at line 232 of file MueLu_FactoryManager_def.hpp.
|
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 206 of file MueLu_FactoryManager_decl.hpp.
|
mutableprivate |
Table that holds default factories.
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 215 of file MueLu_FactoryManager_decl.hpp.
|
private |
Whether or not to use kokkos factories.
Definition at line 218 of file MueLu_FactoryManager_decl.hpp.