MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_RepartitionHeuristicFactory_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 PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_
11 #define PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_
12 
13 #include "MueLu_ConfigDefs.hpp"
14 #ifdef HAVE_MPI
15 
16 // Some classes are only used in the definition (_def.hpp) of this class
17 // but forward declarations are needed here to enable the UseShortNames mechanism.
18 #include <Xpetra_Map_fwd.hpp>
19 #include <Xpetra_Matrix_fwd.hpp>
20 
23 #include "MueLu_RAPFactory_fwd.hpp"
26 
27 namespace MueLu {
28 
73 template <class Scalar = DefaultScalar,
76  class Node = DefaultNode>
78 #undef MUELU_REPARTITIONHEURISTICFACTORY_SHORT
79 #include "MueLu_UseShortNames.hpp"
80 
81  public:
83 
84 
87 
90 
92 
94 
96 
97 
103  void DeclareInput(Level& currentLevel) const;
104 
106 
108 
109 
111  void Build(Level& currentLevel) const;
112 
114 }; // class RepartitionHeuristicFactory
115 
116 } // namespace MueLu
117 
118 #define MUELU_REPARTITIONHEURISTICFACTORY_SHORT
119 
120 #endif // ifdef HAVE_MPI
121 #endif /* PACKAGES_MUELU_SRC_REBALANCING_MUELU_REPARTITIONHEURISTICFACTORY_DECL_HPP_ */
virtual ~RepartitionHeuristicFactory()
Destructor.
MueLu::DefaultLocalOrdinal LocalOrdinal
Factory for determing the number of partitions for rebalancing.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
void Build(Level &currentLevel) const
Build an object with this factory.
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
void DeclareInput(Level &currentLevel) const
Determines the data that RepartitionHeuristicFactory needs, and the factories that generate that data...
Base class for factories that use one level (currentLevel).
RepartitionHeuristicFactory()
Constructor.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.