Ginkgo: ginkgo/core/solver/bicg.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
bicg.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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#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/csr.hpp>
20#include <ginkgo/core/matrix/dense.hpp>
21#include <ginkgo/core/matrix/identity.hpp>
22#include <ginkgo/core/solver/solver_base.hpp>
23#include <ginkgo/core/stop/combined.hpp>
24#include <ginkgo/core/stop/criterion.hpp>
25
26
27namespace gko {
28 namespace solver {
29
30
52template <typename ValueType = default_precision>
53 class Bicg
54 : public EnableLinOp<Bicg<ValueType>>,
55 public EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>,
56 public Transposable {
57 friend class EnableLinOp<Bicg>;
58 friend class EnablePolymorphicObject<Bicg, LinOp>;
59 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
60
61public:
62 using value_type = ValueType;
63 using transposed_type = Bicg<ValueType>;
64
65 std::unique_ptr<LinOp> transpose() const override;
66
67 std::unique_ptr<LinOp> conj_transpose() const override;
68
74 bool apply_uses_initial_guess() const override { return true; }
75
76 class Factory;
77
78 struct parameters_type
79 : enable_preconditioned_iterative_solver_factory_parameters<
80 parameters_type, Factory> {};
81
82 GKO_ENABLE_LIN_OP_FACTORY(Bicg, parameters, Factory);
83 GKO_ENABLE_BUILD_METHOD(Factory);
84
98 static parameters_type parse(const config::pnode& config,
99 const config::registry& context,
100 const config::type_descriptor& td_for_child =
101 config::make_type_descriptor<ValueType>());
102
103protected:
104 void apply_impl(const LinOp* b, LinOp* x) const override;
105
106 void apply_dense_impl(const matrix::Dense<ValueType>* b,
107 matrix::Dense<ValueType>* x) const;
108
109 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
110 LinOp* x) const override;
111
112 explicit Bicg(std::shared_ptr<const Executor> exec)
113 : EnableLinOp<Bicg>(std::move(exec))
114 {}
115
116 explicit Bicg(const Factory* factory,
117 std::shared_ptr<const LinOp> system_matrix)
118 : EnableLinOp<Bicg>(factory->get_executor(),
119 gko::transpose(system_matrix->get_size())),
120 EnablePreconditionedIterativeSolver<ValueType, Bicg<ValueType>>{
121 std::move(system_matrix), factory->get_parameters()},
122 parameters_{factory->get_parameters()}
123 {}
124};
125
126
127template <typename ValueType>
128 struct workspace_traits<Bicg<ValueType>> {
129 using Solver = Bicg<ValueType>;
130 // number of vectors used by this workspace
131 static int num_vectors(const Solver&);
132 // number of arrays used by this workspace
133 static int num_arrays(const Solver&);
134 // array containing the num_vectors names for the workspace vectors
135 static std::vector<std::string> op_names(const Solver&);
136 // array containing the num_arrays names for the workspace vectors
137 static std::vector<std::string> array_names(const Solver&);
138 // array containing all varying scalar vectors (independent of problem size)
139 static std::vector<int> scalars(const Solver&);
140 // array containing all varying vectors (dependent on problem size)
141 static std::vector<int> vectors(const Solver&);
142
143 // residual vector
144 constexpr static int r = 0;
145 // preconditioned residual vector
146 constexpr static int z = 1;
147 // p vector
148 constexpr static int p = 2;
149 // q vector
150 constexpr static int q = 3;
151 // "transposed" residual vector
152 constexpr static int r2 = 4;
153 // "transposed" preconditioned residual vector
154 constexpr static int z2 = 5;
155 // "transposed" p vector
156 constexpr static int p2 = 6;
157 // "transposed" q vector
158 constexpr static int q2 = 7;
159 // beta scalar
160 constexpr static int beta = 8;
161 // previous rho scalar
162 constexpr static int prev_rho = 9;
163 // current rho scalar
164 constexpr static int rho = 10;
165 // constant 1.0 scalar
166 constexpr static int one = 11;
167 // constant -1.0 scalar
168 constexpr static int minus_one = 12;
169
170 // stopping status array
171 constexpr static int stop = 0;
172 // reduction tmp array
173 constexpr static int tmp = 1;
174};
175
176
177} // namespace solver
178} // namespace gko
179
180
181#endif // GKO_PUBLIC_CORE_SOLVER_BICG_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::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
gko::solver::Bicg
BICG or the Biconjugate gradient method is a Krylov subspace solver.
Definition bicg.hpp:56
gko::solver::Bicg::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::Bicg::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Bicg::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 bicg.hpp:74
gko::solver::Bicg::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
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::Bicg::parameters_type
Definition bicg.hpp:80
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