MueLu  Version of the Day
MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <MueLu_FactoryFactory_decl.hpp>

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

Public Member Functions

virtual RCP< const FactoryBaseBuildFactory (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< ToggleCoordinatesTransferFactoryBuildToggleCoordinatesTransferFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 
RCP< FactoryBaseBuildCoupledAggregationFactory (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 CoupledAggregationFactory. More...
 
RCP< FactoryBaseBuildTrilinosSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 TrilinosSmoother. More...
 
RCP< FactoryBaseBuildMatlabSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 MatlabSmoother. More...
 
RCP< FactoryBaseBuildDirectSolver (const Teuchos::ParameterList &paramList, const FactoryMap &, const FactoryManagerMap &) const
 
template<class T >
RCP< FactoryBaseBuildBlockedSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 
RCP< FactoryBaseBuildTekoSmoother (const Teuchos::ParameterList &paramList, const FactoryMap &factoryMapIn, const FactoryManagerMap &factoryManagersIn) const
 
RCP< FactoryBaseBuildBlockedDirectSolver (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
 
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. 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 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...
 

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 void SetMueLuOFileStream (const std::string &filename)
 
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...
 

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

◆ 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:

<Parameter name="smootherFact0" type="string" value="TrilinosSmoother">

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.

◆ BuildCoupledAggregationFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
RCP<FactoryBase> MueLu::FactoryFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildCoupledAggregationFactory ( const Teuchos::ParameterList &  paramList,
const FactoryMap factoryMapIn,
const FactoryManagerMap factoryManagersIn 
) const
inline

◆ 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 673 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 729 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 745 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 759 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 824 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 &  ,
const FactoryMap ,
const FactoryManagerMap  
) const
inline

Definition at line 846 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 863 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 926 of file MueLu_FactoryFactory_decl.hpp.


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