MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for generating coarse level map. Used by TentativePFactory. More...

#include <MueLu_CoarseMapFactory_decl.hpp>

Inheritance diagram for MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Public Member Functions

virtual size_t getFixedBlockSize () const
 getFixedBlockSize returns the full block size (number of DOFs per node) of the domain DOF map (= coarse map). This is the sum of all entries in the striding vector. e.g. for 2 velocity dofs and 1 pressure dof the return value is 3. More...
 
- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor. More...
 
virtual ~SingleLevelFactoryBase ()
 Destructor. More...
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
void EnableMultipleCallCheck () const
 Constructor. More...
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor. More...
 
virtual ~FactoryBase ()
 Destructor. More...
 
int GetID () const
 return unique factory id 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () 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 VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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 VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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)
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration. More...
 
virtual const RCP< const
FactoryBase
GetFactory (const std::string &varName) const =0
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
virtual void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values. More...
 
virtual const
Teuchos::ParameterList
GetParameterList () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry. More...
 
const ParameterEntryGetParameter (const std::string &name) const
 Retrieves a const entry with the name name. More...
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 

Protected Attributes

std::vector< size_t > stridingInfo_
 

Constructors/Destructors.

 CoarseMapFactory ()
 Constructor. More...
 
virtual ~CoarseMapFactory ()
 Destructor. More...
 
RCP< const ParameterListGetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

Input

void DeclareInput (Level &currentLevel) const
 Specifies the data that this class needs, and the factories that generate that data. More...
 

Build methods.

void Build (Level &currentLevel) const
 Build an object with this factory. More...
 

Get/Set functions

virtual std::vector< size_t > getStridingData () const
 getStridingData returns vector with size of striding blocks in the domain DOF map (= coarse map). e.g. for 2 velocity dofs and 1 pressure dof the vector is (2,1) More...
 
virtual void setStridingData (std::vector< size_t > stridingInfo)
 setStridingData set striding vector for the domain DOF map (= coarse map), e.g. (2,1) for 2 velocity dofs and 1 pressure dof More...
 
virtual LocalOrdinal getStridedBlockId () const
 getStridedBlockId returns strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map) More...
 
virtual void setStridedBlockId (LocalOrdinal stridedBlockId)
 setStridedBlockId set strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::Factory
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- 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< FancyOStreamgetDefaultOStream ()
 
- 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
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for generating coarse level map. Used by TentativePFactory.

Factory is used by TentativePFactory to generate the coarse level map (=domain map) of the prolongation operator. The number of DOFs is calculated by the following formula

\[ n_{Aggs}\cdot d_{blocksize} \]

where \( n_{Aggs} \) denotes the number of aggregates (generated by the AggregationFactory) and \( d_{blocksize}\) denotes the number of DOFs per node on the coarse level. For determing the blocksize the CoarseMapFactory supports strided map information. Per default stridedBlockId_ is -1 and the number of nullspace vectors (from "Nullspace") is used. Otherwise the block size is calculated using the striding information.

For each level we can declare an own offset value for the global id's of the prolongator domain map by setting the "Domain GID offsets" parameter. If the number of entries in that list is smaller than the number of levels we use the default offset 0 for the remaining coarse levels.

Input/output of CoarseMapFactory

User parameters of CoarseMapFactory

Parameter type default master.xml validated requested description
Aggregates Factory null * * Generating factory for aggregates. We basically need only the number of aggregates in this factory.
Nullspace Factory null * * Generating factory of the fine nullspace vectors (of type "MultiVector"). In the default case the same instance of the TentativePFactory is also the generating factory for the null space vectors (on the next coarser levels). Therefore, it is recommended to declare the TentativePFactory to be the generating factory of the "Nullspace" variable globally using the FactoryManager object! For defining the near null space vectors on the finest level one should use the NullspaceFactory.
Striding info std::string {} * String containing the striding information, e.g. {2,1} for a fixed block size of 3 with sub blocks of size 2 and 1 in each node.
Strided block id LocalOrdinal -1 * Strided block id in strided information vector or -1 (=default) for the full block information.
Domain GID offsets std::string {0} * String describing a std::vector with offsets for GIDs for each level. If no offset GID value is given for the level we use 0 as default.

The * in the master.xml column denotes that the parameter is defined in the master.xml file.
The * in the validated column means that the parameter is declared in the list of valid input parameters (see CoarseMapFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see CoarseMapFactory::DeclareInput).

Variables provided by CoarseMapFactory

After CoarseMapFactory::Build the following data is available (if requested)

Parameter generated by description
CoarseMap CoarseMapFactory Map containing the coarse map used as domain map in the tentative prolongation operator

Definition at line 114 of file MueLu_CoarseMapFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CoarseMapFactory ( )

Constructor.

Definition at line 69 of file MueLu_CoarseMapFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~CoarseMapFactory ( )
virtual

Destructor.

Definition at line 75 of file MueLu_CoarseMapFactory_def.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Implements MueLu::ParameterListAcceptor.

Definition at line 78 of file MueLu_CoarseMapFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual

Specifies the data that this class needs, and the factories that generate that data.

If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 101 of file MueLu_CoarseMapFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 118 of file MueLu_CoarseMapFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual size_t MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFixedBlockSize ( ) const
inlinevirtual

getFixedBlockSize returns the full block size (number of DOFs per node) of the domain DOF map (= coarse map). This is the sum of all entries in the striding vector. e.g. for 2 velocity dofs and 1 pressure dof the return value is 3.

Definition at line 159 of file MueLu_CoarseMapFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual std::vector<size_t> MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getStridingData ( ) const
inlinevirtual

getStridingData returns vector with size of striding blocks in the domain DOF map (= coarse map). e.g. for 2 velocity dofs and 1 pressure dof the vector is (2,1)

Definition at line 175 of file MueLu_CoarseMapFactory_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setStridingData ( std::vector< size_t >  stridingInfo)
virtual

setStridingData set striding vector for the domain DOF map (= coarse map), e.g. (2,1) for 2 velocity dofs and 1 pressure dof

Definition at line 107 of file MueLu_CoarseMapFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual LocalOrdinal MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getStridedBlockId ( ) const
inlinevirtual

getStridedBlockId returns strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map)

Definition at line 187 of file MueLu_CoarseMapFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setStridedBlockId ( LocalOrdinal  stridedBlockId)
inlinevirtual

setStridedBlockId set strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map)

Definition at line 196 of file MueLu_CoarseMapFactory_decl.hpp.

Member Data Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::vector<size_t> MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::stridingInfo_
mutableprotected

Definition at line 204 of file MueLu_CoarseMapFactory_decl.hpp.


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