MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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

#include <MueLu_BlockedCoarseMapFactory_decl.hpp>

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

Input

RCP< const ParameterList > GetValidParameterList () const final
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void DeclareInput (Level &currentLevel) const final
 Specifies the data that this class needs, and the factories that generate that data.
 

Build methods.

void Build (Level &currentLevel) const final
 Build an object with this factory.
 
virtual GlobalOrdinal GetDomainGIDOffset (Level &currentLevel) const final
 Compute domain GID offset from another CoarseMap.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >
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)
 
RCP< const ParameterList > GetValidParameterList () const override
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void DeclareInput (Level &currentLevel) const override
 Specifies the data that this class needs, and the factories that generate that data.
 
void Build (Level &currentLevel) const override
 Build an object with this factory.
 
virtual size_t getFixedBlockSize () const
 Get information on the fixed block size.
 
- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor.
 
virtual ~SingleLevelFactoryBase ()
 Destructor.
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration.
 
const RCP< const FactoryBaseGetFactory (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
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- 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.
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
 Configuration.
 
virtual const RCP< const FactoryBaseGetFactory (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.
 
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
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- 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 ()
 
- Protected Member Functions inherited from MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual void BuildCoarseMap (Level &currentLevel, const GlobalOrdinal domainGIDOffset) const
 Build the coarse map using the domain GID offset.
 
- Protected Member Functions inherited from MueLu::Factory
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 >
Get (Level &level, const std::string &varName) const
 
template<class 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 Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

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

Factory for generating coarse level map. Used by BlockedPFactory.

Overloads CoarseMapFactory. Uses a "CoarseMap" generated by another CoarseMapFactory as input and automatically calculates the domain offset using the max GID from the given coarse map.

Input/output

User parameters for this factory

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.
Coarse Map Factory null * Generating factory of another coarse map to be used for calculating the GID offset for the map to be generated.

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() ).

Variables provided by this factory

After Build(), the following data is available (if requested)

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

Definition at line 97 of file MueLu_BlockedCoarseMapFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

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 64 of file MueLu_BlockedCoarseMapFactory_def.hpp.

◆ DeclareInput()

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

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 80 of file MueLu_BlockedCoarseMapFactory_def.hpp.

◆ Build()

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

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 92 of file MueLu_BlockedCoarseMapFactory_def.hpp.

◆ GetDomainGIDOffset()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
GlobalOrdinal MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDomainGIDOffset ( Level currentLevel) const
finalprotectedvirtual

Compute domain GID offset from another CoarseMap.

Reimplemented from MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 101 of file MueLu_BlockedCoarseMapFactory_def.hpp.


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