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
schwarz.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_DISTRIBUTED_PRECONDITIONER_SCHWARZ_HPP_
34#define GKO_PUBLIC_CORE_DISTRIBUTED_PRECONDITIONER_SCHWARZ_HPP_
35
36
37#include <ginkgo/config.hpp>
38
39
40#if GINKGO_BUILD_MPI
41
42
43#include <ginkgo/core/base/abstract_factory.hpp>
44#include <ginkgo/core/base/lin_op.hpp>
45#include <ginkgo/core/distributed/matrix.hpp>
46#include <ginkgo/core/distributed/vector.hpp>
47
48
49namespace gko {
50namespace experimental {
51namespace distributed {
57namespace preconditioner {
58
59
77template <typename ValueType = default_precision,
78 typename LocalIndexType = int32, typename GlobalIndexType = int64>
80 : public EnableLinOp<Schwarz<ValueType, LocalIndexType, GlobalIndexType>> {
81 friend class EnableLinOp<Schwarz>;
83
84public:
87 using value_type = ValueType;
88 using index_type = GlobalIndexType;
89 using local_index_type = LocalIndexType;
90 using global_index_type = GlobalIndexType;
91
93 {
97 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
98 local_solver);
99
103 std::shared_ptr<const LinOp> GKO_FACTORY_PARAMETER_SCALAR(
104 generated_local_solver, nullptr);
105 };
108
109protected:
115 explicit Schwarz(std::shared_ptr<const Executor> exec)
116 : EnableLinOp<Schwarz>(std::move(exec))
117 {}
118
126 explicit Schwarz(const Factory* factory,
127 std::shared_ptr<const LinOp> system_matrix)
128 : EnableLinOp<Schwarz>(factory->get_executor(),
129 gko::transpose(system_matrix->get_size())),
130 parameters_{factory->get_parameters()}
131 {
132 this->generate(system_matrix);
133 }
134
138 void generate(std::shared_ptr<const LinOp> system_matrix);
139
140 void apply_impl(const LinOp* b, LinOp* x) const override;
141
142 template <typename VectorType>
143 void apply_dense_impl(const VectorType* b, VectorType* x) const;
144
145 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
146 LinOp* x) const override;
147
148private:
154 void set_solver(std::shared_ptr<const LinOp> new_solver);
155
156 std::shared_ptr<const LinOp> local_solver_;
157};
158
159
160} // namespace preconditioner
161} // namespace distributed
162} // namespace experimental
163} // namespace gko
164
165
166#endif // GINKGO_BUILD_MPI
167#endif // GKO_PUBLIC_CORE_DISTRIBUTED_PRECONDITIONER_SCHWARZ_HPP_
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
void move_to(result_type *result) override
Definition polymorphic_object.hpp:760
void convert_to(result_type *result) const override
Definition polymorphic_object.hpp:758
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
A Schwarz preconditioner is a simple domain decomposition preconditioner that generalizes the Block J...
Definition schwarz.hpp:80
#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
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:137
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:205
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:143
batch_dim< 2, DimensionType > transpose(const batch_dim< 2, DimensionType > &input)
Returns a batch_dim object with its dimensions swapped for batched operators.
Definition batch_dim.hpp:148