Ginkgo  Generated from pipelines/2011557978 branch based on develop. Ginkgo version 1.11.0
A numerical linear algebra library targeting many-core architectures
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 
27 namespace gko {
28 namespace solver {
29 
30 
60 template <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 
68 public:
69  using value_type = ValueType;
71 
72  std::unique_ptr<LinOp> transpose() const override;
73 
74  std::unique_ptr<LinOp> conj_transpose() const override;
75 
81  bool apply_uses_initial_guess() const override { return true; }
82 
83  class Factory;
84 
87  parameters_type, Factory> {};
88 
91 
105  static parameters_type parse(const config::pnode& config,
106  const config::registry& context,
107  const config::type_descriptor& td_for_child =
108  config::make_type_descriptor<ValueType>());
109 
110 protected:
111  void apply_impl(const LinOp* b, LinOp* x) const override;
112 
113  template <typename VectorType>
114  void apply_dense_impl(const VectorType* b, VectorType* x) const;
115 
116  void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
117  LinOp* x) const override;
118 
119  explicit PipeCg(std::shared_ptr<const Executor> exec)
120  : EnableLinOp<PipeCg>(std::move(exec))
121  {}
122 
123  explicit PipeCg(const Factory* factory,
124  std::shared_ptr<const LinOp> system_matrix)
125  : EnableLinOp<PipeCg>(factory->get_executor(),
126  gko::transpose(system_matrix->get_size())),
127  EnablePreconditionedIterativeSolver<ValueType, PipeCg<ValueType>>{
128  std::move(system_matrix), factory->get_parameters()},
129  parameters_{factory->get_parameters()}
130  {}
131 };
132 
133 
134 template <typename ValueType>
135 struct workspace_traits<PipeCg<ValueType>> {
136  using Solver = PipeCg<ValueType>;
137  // number of vectors used by this workspace
138  static int num_vectors(const Solver&);
139  // number of arrays used by this workspace
140  static int num_arrays(const Solver&);
141  // array containing the num_vectors names for the workspace vectors
142  static std::vector<std::string> op_names(const Solver&);
143  // array containing the num_arrays names for the workspace vectors
144  static std::vector<std::string> array_names(const Solver&);
145  // array containing all varying scalar vectors (independent of problem size)
146  static std::vector<int> scalars(const Solver&);
147  // array containing all varying vectors (dependent on problem size)
148  static std::vector<int> vectors(const Solver&);
149 
150  // residual vector
151  constexpr static int r = 0;
152  // preconditioned residual vector
153  constexpr static int z = 1;
154  // p vector
155  constexpr static int p = 2;
156  // w vector
157  constexpr static int w = 3;
158  // m vector
159  constexpr static int m = 4;
160  // n vector
161  constexpr static int n = 5;
162  // q vector
163  constexpr static int q = 6;
164  // f vector
165  constexpr static int f = 7;
166  // g vector
167  constexpr static int g = 8;
168  // beta scalar
169  constexpr static int beta = 9;
170  // delta scalar
171  constexpr static int delta = 10;
172  // previous rho scalar
173  constexpr static int prev_rho = 11;
174  // current rho scalar
175  constexpr static int rho = 12;
176  // constant 1.0 scalar
177  constexpr static int one = 13;
178  // constant -1.0 scalar
179  constexpr static int minus_one = 14;
180 
181  // stopping status array
182  constexpr static int stop = 0;
183  // reduction tmp array
184  constexpr static int tmp = 1;
185 };
186 
187 
188 } // namespace solver
189 } // namespace gko
190 
191 
192 #endif // GKO_PUBLIC_CORE_SOLVER_PIPE_CG_HPP_
gko::solver::PipeCg::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::config::pnode
pnode describes a tree of properties.
Definition: property_tree.hpp:28
gko::log::profile_event_category::solver
Solver events.
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::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:81
gko::solver::enable_preconditioned_iterative_solver_factory_parameters
Definition: solver_base.hpp:854
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
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
gko::solver::PipeCg::Factory
Definition: pipe_cg.hpp:89
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::solver::PipeCg::parameters_type
Definition: pipe_cg.hpp:85
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::PipeCg::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition: registry.hpp:167
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::PolymorphicObject::get_executor
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition: polymorphic_object.hpp:243
gko::solver::workspace_traits
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition: solver_base.hpp:238
gko::LinOp::get_size
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition: lin_op.hpp:210
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:877
gko::solver::EnablePreconditionedIterativeSolver
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition: solver_base.hpp:799
gko::one
constexpr T one()
Returns the multiplicative identity for T.
Definition: math.hpp:654
gko::solver::PipeCg
PIPE_CG or the pipelined conjugate gradient method is an iterative type Krylov subspace method which ...
Definition: pipe_cg.hpp:61
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition: polymorphic_object.hpp:667