Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
bicgstab.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_SOLVER_BICGSTAB_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_BICGSTAB_HPP_
35
36
37#include <vector>
38
39
40#include <ginkgo/core/base/array.hpp>
41#include <ginkgo/core/base/exception_helpers.hpp>
42#include <ginkgo/core/base/lin_op.hpp>
43#include <ginkgo/core/base/math.hpp>
44#include <ginkgo/core/base/types.hpp>
45#include <ginkgo/core/log/logger.hpp>
46#include <ginkgo/core/matrix/dense.hpp>
47#include <ginkgo/core/matrix/identity.hpp>
48#include <ginkgo/core/solver/solver_base.hpp>
49#include <ginkgo/core/stop/combined.hpp>
50#include <ginkgo/core/stop/criterion.hpp>
51
52
53namespace gko {
59namespace solver {
60
61
77template <typename ValueType = default_precision>
79 : public EnableLinOp<Bicgstab<ValueType>>,
81 Bicgstab<ValueType>>,
82 public Transposable {
83 friend class EnableLinOp<Bicgstab>;
85
86public:
87 using value_type = ValueType;
89
90 std::unique_ptr<LinOp> transpose() const override;
91
92 std::unique_ptr<LinOp> conj_transpose() const override;
93
99 bool apply_uses_initial_guess() const override { return true; }
100
101 class Factory;
104 parameters_type, Factory> {};
105
108
109protected:
110 void apply_impl(const LinOp* b, LinOp* x) const override;
111
112 template <typename VectorType>
113 void apply_dense_impl(const VectorType* b, VectorType* x) const;
114
115 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
116 LinOp* x) const override;
117
118 explicit Bicgstab(std::shared_ptr<const Executor> exec)
119 : EnableLinOp<Bicgstab>(std::move(exec))
120 {}
121
122 explicit Bicgstab(const Factory* factory,
123 std::shared_ptr<const LinOp> system_matrix)
124 : EnableLinOp<Bicgstab>(factory->get_executor(),
125 gko::transpose(system_matrix->get_size())),
126 EnablePreconditionedIterativeSolver<ValueType, Bicgstab<ValueType>>{
127 std::move(system_matrix), factory->get_parameters()},
128 parameters_{factory->get_parameters()}
129 {}
130};
131
132
133template <typename ValueType>
134struct workspace_traits<Bicgstab<ValueType>> {
136 // number of vectors used by this workspace
137 static int num_vectors(const Solver&);
138 // number of arrays used by this workspace
139 static int num_arrays(const Solver&);
140 // array containing the num_vectors names for the workspace vectors
141 static std::vector<std::string> op_names(const Solver&);
142 // array containing the num_arrays names for the workspace vectors
143 static std::vector<std::string> array_names(const Solver&);
144 // array containing all varying scalar vectors (independent of problem size)
145 static std::vector<int> scalars(const Solver&);
146 // array containing all varying vectors (dependent on problem size)
147 static std::vector<int> vectors(const Solver&);
148
149 // residual vector
150 constexpr static int r = 0;
151 // preconditioned residual vector
152 constexpr static int z = 1;
153 // y vector
154 constexpr static int y = 2;
155 // v vector
156 constexpr static int v = 3;
157 // s vector
158 constexpr static int s = 4;
159 // t vector
160 constexpr static int t = 5;
161 // p vector
162 constexpr static int p = 6;
163 // rr vector
164 constexpr static int rr = 7;
165 // alpha scalar
166 constexpr static int alpha = 8;
167 // beta scalar
168 constexpr static int beta = 9;
169 // gamma scalar
170 constexpr static int gamma = 10;
171 // previous rho scalar
172 constexpr static int prev_rho = 11;
173 // current rho scalar
174 constexpr static int rho = 12;
175 // omega scalar
176 constexpr static int omega = 13;
177 // constant 1.0 scalar
178 constexpr static int one = 14;
179 // constant -1.0 scalar
180 constexpr static int minus_one = 15;
181
182 // stopping status array
183 constexpr static int stop = 0;
184 // reduction tmp array
185 constexpr static int tmp = 1;
186};
187
188
189} // namespace solver
190} // namespace gko
191
192
193#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:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
Definition bicgstab.hpp:106
BiCGSTAB or the Bi-Conjugate Gradient-Stabilized is a Krylov subspace solver.
Definition bicgstab.hpp:82
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:99
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:816
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
Definition bicgstab.hpp:104
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267