Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
schwarz.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_PRECONDITIONER_SCHWARZ_HPP_
6#define GKO_PUBLIC_CORE_DISTRIBUTED_PRECONDITIONER_SCHWARZ_HPP_
7
8
9#include <ginkgo/config.hpp>
10
11
12#if GINKGO_BUILD_MPI
13
14
15#include <ginkgo/core/base/abstract_factory.hpp>
16#include <ginkgo/core/base/lin_op.hpp>
17#include <ginkgo/core/config/config.hpp>
18#include <ginkgo/core/config/registry.hpp>
19#include <ginkgo/core/config/type_descriptor.hpp>
20#include <ginkgo/core/distributed/matrix.hpp>
21#include <ginkgo/core/distributed/vector.hpp>
22#include <ginkgo/core/distributed/vector_cache.hpp>
23#include <ginkgo/core/solver/solver_base.hpp>
24
25
26namespace gko {
27namespace experimental {
28namespace distributed {
34namespace preconditioner {
35
36
67template <typename ValueType = default_precision,
68 typename LocalIndexType = int32, typename GlobalIndexType = int64>
69class Schwarz
70 : public EnableLinOp<Schwarz<ValueType, LocalIndexType, GlobalIndexType>> {
71 friend class EnableLinOp<Schwarz>;
72 friend class EnablePolymorphicObject<Schwarz, LinOp>;
73
74public:
75 using EnableLinOp<Schwarz>::convert_to;
76 using EnableLinOp<Schwarz>::move_to;
77 using value_type = ValueType;
78 using index_type = GlobalIndexType;
79 using local_index_type = LocalIndexType;
80 using global_index_type = GlobalIndexType;
81
90 bool apply_uses_initial_guess() const override;
91
93 {
97 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
99
103 std::shared_ptr<const LinOp> GKO_FACTORY_PARAMETER_SCALAR(
105
118
126 ValueType GKO_FACTORY_PARAMETER_SCALAR(coarse_weight, ValueType{-1.0});
127
136 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
138
142 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
144 };
145 GKO_ENABLE_LIN_OP_FACTORY(Schwarz, parameters, Factory);
147
163 const config::pnode& config, const config::registry& context,
164 const config::type_descriptor& td_for_child =
165 config::make_type_descriptor<ValueType, LocalIndexType,
166 GlobalIndexType>());
167
168protected:
174 explicit Schwarz(std::shared_ptr<const Executor> exec)
175 : EnableLinOp<Schwarz>(std::move(exec))
176 {}
177
185 explicit Schwarz(const Factory* factory,
186 std::shared_ptr<const LinOp> system_matrix)
187 : EnableLinOp<Schwarz>(factory->get_executor(),
188 gko::transpose(system_matrix->get_size())),
189 parameters_{factory->get_parameters()},
190 system_matrix_{system_matrix}
191 {
192 this->generate(system_matrix);
193 }
194
198 void generate(std::shared_ptr<const LinOp> system_matrix);
199
200 void apply_impl(const LinOp* b, LinOp* x) const override;
201
202 template <typename VectorType>
203 void apply_dense_impl(const VectorType* b, VectorType* x) const;
204
205 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
206 LinOp* x) const override;
207
208private:
214 void set_solver(std::shared_ptr<const LinOp> new_solver);
215
216 std::shared_ptr<const LinOp> local_solver_;
217 std::shared_ptr<const LinOp> system_matrix_;
218
219 // Used for advanced apply
220 detail::VectorCache<ValueType> cache_;
221 // Used in apply for two-level method
222 detail::VectorCache<ValueType> csol_cache_;
223 detail::VectorCache<ValueType> crhs_cache_;
224
225 std::shared_ptr<const LinOp> coarse_level_;
226 std::shared_ptr<const LinOp> coarse_solver_;
227 std::shared_ptr<const matrix::Dense<ValueType>> coarse_weight_;
228 std::shared_ptr<const matrix::Dense<ValueType>> local_weight_;
229};
230
231
232} // namespace preconditioner
233} // namespace distributed
234} // namespace experimental
235} // namespace gko
236
237
238#endif // GINKGO_BUILD_MPI
239#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:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
Definition lin_op.hpp:117
LinOp(const LinOp &)=default
Copy-constructs a LinOp.
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:243
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
A Schwarz preconditioner is a simple domain decomposition preconditioner that generalizes the Block J...
Definition schwarz.hpp:70
bool apply_uses_initial_guess() const override
Return whether the local solvers use the data in x as an initial guess.
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, LocalIndexType, GlobalIndexType >())
Create the parameters from the property_tree.
#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
The Preconditioner namespace.
Definition schwarz.hpp:34
The distributed namespace.
Definition polymorphic_object.hpp:19
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:107
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:172
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:113
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:119
STL namespace.
std::shared_ptr< const LinOpFactory > coarse_level
Operator factory list to generate the triplet (prolong_op, coarse_op, restrict_op),...
Definition schwarz.hpp:137
std::shared_ptr< const LinOp > generated_local_solver
Generated Inner solvers.
Definition schwarz.hpp:104
std::shared_ptr< const LinOpFactory > local_solver
Local solver factory.
Definition schwarz.hpp:98
std::shared_ptr< const LinOpFactory > coarse_solver
Coarse solver factory.
Definition schwarz.hpp:143
bool l1_smoother
Enable l1 smoother.
Definition schwarz.hpp:117
ValueType coarse_weight
Coarse weighting.
Definition schwarz.hpp:126