Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
fixed_coarsening.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_MULTIGRID_FIXED_COARSENING_HPP_
34#define GKO_PUBLIC_CORE_MULTIGRID_FIXED_COARSENING_HPP_
35
36
37#include <vector>
38
39
40#include <ginkgo/core/base/composition.hpp>
41#include <ginkgo/core/base/exception_helpers.hpp>
42#include <ginkgo/core/base/lin_op.hpp>
43#include <ginkgo/core/base/types.hpp>
44#include <ginkgo/core/matrix/csr.hpp>
45#include <ginkgo/core/matrix/dense.hpp>
46#include <ginkgo/core/multigrid/multigrid_level.hpp>
47
48namespace gko {
49namespace multigrid {
50
51
69template <typename ValueType = default_precision, typename IndexType = int32>
71 : public EnableLinOp<FixedCoarsening<ValueType, IndexType>>,
72 public EnableMultigridLevel<ValueType> {
73 friend class EnableLinOp<FixedCoarsening>;
75
76public:
77 using value_type = ValueType;
78 using index_type = IndexType;
79
85 std::shared_ptr<const LinOp> get_system_matrix() const
86 {
87 return system_matrix_;
88 }
89
90
113
114protected:
115 void apply_impl(const LinOp* b, LinOp* x) const override
116 {
117 this->get_composition()->apply(b, x);
118 }
119
120 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
121 LinOp* x) const override
122 {
123 this->get_composition()->apply(alpha, b, beta, x);
124 }
125
126 explicit FixedCoarsening(std::shared_ptr<const Executor> exec)
127 : EnableLinOp<FixedCoarsening>(std::move(exec))
128 {}
129
130 explicit FixedCoarsening(const Factory* factory,
131 std::shared_ptr<const LinOp> system_matrix)
132 : EnableLinOp<FixedCoarsening>(factory->get_executor(),
133 system_matrix->get_size()),
134 EnableMultigridLevel<ValueType>(system_matrix),
135 parameters_{factory->get_parameters()},
136 system_matrix_{system_matrix}
137 {
138 if (system_matrix_->get_size()[0] != 0) {
139 // generate on the existing matrix
140 this->generate();
141 }
142 }
143
144 void generate();
145
146private:
147 std::shared_ptr<const LinOp> system_matrix_{};
148};
149
150
151} // namespace multigrid
152} // namespace gko
153
154
155#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:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
std::shared_ptr< Composition< ValueType > > get_composition() const
Returns the composition operators.
Definition composition.hpp:214
An array is a container which encapsulates fixed-sized arrays, stored on the Executor tied to the arr...
Definition array.hpp:187
The EnableMultigridLevel gives the default implementation of MultigridLevel with composition and prov...
Definition multigrid_level.hpp:111
Definition fixed_coarsening.hpp:111
FixedCoarsening is a very simple coarse grid generation algorithm.
Definition fixed_coarsening.hpp:72
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition fixed_coarsening.hpp:85
#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:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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:422
#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:1046
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:489
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803