Ginkgo: ginkgo/core/solver/minres.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
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>
57 class 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 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
64
65public:
66 using value_type = ValueType;
67 using transposed_type = Minres;
68
69 std::unique_ptr<LinOp> transpose() const override;
70
71 std::unique_ptr<LinOp> conj_transpose() const override;
72
76 bool apply_uses_initial_guess() const override;
77
78 class Factory;
79
80 struct parameters_type
81 : enable_preconditioned_iterative_solver_factory_parameters<
82 parameters_type, Factory> {};
83
84 GKO_ENABLE_LIN_OP_FACTORY(Minres, parameters, Factory);
85 GKO_ENABLE_BUILD_METHOD(Factory);
86
100 static parameters_type parse(const config::pnode& config,
101 const config::registry& context,
102 const config::type_descriptor& td_for_child =
103 config::make_type_descriptor<ValueType>());
104
105protected:
106 void apply_impl(const LinOp* b, LinOp* x) const override;
107
108 template <typename VectorType>
109 void apply_dense_impl(const VectorType* dense_b, VectorType* dense_x) const;
110
111 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
112 LinOp* x) const override;
113
114 explicit Minres(std::shared_ptr<const Executor> exec);
115
116 explicit Minres(const Factory* factory,
117 std::shared_ptr<const LinOp> system_matrix);
118};
119
120
121template <typename ValueType>
122 struct workspace_traits<Minres<ValueType>> {
123 using Solver = Minres<ValueType>;
124 // number of vectors used by this workspace
125 static int num_vectors(const Solver&);
126 // number of arrays used by this workspace
127 static int num_arrays(const Solver&);
128 // array containing the num_vectors names for the workspace vectors
129 static std::vector<std::string> op_names(const Solver&);
130 // array containing the num_arrays names for the workspace vectors
131 static std::vector<std::string> array_names(const Solver&);
132 // array containing all varying scalar vectors (independent of problem size)
133 static std::vector<int> scalars(const Solver&);
134 // array containing all varying vectors (dependent on problem size)
135 static std::vector<int> vectors(const Solver&);
136
137 // residual vector
138 constexpr static int r = 0;
139 // preconditioned residual vector
140 constexpr static int z = 1;
141 // p vector
142 constexpr static int p = 2;
143 // q vector
144 constexpr static int q = 3;
145 // v vector
146 constexpr static int v = 4;
147 // z_tilde vector
148 constexpr static int z_tilde = 5;
149 // p_prev vector
150 constexpr static int p_prev = 6;
151 // q_prev vector
152 constexpr static int q_prev = 7;
153 // alpha scalar
154 constexpr static int alpha = 8;
155 // beta scalar
156 constexpr static int beta = 9;
157 // gamma scalar
158 constexpr static int gamma = 10;
159 // delta scalar
160 constexpr static int delta = 11;
161 // next eta scalar
162 constexpr static int eta_next = 12;
163 // current eta scalar
164 constexpr static int eta = 13;
165 // tau scalar
166 constexpr static int tau = 14;
167 // previous cos scalar
168 constexpr static int cos_prev = 15;
169 // current cos scalar
170 constexpr static int cos = 16;
171 // previous sin scalar
172 constexpr static int sin_prev = 17;
173 // current sin scalar
174 constexpr static int sin = 18;
175 // constant 1.0 scalar
176 constexpr static int one = 19;
177 // constant -1.0 scalar
178 constexpr static int minus_one = 20;
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_MINRES_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::Minres
Minres is an iterative type Krylov subspace method, which is suitable for indefinite and full-rank sy...
Definition minres.hpp:60
gko::solver::Minres::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Minres::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::Minres::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.
gko::solver::Minres::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
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::solver::Minres::parameters_type
Definition minres.hpp:82
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