Ginkgo: ginkgo/core/solver/bicgstab.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
bicgstab.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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#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/log/logger.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 {
32namespace solver {
33
34
50template <typename ValueType = default_precision>
51 class Bicgstab
52 : public EnableLinOp<Bicgstab<ValueType>>,
53 public EnablePreconditionedIterativeSolver<ValueType,
54 Bicgstab<ValueType>>,
55 public Transposable {
56 friend class EnableLinOp<Bicgstab>;
57 friend class EnablePolymorphicObject<Bicgstab, LinOp>;
58 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
59
60public:
61 using value_type = ValueType;
62 using transposed_type = Bicgstab<ValueType>;
63
64 std::unique_ptr<LinOp> transpose() const override;
65
66 std::unique_ptr<LinOp> conj_transpose() const override;
67
73 bool apply_uses_initial_guess() const override { return true; }
74
75 class Factory;
76 struct parameters_type
77 : enable_preconditioned_iterative_solver_factory_parameters<
78 parameters_type, Factory> {};
79
80 GKO_ENABLE_LIN_OP_FACTORY(Bicgstab, parameters, Factory);
81 GKO_ENABLE_BUILD_METHOD(Factory);
82
96 static parameters_type parse(const config::pnode& config,
97 const config::registry& context,
98 const config::type_descriptor& td_for_child =
99 config::make_type_descriptor<ValueType>());
100
101protected:
102 void apply_impl(const LinOp* b, LinOp* x) const override;
103
104 template <typename VectorType>
105 void apply_dense_impl(const VectorType* b, VectorType* x) const;
106
107 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
108 LinOp* x) const override;
109
110 explicit Bicgstab(std::shared_ptr<const Executor> exec)
111 : EnableLinOp<Bicgstab>(std::move(exec))
112 {}
113
114 explicit Bicgstab(const Factory* factory,
115 std::shared_ptr<const LinOp> system_matrix)
116 : EnableLinOp<Bicgstab>(factory->get_executor(),
117 gko::transpose(system_matrix->get_size())),
118 EnablePreconditionedIterativeSolver<ValueType, Bicgstab<ValueType>>{
119 std::move(system_matrix), factory->get_parameters()},
120 parameters_{factory->get_parameters()}
121 {}
122};
123
124
125template <typename ValueType>
126 struct workspace_traits<Bicgstab<ValueType>> {
127 using Solver = Bicgstab<ValueType>;
128 // number of vectors used by this workspace
129 static int num_vectors(const Solver&);
130 // number of arrays used by this workspace
131 static int num_arrays(const Solver&);
132 // array containing the num_vectors names for the workspace vectors
133 static std::vector<std::string> op_names(const Solver&);
134 // array containing the num_arrays names for the workspace vectors
135 static std::vector<std::string> array_names(const Solver&);
136 // array containing all varying scalar vectors (independent of problem size)
137 static std::vector<int> scalars(const Solver&);
138 // array containing all varying vectors (dependent on problem size)
139 static std::vector<int> vectors(const Solver&);
140
141 // residual vector
142 constexpr static int r = 0;
143 // preconditioned residual vector
144 constexpr static int z = 1;
145 // y vector
146 constexpr static int y = 2;
147 // v vector
148 constexpr static int v = 3;
149 // s vector
150 constexpr static int s = 4;
151 // t vector
152 constexpr static int t = 5;
153 // p vector
154 constexpr static int p = 6;
155 // rr vector
156 constexpr static int rr = 7;
157 // alpha scalar
158 constexpr static int alpha = 8;
159 // beta scalar
160 constexpr static int beta = 9;
161 // gamma scalar
162 constexpr static int gamma = 10;
163 // previous rho scalar
164 constexpr static int prev_rho = 11;
165 // current rho scalar
166 constexpr static int rho = 12;
167 // omega scalar
168 constexpr static int omega = 13;
169 // constant 1.0 scalar
170 constexpr static int one = 14;
171 // constant -1.0 scalar
172 constexpr static int minus_one = 15;
173
174 // stopping status array
175 constexpr static int stop = 0;
176 // reduction tmp array
177 constexpr static int tmp = 1;
178};
179
180
181} // namespace solver
182} // namespace gko
183
184
185#endif // GKO_PUBLIC_CORE_SOLVER_BICGSTAB_HPP_
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
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::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
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::solver::Bicgstab
BiCGSTAB or the Bi-Conjugate Gradient-Stabilized is a Krylov subspace solver.
Definition bicgstab.hpp:55
gko::solver::Bicgstab::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Bicgstab::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::Bicgstab::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::solver::Bicgstab::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 bicgstab.hpp:73
gko::solver::EnablePreconditionedIterativeSolver
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:802
gko::solver::Factory
Definition ir.hpp:184
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_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
The ginkgo Solve namespace.
Definition bicg.hpp:28
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::transpose
batch_dim< 2, DimensionType > transpose(const batch_dim< 2, DimensionType > &input)
Returns a batch_dim object with its dimensions swapped for batched operators.
Definition batch_dim.hpp:119
std
STL namespace.
gko::solver::Bicgstab::parameters_type
Definition bicgstab.hpp:78
gko::solver::enable_preconditioned_iterative_solver_factory_parameters
Definition solver_base.hpp:855
gko::solver::workspace_traits
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238