Ginkgo Generated from branch based on master. Ginkgo version 1.8.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
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
20
21namespace gko {
22namespace multigrid {
23
24
42template <typename ValueType = default_precision, typename IndexType = int32>
44 : public EnableLinOp<FixedCoarsening<ValueType, IndexType>>,
45 public EnableMultigridLevel<ValueType> {
46 friend class EnableLinOp<FixedCoarsening>;
48
49public:
50 using value_type = ValueType;
51 using index_type = IndexType;
52
58 std::shared_ptr<const LinOp> get_system_matrix() const
59 {
60 return system_matrix_;
61 }
62
63
65 {
71
82 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
83 };
86
87protected:
88 void apply_impl(const LinOp* b, LinOp* x) const override
89 {
90 this->get_composition()->apply(b, x);
91 }
92
93 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
94 LinOp* x) const override
95 {
96 this->get_composition()->apply(alpha, b, beta, x);
97 }
98
99 explicit FixedCoarsening(std::shared_ptr<const Executor> exec)
100 : EnableLinOp<FixedCoarsening>(std::move(exec))
101 {}
102
103 explicit FixedCoarsening(const Factory* factory,
104 std::shared_ptr<const LinOp> system_matrix)
105 : EnableLinOp<FixedCoarsening>(factory->get_executor(),
106 system_matrix->get_size()),
107 EnableMultigridLevel<ValueType>(system_matrix),
108 parameters_{factory->get_parameters()},
109 system_matrix_{system_matrix}
110 {
111 if (system_matrix_->get_size()[0] != 0) {
112 // generate on the existing matrix
113 this->generate();
114 }
115 }
116
117 void generate();
118
119private:
120 std::shared_ptr<const LinOp> system_matrix_{};
121};
122
123
124} // namespace multigrid
125} // namespace gko
126
127
128#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: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
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:211
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
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 logger.hpp:25
The EnableMultigridLevel gives the default implementation of MultigridLevel with composition and prov...
Definition multigrid_level.hpp:83
Definition fixed_coarsening.hpp:84
FixedCoarsening is a very simple coarse grid generation algorithm.
Definition fixed_coarsening.hpp:45
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition fixed_coarsening.hpp:58
#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
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:461
The Ginkgo namespace.
Definition abstract_factory.hpp:20