Ginkgo: ginkgo/core/solver/gmres.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
gmres.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_GMRES_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_GMRES_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 {
27namespace solver {
28
29
30[[deprecated]] constexpr size_type default_krylov_dim = 100u;
31
32constexpr size_type gmres_default_krylov_dim = 100u;
33
34namespace gmres {
38enum class ortho_method {
42 mgs,
46 cgs,
50 cgs2
51};
52
54std::ostream& operator<<(std::ostream& stream, ortho_method ortho);
55
56} // namespace gmres
57
71template <typename ValueType = default_precision>
72 class Gmres
73 : public EnableLinOp<Gmres<ValueType>>,
74 public EnablePreconditionedIterativeSolver<ValueType, Gmres<ValueType>>,
75 public Transposable {
76 friend class EnableLinOp<Gmres>;
77 friend class EnablePolymorphicObject<Gmres, LinOp>;
78 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
79
80public:
81 using value_type = ValueType;
82 using transposed_type = Gmres<ValueType>;
83
84 std::unique_ptr<LinOp> transpose() const override;
85
86 std::unique_ptr<LinOp> conj_transpose() const override;
87
93 bool apply_uses_initial_guess() const override { return true; }
94
100 size_type get_krylov_dim() const { return parameters_.krylov_dim; }
101
107 void set_krylov_dim(size_type other) { parameters_.krylov_dim = other; }
108
109
110 class Factory;
111
112 struct parameters_type
113 : enable_preconditioned_iterative_solver_factory_parameters<
114 parameters_type, Factory> {
116 size_type GKO_FACTORY_PARAMETER_SCALAR(krylov_dim, 0u);
117
119 bool GKO_FACTORY_PARAMETER_SCALAR(flexible, false);
120
122 gmres::ortho_method GKO_FACTORY_PARAMETER_SCALAR(
123 ortho_method, gmres::ortho_method::mgs);
124 };
125 GKO_ENABLE_LIN_OP_FACTORY(Gmres, parameters, Factory);
126 GKO_ENABLE_BUILD_METHOD(Factory);
127
141 static parameters_type parse(const config::pnode& config,
142 const config::registry& context,
143 const config::type_descriptor& td_for_child =
144 config::make_type_descriptor<ValueType>());
145
146protected:
147 void apply_impl(const LinOp* b, LinOp* x) const override;
148
149 template <typename VectorType>
150 void apply_dense_impl(const VectorType* b, VectorType* x) const;
151
152 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
153 LinOp* x) const override;
154
155 explicit Gmres(std::shared_ptr<const Executor> exec)
156 : EnableLinOp<Gmres>(std::move(exec))
157 {}
158
159 explicit Gmres(const Factory* factory,
160 std::shared_ptr<const LinOp> system_matrix)
161 : EnableLinOp<Gmres>(factory->get_executor(),
162 gko::transpose(system_matrix->get_size())),
163 EnablePreconditionedIterativeSolver<ValueType, Gmres<ValueType>>{
164 std::move(system_matrix), factory->get_parameters()},
165 parameters_{factory->get_parameters()}
166 {
167 if (!parameters_.krylov_dim) {
168 parameters_.krylov_dim = gmres_default_krylov_dim;
169 }
170 }
171};
172
173
174template <typename ValueType>
175 struct workspace_traits<Gmres<ValueType>> {
176 using Solver = Gmres<ValueType>;
177 // number of vectors used by this workspace
178 static int num_vectors(const Solver&);
179 // number of arrays used by this workspace
180 static int num_arrays(const Solver&);
181 // array containing the num_vectors names for the workspace vectors
182 static std::vector<std::string> op_names(const Solver&);
183 // array containing the num_arrays names for the workspace vectors
184 static std::vector<std::string> array_names(const Solver&);
185 // array containing all varying scalar vectors (independent of problem size)
186 static std::vector<int> scalars(const Solver&);
187 // array containing all varying vectors (dependent on problem size)
188 static std::vector<int> vectors(const Solver&);
189
190 // residual vector
191 constexpr static int residual = 0;
192 // preconditioned vector
193 constexpr static int preconditioned_vector = 1;
194 // krylov basis multivector
195 constexpr static int krylov_bases = 2;
196 // hessenberg matrix
197 constexpr static int hessenberg = 3;
198 // auxiliary space for CGS2
199 constexpr static int hessenberg_aux = 4;
200 // givens sin parameters
201 constexpr static int givens_sin = 5;
202 // givens cos parameters
203 constexpr static int givens_cos = 6;
204 // coefficients of the residual in Krylov space
205 constexpr static int residual_norm_collection = 7;
206 // residual norm scalar
207 constexpr static int residual_norm = 8;
208 // solution of the least-squares problem in Krylov space
209 constexpr static int y = 9;
210 // solution of the least-squares problem mapped to the full space
211 constexpr static int before_preconditioner = 10;
212 // preconditioned solution of the least-squares problem
213 constexpr static int after_preconditioner = 11;
214 // constant 1.0 scalar
215 constexpr static int one = 12;
216 // constant -1.0 scalar
217 constexpr static int minus_one = 13;
218 // temporary norm vector of next_krylov to copy into hessenberg matrix
219 constexpr static int next_krylov_norm_tmp = 14;
220 // preconditioned krylov basis multivector
221 constexpr static int preconditioned_krylov_bases = 15;
222
223 // stopping status array
224 constexpr static int stop = 0;
225 // reduction tmp array
226 constexpr static int tmp = 1;
227 // final iteration number array
228 constexpr static int final_iter_nums = 2;
229};
230
231
232} // namespace solver
233} // namespace gko
234
235
236#endif // GKO_PUBLIC_CORE_SOLVER_GMRES_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::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::solver::Gmres
GMRES or the generalized minimal residual method is an iterative type Krylov subspace method which is...
Definition gmres.hpp:75
gko::solver::Gmres::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Gmres::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::solver::Gmres::get_krylov_dim
size_type get_krylov_dim() const
Gets the Krylov dimension of the solver.
Definition gmres.hpp:100
gko::solver::Gmres::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 gmres.hpp:93
gko::solver::Gmres::set_krylov_dim
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition gmres.hpp:107
gko::solver::Gmres::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_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
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::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
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::Gmres::parameters_type
Definition gmres.hpp:114
gko::solver::Gmres::parameters_type::krylov_dim
size_type krylov_dim
Krylov subspace dimension/restart value.
Definition gmres.hpp:116
gko::solver::Gmres::parameters_type::ortho_method
gmres::ortho_method ortho_method
Orthogonalization method.
Definition gmres.hpp:123
gko::solver::Gmres::parameters_type::flexible
bool flexible
Flexible GMRES.
Definition gmres.hpp:119
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