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
bicgstab.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_BICGSTAB_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_BICGSTAB_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/dense.hpp>
19#include <ginkgo/core/matrix/identity.hpp>
20#include <ginkgo/core/solver/solver_base.hpp>
21#include <ginkgo/core/stop/combined.hpp>
22#include <ginkgo/core/stop/criterion.hpp>
23
24
25namespace gko {
31namespace solver {
32
33
49template <typename ValueType = default_precision>
51 : public EnableLinOp<Bicgstab<ValueType>>,
53 Bicgstab<ValueType>>,
54 public Transposable {
55 friend class EnableLinOp<Bicgstab>;
57
58public:
59 using value_type = ValueType;
61
62 std::unique_ptr<LinOp> transpose() const override;
63
64 std::unique_ptr<LinOp> conj_transpose() const override;
65
71 bool apply_uses_initial_guess() const override { return true; }
72
73 class Factory;
77
80
81protected:
82 void apply_impl(const LinOp* b, LinOp* x) const override;
83
84 template <typename VectorType>
85 void apply_dense_impl(const VectorType* b, VectorType* x) const;
86
87 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
88 LinOp* x) const override;
89
90 explicit Bicgstab(std::shared_ptr<const Executor> exec)
91 : EnableLinOp<Bicgstab>(std::move(exec))
92 {}
93
94 explicit Bicgstab(const Factory* factory,
95 std::shared_ptr<const LinOp> system_matrix)
96 : EnableLinOp<Bicgstab>(factory->get_executor(),
97 gko::transpose(system_matrix->get_size())),
98 EnablePreconditionedIterativeSolver<ValueType, Bicgstab<ValueType>>{
99 std::move(system_matrix), factory->get_parameters()},
100 parameters_{factory->get_parameters()}
101 {}
102};
103
104
105template <typename ValueType>
106struct workspace_traits<Bicgstab<ValueType>> {
108 // number of vectors used by this workspace
109 static int num_vectors(const Solver&);
110 // number of arrays used by this workspace
111 static int num_arrays(const Solver&);
112 // array containing the num_vectors names for the workspace vectors
113 static std::vector<std::string> op_names(const Solver&);
114 // array containing the num_arrays names for the workspace vectors
115 static std::vector<std::string> array_names(const Solver&);
116 // array containing all varying scalar vectors (independent of problem size)
117 static std::vector<int> scalars(const Solver&);
118 // array containing all varying vectors (dependent on problem size)
119 static std::vector<int> vectors(const Solver&);
120
121 // residual vector
122 constexpr static int r = 0;
123 // preconditioned residual vector
124 constexpr static int z = 1;
125 // y vector
126 constexpr static int y = 2;
127 // v vector
128 constexpr static int v = 3;
129 // s vector
130 constexpr static int s = 4;
131 // t vector
132 constexpr static int t = 5;
133 // p vector
134 constexpr static int p = 6;
135 // rr vector
136 constexpr static int rr = 7;
137 // alpha scalar
138 constexpr static int alpha = 8;
139 // beta scalar
140 constexpr static int beta = 9;
141 // gamma scalar
142 constexpr static int gamma = 10;
143 // previous rho scalar
144 constexpr static int prev_rho = 11;
145 // current rho scalar
146 constexpr static int rho = 12;
147 // omega scalar
148 constexpr static int omega = 13;
149 // constant 1.0 scalar
150 constexpr static int one = 14;
151 // constant -1.0 scalar
152 constexpr static int minus_one = 15;
153
154 // stopping status array
155 constexpr static int stop = 0;
156 // reduction tmp array
157 constexpr static int tmp = 1;
158};
159
160
161} // namespace solver
162} // namespace gko
163
164
165#endif // GKO_PUBLIC_CORE_SOLVER_BICGSTAB_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
Definition bicgstab.hpp:78
BiCGSTAB or the Bi-Conjugate Gradient-Stabilized is a Krylov subspace solver.
Definition bicgstab.hpp:54
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the 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 bicgstab.hpp:71
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
Definition bicgstab.hpp:76
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239