Ginkgo: ginkgo/core/multigrid/pgm.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
pgm.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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>
51 class Pgm : public EnableLinOp<Pgm<ValueType, IndexType>>,
52 public EnableMultigridLevel<ValueType> {
53 friend class EnableLinOp<Pgm>;
54 friend class EnablePolymorphicObject<Pgm, LinOp>;
55 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
56
57public:
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
94 GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
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 };
132 GKO_ENABLE_LIN_OP_FACTORY(Pgm, parameters, Factory);
133 GKO_ENABLE_BUILD_METHOD(Factory);
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
153protected:
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
211 template <typename GlobalIndexType>
212 array<GlobalIndexType> communicate_non_local_agg(
213 std::shared_ptr<const experimental::distributed::Matrix<
214 ValueType, IndexType, GlobalIndexType>>
215 matrix,
216 std::shared_ptr<
217 experimental::distributed::Partition<IndexType, GlobalIndexType>>
218 coarse_partition,
219 const array<IndexType>& local_agg);
220#endif
221
222private:
223 std::shared_ptr<const LinOp> system_matrix_{};
224 array<IndexType> agg_;
225};
226
227
228template <typename ValueType = default_precision, typename IndexType = int32>
229using AmgxPgm GKO_DEPRECATED(
230 "This class is deprecated and will be removed in the next "
231 "major release. Please use Pgm instead.") = Pgm<ValueType, IndexType>;
232
233
234} // namespace multigrid
235} // namespace gko
236
237
238#endif // GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::LinOp
Definition lin_op.hpp:117
gko::UseComposition< default_precision >::get_composition
std::shared_ptr< Composition< default_precision > > get_composition() const
Definition composition.hpp:187
gko::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
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:39
gko::multigrid::Pgm::Factory
Definition pgm.hpp:132
gko::multigrid::Pgm
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition pgm.hpp:52
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::get_const_agg
const IndexType * get_const_agg() const noexcept
Returns the aggregate group.
Definition pgm.hpp:89
gko::multigrid::Pgm::get_agg
IndexType * get_agg() noexcept
Returns the aggregate group.
Definition pgm.hpp:80
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_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_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_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_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:1017
gko::multigrid
The multigrid components namespace.
Definition matrix.hpp:36
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::layout_type::array
@ array
The matrix should be written as dense matrix in column-major order.
Definition mtx_io.hpp:97
std
STL namespace.
gko::multigrid::Pgm::parameters_type
Definition pgm.hpp:95
gko::multigrid::Pgm::parameters_type::deterministic
bool deterministic
Use the deterministic assign_to_exist_agg method or not.
Definition pgm.hpp:118
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::multigrid::Pgm::parameters_type::skip_sorting
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition pgm.hpp:130
gko::multigrid::Pgm::parameters_type::max_iterations
unsigned max_iterations
The maximum number of iterations.
Definition pgm.hpp:101