Ginkgo: ginkgo/core/solver/pipe_cg.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
pipe_cg.hpp
1// SPDX-FileCopyrightText: 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
7
8
9#include <vector>
10
11#include <ginkgo/core/base/array.hpp>
12#include <ginkgo/core/base/exception_helpers.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/math.hpp>
15#include <ginkgo/core/base/types.hpp>
16#include <ginkgo/core/config/config.hpp>
17#include <ginkgo/core/config/registry.hpp>
18#include <ginkgo/core/config/type_descriptor.hpp>
19#include <ginkgo/core/log/logger.hpp>
20#include <ginkgo/core/matrix/dense.hpp>
21#include <ginkgo/core/matrix/identity.hpp>
22#include <ginkgo/core/solver/solver_base.hpp>
23#include <ginkgo/core/stop/combined.hpp>
24#include <ginkgo/core/stop/criterion.hpp>
25
26
27namespace gko {
28namespace solver {
29
30
60template <typename ValueType = default_precision>
61 class PipeCg
62 : public EnableLinOp<PipeCg<ValueType>>,
63 public EnablePreconditionedIterativeSolver<ValueType, PipeCg<ValueType>>,
64 public Transposable {
65 friend class EnableLinOp<PipeCg>;
66 friend class EnablePolymorphicObject<PipeCg, LinOp>;
67 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
68
69public:
70 using value_type = ValueType;
71 using transposed_type = PipeCg<ValueType>;
72
73 std::unique_ptr<LinOp> transpose() const override;
74
75 std::unique_ptr<LinOp> conj_transpose() const override;
76
82 bool apply_uses_initial_guess() const override { return true; }
83
84 class Factory;
85
86 struct parameters_type
87 : enable_preconditioned_iterative_solver_factory_parameters<
88 parameters_type, Factory> {};
89
90 GKO_ENABLE_LIN_OP_FACTORY(PipeCg, parameters, Factory);
91 GKO_ENABLE_BUILD_METHOD(Factory);
92
106 static parameters_type parse(const config::pnode& config,
107 const config::registry& context,
108 const config::type_descriptor& td_for_child =
109 config::make_type_descriptor<ValueType>());
110
111protected:
112 void apply_impl(const LinOp* b, LinOp* x) const override;
113
114 template <typename VectorType>
115 void apply_dense_impl(const VectorType* b, VectorType* x) const;
116
117 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
118 LinOp* x) const override;
119
120 explicit PipeCg(std::shared_ptr<const Executor> exec)
121 : EnableLinOp<PipeCg>(std::move(exec))
122 {}
123
124 explicit PipeCg(const Factory* factory,
125 std::shared_ptr<const LinOp> system_matrix)
126 : EnableLinOp<PipeCg>(factory->get_executor(),
127 gko::transpose(system_matrix->get_size())),
128 EnablePreconditionedIterativeSolver<ValueType, PipeCg<ValueType>>{
129 std::move(system_matrix), factory->get_parameters()},
130 parameters_{factory->get_parameters()}
131 {}
132};
133
134
135template <typename ValueType>
136 struct workspace_traits<PipeCg<ValueType>> {
137 using Solver = PipeCg<ValueType>;
138 // number of vectors used by this workspace
139 static int num_vectors(const Solver&);
140 // number of arrays used by this workspace
141 static int num_arrays(const Solver&);
142 // array containing the num_vectors names for the workspace vectors
143 static std::vector<std::string> op_names(const Solver&);
144 // array containing the num_arrays names for the workspace vectors
145 static std::vector<std::string> array_names(const Solver&);
146 // array containing all varying scalar vectors (independent of problem size)
147 static std::vector<int> scalars(const Solver&);
148 // array containing all varying vectors (dependent on problem size)
149 static std::vector<int> vectors(const Solver&);
150
151 // joint (residual vector | w vector)
152 constexpr static int rw = 0;
153 // preconditioned residual vector
154 constexpr static int z = 1;
155 // p vector
156 constexpr static int p = 2;
157 // m vector
158 constexpr static int m = 3;
159 // n vector
160 constexpr static int n = 4;
161 // q vector
162 constexpr static int q = 5;
163 // f vector
164 constexpr static int f = 6;
165 // g vector
166 constexpr static int g = 7;
167 // beta scalar
168 constexpr static int beta = 8;
169 // (rho|delta) joint scalar
170 constexpr static int rhodelta = 9;
171 // previous rho scalar
172 constexpr static int prev_rho = 10;
173 // constant 1.0 scalar
174 constexpr static int one = 11;
175 // constant -1.0 scalar
176 constexpr static int minus_one = 12;
177
178 // stopping status array
179 constexpr static int stop = 0;
180 // reduction tmp array
181 constexpr static int tmp = 1;
182};
183
184
185} // namespace solver
186} // namespace gko
187
188
189#endif // GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::LinOp
Definition lin_op.hpp:117
gko::Transposable
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
gko::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
gko::config::type_descriptor
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
gko::solver::EnablePreconditionedIterativeSolver
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:802
gko::solver::Factory
Definition ir.hpp:184
gko::solver::PipeCg
PIPE_CG or the pipelined conjugate gradient method is an iterative type Krylov subspace method which ...
Definition pipe_cg.hpp:64
gko::solver::PipeCg::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::PipeCg::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::solver::PipeCg::apply_uses_initial_guess
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition pipe_cg.hpp:82
gko::solver::PipeCg::parse
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType >())
Create the parameters from the property_tree.
GKO_ENABLE_BUILD_METHOD
#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
GKO_ENABLE_LIN_OP_FACTORY
#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
gko::solver
The ginkgo Solve namespace.
Definition bicg.hpp:28
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::transpose
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
std
STL namespace.
gko::solver::PipeCg::parameters_type
Definition pipe_cg.hpp:88
gko::solver::enable_preconditioned_iterative_solver_factory_parameters
Definition solver_base.hpp:855
gko::solver::workspace_traits
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238