Ginkgo Generated from branch based on main. Ginkgo version 1.9.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
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#include <ginkgo/core/base/composition.hpp>
12#include <ginkgo/core/base/exception_helpers.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/types.hpp>
15#include <ginkgo/core/config/config.hpp>
16#include <ginkgo/core/config/registry.hpp>
17#include <ginkgo/core/config/type_descriptor.hpp>
18#include <ginkgo/core/distributed/matrix.hpp>
19#include <ginkgo/core/matrix/csr.hpp>
20#include <ginkgo/core/matrix/dense.hpp>
21#include <ginkgo/core/multigrid/multigrid_level.hpp>
22
23
24namespace gko {
25namespace multigrid {
26
27
50template <typename ValueType = default_precision, typename IndexType = int32>
51class Pgm : public EnableLinOp<Pgm<ValueType, IndexType>>,
52 public EnableMultigridLevel<ValueType> {
53 friend class EnableLinOp<Pgm>;
54 friend class EnablePolymorphicObject<Pgm, LinOp>;
55
56public:
57 using value_type = ValueType;
58 using index_type = IndexType;
59
65 std::shared_ptr<const LinOp> get_system_matrix() const
66 {
67 return system_matrix_;
68 }
69
79 IndexType* get_agg() noexcept { return agg_.get_data(); }
80
88 const IndexType* get_const_agg() const noexcept
89 {
90 return agg_.get_const_data();
91 }
92
94 {
100 unsigned GKO_FACTORY_PARAMETER_SCALAR(max_iterations, 15u);
101
108 double GKO_FACTORY_PARAMETER_SCALAR(max_unassigned_ratio, 0.05);
109
117 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic, false);
118
129 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
130 };
133
148 const config::pnode& config, const config::registry& context,
149 const config::type_descriptor& td_for_child =
150 config::make_type_descriptor<ValueType, IndexType>());
151
152protected:
153 void apply_impl(const LinOp* b, LinOp* x) const override
154 {
155 this->get_composition()->apply(b, x);
156 }
157
158 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
159 LinOp* x) const override
160 {
161 this->get_composition()->apply(alpha, b, beta, x);
162 }
163
164 explicit Pgm(std::shared_ptr<const Executor> exec)
165 : EnableLinOp<Pgm>(std::move(exec))
166 {}
167
168 explicit Pgm(const Factory* factory,
169 std::shared_ptr<const LinOp> system_matrix)
170 : EnableLinOp<Pgm>(factory->get_executor(), system_matrix->get_size()),
171 EnableMultigridLevel<ValueType>(system_matrix),
172 parameters_{factory->get_parameters()},
173 system_matrix_{system_matrix},
174 agg_(factory->get_executor(), system_matrix_->get_size()[0])
175 {
176 GKO_ASSERT(parameters_.max_unassigned_ratio <= 1.0);
177 GKO_ASSERT(parameters_.max_unassigned_ratio >= 0.0);
178 if (system_matrix_->get_size()[0] != 0) {
179 // generate on the existed matrix
180 this->generate();
181 }
182 }
183
184 void generate();
185
191 std::tuple<std::shared_ptr<LinOp>, std::shared_ptr<LinOp>,
192 std::shared_ptr<LinOp>>
193 generate_local(
194 std::shared_ptr<const matrix::Csr<ValueType, IndexType>> local_matrix);
195
196#if GINKGO_BUILD_MPI
197 template <typename GlobalIndexType>
198 void communicate(std::shared_ptr<const experimental::distributed::Matrix<
199 ValueType, IndexType, GlobalIndexType>>
200 matrix,
201 const array<IndexType>& local_agg,
202 array<IndexType>& non_local_agg);
203#endif
204
205private:
206 std::shared_ptr<const LinOp> system_matrix_{};
207 array<IndexType> agg_;
208};
209
210
211template <typename ValueType = default_precision, typename IndexType = int32>
212using AmgxPgm GKO_DEPRECATED(
213 "This class is deprecated and will be removed in the next "
214 "major release. Please use Pgm instead.") = Pgm<ValueType, IndexType>;
215
216
217} // namespace multigrid
218} // namespace gko
219
220
221#endif // GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
Definition lin_op.hpp:117
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:210
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:234
std::shared_ptr< Composition< default_precision > > get_composition() const
Definition composition.hpp:186
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition array.hpp:673
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:682
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
The EnableMultigridLevel gives the default implementation of MultigridLevel with composition and prov...
Definition multigrid_level.hpp:82
Definition pgm.hpp:131
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition pgm.hpp:52
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.
const IndexType * get_const_agg() const noexcept
Returns the aggregate group.
Definition pgm.hpp:88
IndexType * get_agg() noexcept
Returns the aggregate group.
Definition pgm.hpp:79
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition pgm.hpp:65
#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
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#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
#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:1017
The Ginkgo namespace.
Definition abstract_factory.hpp:20
STL namespace.
double max_unassigned_ratio
The maximum ratio of unassigned number, which is valid in the interval 0.0 ~ 1.0.
Definition pgm.hpp:108