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
bicg.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_BICG_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_BICG_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/csr.hpp>
47#include <ginkgo/core/matrix/dense.hpp>
48#include <ginkgo/core/matrix/identity.hpp>
49#include <ginkgo/core/solver/solver_base.hpp>
50#include <ginkgo/core/stop/combined.hpp>
51#include <ginkgo/core/stop/criterion.hpp>
52
53
54namespace gko {
55namespace solver {
56
57
79template <typename ValueType = default_precision>
80class Bicg
81 : public EnableLinOp<Bicg<ValueType>>,
82 public EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>,
83 public Transposable {
84 friend class EnableLinOp<Bicg>;
85 friend class EnablePolymorphicObject<Bicg, LinOp>;
86
87public:
88 using value_type = ValueType;
90
91 std::unique_ptr<LinOp> transpose() const override;
92
93 std::unique_ptr<LinOp> conj_transpose() const override;
94
100 bool apply_uses_initial_guess() const override { return true; }
101
102 class Factory;
103
106 parameters_type, Factory> {};
107
110
111protected:
112 void apply_impl(const LinOp* b, LinOp* x) const override;
113
114 void apply_dense_impl(const matrix::Dense<ValueType>* b,
115 matrix::Dense<ValueType>* x) const;
116
117 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
118 LinOp* x) const override;
119
120 explicit Bicg(std::shared_ptr<const Executor> exec)
121 : EnableLinOp<Bicg>(std::move(exec))
122 {}
123
124 explicit Bicg(const Factory* factory,
125 std::shared_ptr<const LinOp> system_matrix)
126 : EnableLinOp<Bicg>(factory->get_executor(),
127 gko::transpose(system_matrix->get_size())),
128 EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>{
129 std::move(system_matrix), factory->get_parameters()},
130 parameters_{factory->get_parameters()}
131 {}
132};
133
134
135template <typename ValueType>
136struct workspace_traits<Bicg<ValueType>> {
137 using Solver = Bicg<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 // residual vector
152 constexpr static int r = 0;
153 // preconditioned residual vector
154 constexpr static int z = 1;
155 // p vector
156 constexpr static int p = 2;
157 // q vector
158 constexpr static int q = 3;
159 // "transposed" residual vector
160 constexpr static int r2 = 4;
161 // "transposed" preconditioned residual vector
162 constexpr static int z2 = 5;
163 // "transposed" p vector
164 constexpr static int p2 = 6;
165 // "transposed" q vector
166 constexpr static int q2 = 7;
167 // alpha scalar
168 constexpr static int alpha = 8;
169 // beta scalar
170 constexpr static int beta = 9;
171 // previous rho scalar
172 constexpr static int prev_rho = 10;
173 // current rho scalar
174 constexpr static int rho = 11;
175 // constant 1.0 scalar
176 constexpr static int one = 12;
177 // constant -1.0 scalar
178 constexpr static int minus_one = 13;
179
180 // stopping status array
181 constexpr static int stop = 0;
182 // reduction tmp array
183 constexpr static int tmp = 1;
184};
185
186
187} // namespace solver
188} // namespace gko
189
190
191#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: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
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:136
Definition bicg.hpp:108
BICG or the Biconjugate gradient method is a Krylov subspace solver.
Definition bicg.hpp:83
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:100
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: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 bicg.hpp:106
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267