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
schwarz.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 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
24
25namespace gko {
26namespace experimental {
27namespace distributed {
33namespace preconditioner {
34
35
54template <typename ValueType = default_precision,
55 typename LocalIndexType = int32, typename GlobalIndexType = int64>
56class Schwarz
57 : public EnableLinOp<Schwarz<ValueType, LocalIndexType, GlobalIndexType>> {
58 friend class EnableLinOp<Schwarz>;
59 friend class EnablePolymorphicObject<Schwarz, LinOp>;
60
61public:
62 using EnableLinOp<Schwarz>::convert_to;
63 using EnableLinOp<Schwarz>::move_to;
64 using value_type = ValueType;
65 using index_type = GlobalIndexType;
66 using local_index_type = LocalIndexType;
67 using global_index_type = GlobalIndexType;
68
77 bool apply_uses_initial_guess() const override;
78
80 {
84 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
86
90 std::shared_ptr<const LinOp> GKO_FACTORY_PARAMETER_SCALAR(
92 };
93 GKO_ENABLE_LIN_OP_FACTORY(Schwarz, parameters, Factory);
95
111 const config::pnode& config, const config::registry& context,
112 const config::type_descriptor& td_for_child =
113 config::make_type_descriptor<ValueType, LocalIndexType,
114 GlobalIndexType>());
115
116protected:
122 explicit Schwarz(std::shared_ptr<const Executor> exec)
123 : EnableLinOp<Schwarz>(std::move(exec))
124 {}
125
133 explicit Schwarz(const Factory* factory,
134 std::shared_ptr<const LinOp> system_matrix)
135 : EnableLinOp<Schwarz>(factory->get_executor(),
136 gko::transpose(system_matrix->get_size())),
137 parameters_{factory->get_parameters()}
138 {
139 this->generate(system_matrix);
140 }
141
145 void generate(std::shared_ptr<const LinOp> system_matrix);
146
147 void apply_impl(const LinOp* b, LinOp* x) const override;
148
149 template <typename VectorType>
150 void apply_dense_impl(const VectorType* b, VectorType* x) const;
151
152 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
153 LinOp* x) const override;
154
155private:
161 void set_solver(std::shared_ptr<const LinOp> new_solver);
162
163 std::shared_ptr<const LinOp> local_solver_;
164
165 detail::VectorCache<ValueType> cache_;
166};
167
168
169} // namespace preconditioner
170} // namespace distributed
171} // namespace experimental
172} // namespace gko
173
174
175#endif // GINKGO_BUILD_MPI
176#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:662
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:234
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:57
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:33
The distributed namespace.
Definition precision_dispatch.hpp:309
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:106
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:171
std::int64_t int64
64-bit signed integral type.
Definition types.hpp:112
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 LinOp > generated_local_solver
Generated Inner solvers.
Definition schwarz.hpp:91
std::shared_ptr< const LinOpFactory > local_solver
Local solver factory.
Definition schwarz.hpp:85