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
fixed_coarsening.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_MULTIGRID_FIXED_COARSENING_HPP_
6#define GKO_PUBLIC_CORE_MULTIGRID_FIXED_COARSENING_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/matrix/csr.hpp>
16#include <ginkgo/core/matrix/dense.hpp>
17#include <ginkgo/core/multigrid/multigrid_level.hpp>
18
19
20namespace gko {
21namespace multigrid {
22
23
41template <typename ValueType = default_precision, typename IndexType = int32>
42class FixedCoarsening
43 : public EnableLinOp<FixedCoarsening<ValueType, IndexType>>,
44 public EnableMultigridLevel<ValueType> {
45 friend class EnableLinOp<FixedCoarsening>;
46 friend class EnablePolymorphicObject<FixedCoarsening, LinOp>;
47
48public:
49 using value_type = ValueType;
50 using index_type = IndexType;
51
57 std::shared_ptr<const LinOp> get_system_matrix() const
58 {
59 return system_matrix_;
60 }
61
62
83 GKO_ENABLE_LIN_OP_FACTORY(FixedCoarsening, parameters, Factory);
85
86protected:
87 void apply_impl(const LinOp* b, LinOp* x) const override
88 {
89 this->get_composition()->apply(b, x);
90 }
91
92 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
93 LinOp* x) const override
94 {
95 this->get_composition()->apply(alpha, b, beta, x);
96 }
97
98 explicit FixedCoarsening(std::shared_ptr<const Executor> exec)
99 : EnableLinOp<FixedCoarsening>(std::move(exec))
100 {}
101
102 explicit FixedCoarsening(const Factory* factory,
103 std::shared_ptr<const LinOp> system_matrix)
104 : EnableLinOp<FixedCoarsening>(factory->get_executor(),
105 system_matrix->get_size()),
106 EnableMultigridLevel<ValueType>(system_matrix),
107 parameters_{factory->get_parameters()},
108 system_matrix_{system_matrix}
109 {
110 if (system_matrix_->get_size()[0] != 0) {
111 // generate on the existing matrix
112 this->generate();
113 }
114 }
115
116 void generate();
117
118private:
119 std::shared_ptr<const LinOp> system_matrix_{};
120};
121
122
123} // namespace multigrid
124} // namespace gko
125
126
127#endif // GKO_PUBLIC_CORE_MULTIGRID_FIXED_COARSENING_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
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:166
Definition fixed_coarsening.hpp:83
FixedCoarsening is a very simple coarse grid generation algorithm.
Definition fixed_coarsening.hpp:44
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition fixed_coarsening.hpp:57
#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
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:461
The multigrid components namespace.
Definition matrix.hpp:34
The Ginkgo namespace.
Definition abstract_factory.hpp:20
STL namespace.
array< IndexType > coarse_rows
This array specifies the rows of the fine matrix which should be selected as rows for the coarse matr...
Definition fixed_coarsening.hpp:69
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition fixed_coarsening.hpp:81