Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
bicg.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_BICG_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_BICG_HPP_
7
8
9#include <vector>
10
11
12#include <ginkgo/core/base/array.hpp>
13#include <ginkgo/core/base/exception_helpers.hpp>
14#include <ginkgo/core/base/lin_op.hpp>
15#include <ginkgo/core/base/math.hpp>
16#include <ginkgo/core/base/types.hpp>
17#include <ginkgo/core/log/logger.hpp>
18#include <ginkgo/core/matrix/csr.hpp>
19#include <ginkgo/core/matrix/dense.hpp>
20#include <ginkgo/core/matrix/identity.hpp>
21#include <ginkgo/core/solver/solver_base.hpp>
22#include <ginkgo/core/stop/combined.hpp>
23#include <ginkgo/core/stop/criterion.hpp>
24
25
26namespace gko {
27namespace solver {
28
29
51template <typename ValueType = default_precision>
52class Bicg
53 : public EnableLinOp<Bicg<ValueType>>,
54 public EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>,
55 public Transposable {
56 friend class EnableLinOp<Bicg>;
57 friend class EnablePolymorphicObject<Bicg, LinOp>;
58
59public:
60 using value_type = ValueType;
62
63 std::unique_ptr<LinOp> transpose() const override;
64
65 std::unique_ptr<LinOp> conj_transpose() const override;
66
72 bool apply_uses_initial_guess() const override { return true; }
73
74 class Factory;
75
79
82
83protected:
84 void apply_impl(const LinOp* b, LinOp* x) const override;
85
86 void apply_dense_impl(const matrix::Dense<ValueType>* b,
88
89 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
90 LinOp* x) const override;
91
92 explicit Bicg(std::shared_ptr<const Executor> exec)
93 : EnableLinOp<Bicg>(std::move(exec))
94 {}
95
96 explicit Bicg(const Factory* factory,
97 std::shared_ptr<const LinOp> system_matrix)
98 : EnableLinOp<Bicg>(factory->get_executor(),
99 gko::transpose(system_matrix->get_size())),
100 EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>{
101 std::move(system_matrix), factory->get_parameters()},
102 parameters_{factory->get_parameters()}
103 {}
104};
105
106
107template <typename ValueType>
108struct workspace_traits<Bicg<ValueType>> {
109 using Solver = Bicg<ValueType>;
110 // number of vectors used by this workspace
111 static int num_vectors(const Solver&);
112 // number of arrays used by this workspace
113 static int num_arrays(const Solver&);
114 // array containing the num_vectors names for the workspace vectors
115 static std::vector<std::string> op_names(const Solver&);
116 // array containing the num_arrays names for the workspace vectors
117 static std::vector<std::string> array_names(const Solver&);
118 // array containing all varying scalar vectors (independent of problem size)
119 static std::vector<int> scalars(const Solver&);
120 // array containing all varying vectors (dependent on problem size)
121 static std::vector<int> vectors(const Solver&);
122
123 // residual vector
124 constexpr static int r = 0;
125 // preconditioned residual vector
126 constexpr static int z = 1;
127 // p vector
128 constexpr static int p = 2;
129 // q vector
130 constexpr static int q = 3;
131 // "transposed" residual vector
132 constexpr static int r2 = 4;
133 // "transposed" preconditioned residual vector
134 constexpr static int z2 = 5;
135 // "transposed" p vector
136 constexpr static int p2 = 6;
137 // "transposed" q vector
138 constexpr static int q2 = 7;
139 // alpha scalar
140 constexpr static int alpha = 8;
141 // beta scalar
142 constexpr static int beta = 9;
143 // previous rho scalar
144 constexpr static int prev_rho = 10;
145 // current rho scalar
146 constexpr static int rho = 11;
147 // constant 1.0 scalar
148 constexpr static int one = 12;
149 // constant -1.0 scalar
150 constexpr static int minus_one = 13;
151
152 // stopping status array
153 constexpr static int stop = 0;
154 // reduction tmp array
155 constexpr static int tmp = 1;
156};
157
158
159} // namespace solver
160} // namespace gko
161
162
163#endif // GKO_PUBLIC_CORE_SOLVER_BICG_HPP_
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
Definition lin_op.hpp:118
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:434
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:107
Definition bicg.hpp:80
BICG or the Biconjugate gradient method is a Krylov subspace solver.
Definition bicg.hpp:55
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition bicg.hpp:72
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:788
#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:1018
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239