Ginkgo  Generated from pipelines/1330831941 branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
pgm.hpp
1 // SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2 //
3 // SPDX-License-Identifier: BSD-3-Clause
4 
5 #ifndef GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
6 #define GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
7 
8 
9 #include <vector>
10 
11 
12 #include <ginkgo/core/base/composition.hpp>
13 #include <ginkgo/core/base/exception_helpers.hpp>
14 #include <ginkgo/core/base/lin_op.hpp>
15 #include <ginkgo/core/base/types.hpp>
16 #include <ginkgo/core/config/config.hpp>
17 #include <ginkgo/core/config/registry.hpp>
18 #include <ginkgo/core/config/type_descriptor.hpp>
19 #include <ginkgo/core/distributed/matrix.hpp>
20 #include <ginkgo/core/matrix/csr.hpp>
21 #include <ginkgo/core/matrix/dense.hpp>
22 #include <ginkgo/core/multigrid/multigrid_level.hpp>
23 
24 
25 namespace gko {
26 namespace multigrid {
27 
28 
51 template <typename ValueType = default_precision, typename IndexType = int32>
52 class Pgm : public EnableLinOp<Pgm<ValueType, IndexType>>,
53  public EnableMultigridLevel<ValueType> {
54  friend class EnableLinOp<Pgm>;
55  friend class EnablePolymorphicObject<Pgm, LinOp>;
56 
57 public:
58  using value_type = ValueType;
59  using index_type = IndexType;
60 
66  std::shared_ptr<const LinOp> get_system_matrix() const
67  {
68  return system_matrix_;
69  }
70 
80  IndexType* get_agg() noexcept { return agg_.get_data(); }
81 
89  const IndexType* get_const_agg() const noexcept
90  {
91  return agg_.get_const_data();
92  }
93 
95  {
101  unsigned GKO_FACTORY_PARAMETER_SCALAR(max_iterations, 15u);
102 
109  double GKO_FACTORY_PARAMETER_SCALAR(max_unassigned_ratio, 0.05);
110 
118  bool GKO_FACTORY_PARAMETER_SCALAR(deterministic, false);
119 
130  bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
131  };
134 
148  static parameters_type parse(
149  const config::pnode& config, const config::registry& context,
150  const config::type_descriptor& td_for_child =
151  config::make_type_descriptor<ValueType, IndexType>());
152 
153 protected:
154  void apply_impl(const LinOp* b, LinOp* x) const override
155  {
156  this->get_composition()->apply(b, x);
157  }
158 
159  void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
160  LinOp* x) const override
161  {
162  this->get_composition()->apply(alpha, b, beta, x);
163  }
164 
165  explicit Pgm(std::shared_ptr<const Executor> exec)
166  : EnableLinOp<Pgm>(std::move(exec))
167  {}
168 
169  explicit Pgm(const Factory* factory,
170  std::shared_ptr<const LinOp> system_matrix)
171  : EnableLinOp<Pgm>(factory->get_executor(), system_matrix->get_size()),
172  EnableMultigridLevel<ValueType>(system_matrix),
173  parameters_{factory->get_parameters()},
174  system_matrix_{system_matrix},
175  agg_(factory->get_executor(), system_matrix_->get_size()[0])
176  {
177  GKO_ASSERT(parameters_.max_unassigned_ratio <= 1.0);
178  GKO_ASSERT(parameters_.max_unassigned_ratio >= 0.0);
179  if (system_matrix_->get_size()[0] != 0) {
180  // generate on the existed matrix
181  this->generate();
182  }
183  }
184 
185  void generate();
186 
192  std::tuple<std::shared_ptr<LinOp>, std::shared_ptr<LinOp>,
193  std::shared_ptr<LinOp>>
194  generate_local(
195  std::shared_ptr<const matrix::Csr<ValueType, IndexType>> local_matrix);
196 
197 #if GINKGO_BUILD_MPI
198  template <typename GlobalIndexType>
199  void communicate(std::shared_ptr<const experimental::distributed::Matrix<
200  ValueType, IndexType, GlobalIndexType>>
201  matrix,
202  const array<IndexType>& local_agg,
203  array<IndexType>& non_local_agg);
204 #endif
205 
206 private:
207  std::shared_ptr<const LinOp> system_matrix_{};
208  array<IndexType> agg_;
209 };
210 
211 
212 template <typename ValueType = default_precision, typename IndexType = int32>
213 using AmgxPgm GKO_DEPRECATED(
214  "This class is deprecated and will be removed in the next "
215  "major release. Please use Pgm instead.") = Pgm<ValueType, IndexType>;
216 
217 
218 } // namespace multigrid
219 } // namespace gko
220 
221 
222 #endif // GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
gko::config::pnode
pnode describes a tree of properties.
Definition: property_tree.hpp:28
gko::LinOp
Definition: lin_op.hpp:118
gko::log::profile_event_category::factory
LinOpFactory events.
gko::UseComposition::get_composition
std::shared_ptr< Composition< ValueType > > get_composition() const
Returns the composition operators.
Definition: composition.hpp:186
GKO_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition: abstract_factory.hpp:445
gko::config::type_descriptor
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition: type_descriptor.hpp:37
gko
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::multigrid::Pgm::get_agg
IndexType * get_agg() noexcept
Returns the aggregate group.
Definition: pgm.hpp:80
gko::multigrid::Pgm
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition: matrix.hpp:37
gko::multigrid::Pgm::Factory
Definition: pgm.hpp:132
GKO_ENABLE_LIN_OP_FACTORY
#define GKO_ENABLE_LIN_OP_FACTORY(_lin_op, _parameters_name, _factory_name)
This macro will generate a default implementation of a LinOpFactory for the LinOp subclass it is defi...
Definition: lin_op.hpp:1018
gko::array::get_data
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:674
gko::multigrid::Pgm::get_const_agg
const IndexType * get_const_agg() const noexcept
Returns the aggregate group.
Definition: pgm.hpp:89
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition: registry.hpp:168
GKO_ENABLE_BUILD_METHOD
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition: abstract_factory.hpp:394
GKO_CREATE_FACTORY_PARAMETERS
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition: abstract_factory.hpp:280
gko::array::get_const_data
const value_type * get_const_data() const noexcept
Returns a constant pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:683
gko::PolymorphicObject::get_executor
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition: polymorphic_object.hpp:235
gko::multigrid::Pgm::get_system_matrix
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition: pgm.hpp:66
gko::LinOp::get_size
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition: lin_op.hpp:211
gko::multigrid::Pgm::parse
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
gko::multigrid::Pgm::parameters_type::max_unassigned_ratio
double max_unassigned_ratio
The maximum ratio of unassigned number, which is valid in the interval 0.0 ~ 1.0.
Definition: pgm.hpp:109
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:878
gko::LinOp::LinOp
LinOp(const LinOp &)=default
Copy-constructs a LinOp.