Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
minres.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_MINRES_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_MINRES_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/property_tree.hpp>
17#include <ginkgo/core/config/registry.hpp>
18#include <ginkgo/core/config/type_descriptor.hpp>
19#include <ginkgo/core/log/logger.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 {
26namespace solver {
27
28
56template <typename ValueType = default_precision>
57class Minres
58 : public EnableLinOp<Minres<ValueType>>,
59 public EnablePreconditionedIterativeSolver<ValueType, Minres<ValueType>>,
60 public Transposable {
61 friend class EnableLinOp<Minres>;
62 friend class EnablePolymorphicObject<Minres, LinOp>;
63
64public:
65 using value_type = ValueType;
66 using transposed_type = Minres;
67
68 std::unique_ptr<LinOp> transpose() const override;
69
70 std::unique_ptr<LinOp> conj_transpose() const override;
71
75 bool apply_uses_initial_guess() const override;
76
77 class Factory;
78
82
83 GKO_ENABLE_LIN_OP_FACTORY(Minres, parameters, Factory);
85
99 static parameters_type parse(const config::pnode& config,
100 const config::registry& context,
101 const config::type_descriptor& td_for_child =
102 config::make_type_descriptor<ValueType>());
103
104protected:
105 void apply_impl(const LinOp* b, LinOp* x) const override;
106
107 template <typename VectorType>
108 void apply_dense_impl(const VectorType* dense_b, VectorType* dense_x) const;
109
110 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
111 LinOp* x) const override;
112
113 explicit Minres(std::shared_ptr<const Executor> exec);
114
115 explicit Minres(const Factory* factory,
116 std::shared_ptr<const LinOp> system_matrix);
117};
118
119
120template <typename ValueType>
121struct workspace_traits<Minres<ValueType>> {
122 using Solver = Minres<ValueType>;
123 // number of vectors used by this workspace
124 static int num_vectors(const Solver&);
125 // number of arrays used by this workspace
126 static int num_arrays(const Solver&);
127 // array containing the num_vectors names for the workspace vectors
128 static std::vector<std::string> op_names(const Solver&);
129 // array containing the num_arrays names for the workspace vectors
130 static std::vector<std::string> array_names(const Solver&);
131 // array containing all varying scalar vectors (independent of problem size)
132 static std::vector<int> scalars(const Solver&);
133 // array containing all varying vectors (dependent on problem size)
134 static std::vector<int> vectors(const Solver&);
135
136 // residual vector
137 constexpr static int r = 0;
138 // preconditioned residual vector
139 constexpr static int z = 1;
140 // p vector
141 constexpr static int p = 2;
142 // q vector
143 constexpr static int q = 3;
144 // v vector
145 constexpr static int v = 4;
146 // z_tilde vector
147 constexpr static int z_tilde = 5;
148 // p_prev vector
149 constexpr static int p_prev = 6;
150 // q_prev vector
151 constexpr static int q_prev = 7;
152 // alpha scalar
153 constexpr static int alpha = 8;
154 // beta scalar
155 constexpr static int beta = 9;
156 // gamma scalar
157 constexpr static int gamma = 10;
158 // delta scalar
159 constexpr static int delta = 11;
160 // next eta scalar
161 constexpr static int eta_next = 12;
162 // current eta scalar
163 constexpr static int eta = 13;
164 // tau scalar
165 constexpr static int tau = 14;
166 // previous cos scalar
167 constexpr static int cos_prev = 15;
168 // current cos scalar
169 constexpr static int cos = 16;
170 // previous sin scalar
171 constexpr static int sin_prev = 17;
172 // current sin scalar
173 constexpr static int sin = 18;
174 // constant 1.0 scalar
175 constexpr static int one = 19;
176 // constant -1.0 scalar
177 constexpr static int minus_one = 20;
178
179 // stopping status array
180 constexpr static int stop = 0;
181 // reduction tmp array
182 constexpr static int tmp = 1;
183};
184
185
186} // namespace solver
187} // namespace gko
188
189
190#endif // GKO_PUBLIC_CORE_SOLVER_MINRES_HPP_
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
Definition lin_op.hpp:117
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
Minres is an iterative type Krylov subspace method, which is suitable for indefinite and full-rank sy...
Definition minres.hpp:60
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
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.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
#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:1017
The ginkgo Solve namespace.
Definition bicg.hpp:28
The Ginkgo namespace.
Definition abstract_factory.hpp:20
Definition minres.hpp:81
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238