MueLu Version of the Day
|
Factory for generating coarse level map. Used by TentativePFactory. More...
#include <MueLu_CoarseMapFactory_decl.hpp>
Get/Set functions | |
std::vector< size_t > | stridingInfo_ |
Vector with size of strided blocks (dofs) | |
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) | |
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 | |
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) | |
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) | |
virtual void | BuildCoarseMap (Level ¤tLevel, const GlobalOrdinal domainGIDOffset) const |
Build the coarse map using the domain GID offset. | |
virtual GlobalOrdinal | GetDomainGIDOffset (Level ¤tLevel) const |
Extract domain GID offset from user data. | |
virtual void | CheckForConsistentStridingInformation (LocalOrdinal stridedBlockId, const size_t nullspaceDimension) const |
Input | |
RCP< const ParameterList > | GetValidParameterList () const override |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
void | DeclareInput (Level ¤tLevel) const override |
Specifies the data that this class needs, and the factories that generate that data. | |
Build methods. | |
void | Build (Level ¤tLevel) const override |
Build an object with this factory. | |
virtual size_t | getFixedBlockSize () const |
Get information on the fixed block size. | |
Additional Inherited Members | |
![]() | |
SingleLevelFactoryBase () | |
Constructor. | |
virtual | ~SingleLevelFactoryBase () |
Destructor. | |
virtual void | CallBuild (Level &requestedLevel) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
![]() | |
Factory () | |
Constructor. | |
virtual | ~Factory () |
Destructor. | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() | |
RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
void | EnableMultipleCallCheck () const |
void | DisableMultipleCallCheck () const |
void | ResetDebugData () const |
![]() | |
FactoryBase () | |
Constructor. | |
virtual | ~FactoryBase () |
Destructor. | |
int | GetID () const |
return unique factory id | |
![]() | |
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 |
![]() | |
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. | |
![]() | |
virtual | ~FactoryAcceptor () |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
Configuration. | |
virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. | |
virtual const Teuchos::ParameterList & | GetParameterList () const |
void | SetParameter (const std::string &name, const ParameterEntry &entry) |
Set a parameter directly as a ParameterEntry. | |
const ParameterEntry & | GetParameter (const std::string &name) const |
Retrieves a const entry with the name name. | |
virtual void | GetDocumentation (std::ostream &os) const |
![]() | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
![]() | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
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 () |
![]() | |
void | Input (Level &level, const std::string &varName) const |
void | Input (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
void | Set (Level &level, const std::string &varName, const T &data) const |
bool | IsAvailable (Level &level, const std::string &varName) const |
![]() | |
static bool | timerSync_ = false |
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.
By setting the "Domain GID offsets" parameter, we can specify the GID offset manually for each level. 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.
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 GetValidParameters()
).
The * in the requested
column states that the data is requested as input with all dependencies (see DeclareInput()
).
BlockedCoarseMapFactory
.After 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 |
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.
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).
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.
|
overridevirtual |
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.
Reimplemented from MueLu::Factory.
Definition at line 69 of file MueLu_CoarseMapFactory_def.hpp.
|
overridevirtual |
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 93 of file MueLu_CoarseMapFactory_def.hpp.
|
overridevirtual |
Build an object with this factory.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 112 of file MueLu_CoarseMapFactory_def.hpp.
|
inlinevirtual |
Get information on the fixed block size.
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 150 of file MueLu_CoarseMapFactory_decl.hpp.
|
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 166 of file MueLu_CoarseMapFactory_decl.hpp.
|
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 100 of file MueLu_CoarseMapFactory_def.hpp.
|
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 178 of file MueLu_CoarseMapFactory_decl.hpp.
|
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 187 of file MueLu_CoarseMapFactory_decl.hpp.
|
protectedvirtual |
Build the coarse map using the domain GID offset.
Definition at line 121 of file MueLu_CoarseMapFactory_def.hpp.
|
protectedvirtual |
Extract domain GID offset from user data.
Reimplemented in MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 165 of file MueLu_CoarseMapFactory_def.hpp.
|
privatevirtual |
Definition at line 188 of file MueLu_CoarseMapFactory_def.hpp.
|
mutableprivate |
Vector with size of strided blocks (dofs)
Definition at line 207 of file MueLu_CoarseMapFactory_decl.hpp.