Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.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
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/matrix/csr.hpp>
17#include <ginkgo/core/matrix/dense.hpp>
18#include <ginkgo/core/multigrid/multigrid_level.hpp>
19
20namespace gko {
21namespace multigrid {
22
23
46template <typename ValueType = default_precision, typename IndexType = int32>
47class Pgm : public EnableLinOp<Pgm<ValueType, IndexType>>,
48 public EnableMultigridLevel<ValueType> {
49 friend class EnableLinOp<Pgm>;
50 friend class EnablePolymorphicObject<Pgm, LinOp>;
51
52public:
53 using value_type = ValueType;
54 using index_type = IndexType;
55
61 std::shared_ptr<const LinOp> get_system_matrix() const
62 {
63 return system_matrix_;
64 }
65
75 IndexType* get_agg() noexcept { return agg_.get_data(); }
76
84 const IndexType* get_const_agg() const noexcept
85 {
86 return agg_.get_const_data();
87 }
88
90 {
96 unsigned GKO_FACTORY_PARAMETER_SCALAR(max_iterations, 15u);
97
104 double GKO_FACTORY_PARAMETER_SCALAR(max_unassigned_ratio, 0.05);
105
113 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic, false);
114
125 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
126 };
129
130protected:
131 void apply_impl(const LinOp* b, LinOp* x) const override
132 {
133 this->get_composition()->apply(b, x);
134 }
135
136 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
137 LinOp* x) const override
138 {
139 this->get_composition()->apply(alpha, b, beta, x);
140 }
141
142 explicit Pgm(std::shared_ptr<const Executor> exec)
143 : EnableLinOp<Pgm>(std::move(exec))
144 {}
145
146 explicit Pgm(const Factory* factory,
147 std::shared_ptr<const LinOp> system_matrix)
148 : EnableLinOp<Pgm>(factory->get_executor(), system_matrix->get_size()),
149 EnableMultigridLevel<ValueType>(system_matrix),
150 parameters_{factory->get_parameters()},
151 system_matrix_{system_matrix},
152 agg_(factory->get_executor(), system_matrix_->get_size()[0])
153 {
154 GKO_ASSERT(parameters_.max_unassigned_ratio <= 1.0);
155 GKO_ASSERT(parameters_.max_unassigned_ratio >= 0.0);
156 if (system_matrix_->get_size()[0] != 0) {
157 // generate on the existed matrix
158 this->generate();
159 }
160 }
161
162 void generate();
163
164private:
165 std::shared_ptr<const LinOp> system_matrix_{};
166 array<IndexType> agg_;
167};
168
169
170template <typename ValueType = default_precision, typename IndexType = int32>
171using AmgxPgm GKO_DEPRECATED(
172 "This class is deprecated and will be removed in the next "
173 "major release. Please use Pgm instead.") = Pgm<ValueType, IndexType>;
174
175
176} // namespace multigrid
177} // namespace gko
178
179
180#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:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
Definition lin_op.hpp:118
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
std::shared_ptr< Composition< ValueType > > get_composition() const
Returns the composition operators.
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:674
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
The EnableMultigridLevel gives the default implementation of MultigridLevel with composition and prov...
Definition multigrid_level.hpp:83
Definition pgm.hpp:127
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition pgm.hpp:48
const IndexType * get_const_agg() const noexcept
Returns the aggregate group.
Definition pgm.hpp:84
IndexType * get_agg() noexcept
Returns the aggregate group.
Definition pgm.hpp:75
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition pgm.hpp:61
#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:1018
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
double max_unassigned_ratio
The maximum ratio of unassigned number, which is valid in the interval 0.0 ~ 1.0.
Definition pgm.hpp:104