MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_BlockedCoarseMapFactory_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // MueLu: A package for multigrid based preconditioning
4 //
5 // Copyright 2012 NTESS and the MueLu contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
11 #define MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
12 
13 #include "MueLu_ConfigDefs.hpp"
14 #include "MueLu_CoarseMapFactory.hpp"
15 
16 #include "MueLu_Level_fwd.hpp"
17 #include "MueLu_Aggregates_fwd.hpp"
18 #include "MueLu_Exceptions.hpp"
19 
20 namespace MueLu {
21 
55 template <class Scalar = DefaultScalar,
58  class Node = DefaultNode>
59 class BlockedCoarseMapFactory : public MueLu::CoarseMapFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> { // SingleLevelFactoryBase {
60 #undef MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
61 #include "MueLu_UseShortNames.hpp"
62 
63  public:
65 
66 
68 
74  void DeclareInput(Level &currentLevel) const final;
75 
77 
79 
80 
82  void Build(Level &currentLevel) const final;
83 
85 
86  protected:
88  virtual GlobalOrdinal GetDomainGIDOffset(Level &currentLevel) const final;
89 
90 }; // class BlockedCoarseMapFactory
91 
92 } // namespace MueLu
93 
94 #define MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
95 #endif /* MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_ */
RCP< const ParameterList > GetValidParameterList() const final
Return a const parameter list of valid parameters that setParameterList() will accept.
MueLu::DefaultLocalOrdinal LocalOrdinal
Factory for generating coarse level map. Used by TentativePFactory.
void Build(Level &currentLevel) const final
Build an object with this factory.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:63
Factory for generating coarse level map. Used by BlockedPFactory.
virtual GlobalOrdinal GetDomainGIDOffset(Level &currentLevel) const final
Compute domain GID offset from another CoarseMap.
void DeclareInput(Level &currentLevel) const final
Specifies the data that this class needs, and the factories that generate that data.