Ginkgo: ginkgo/core/solver/idr.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
idr.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_IDR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_IDR_HPP_
7
8
9#include <random>
10#include <typeinfo>
11#include <vector>
12
13#include <ginkgo/core/base/array.hpp>
14#include <ginkgo/core/base/exception_helpers.hpp>
15#include <ginkgo/core/base/lin_op.hpp>
16#include <ginkgo/core/base/math.hpp>
17#include <ginkgo/core/base/types.hpp>
18#include <ginkgo/core/config/config.hpp>
19#include <ginkgo/core/config/registry.hpp>
20#include <ginkgo/core/log/logger.hpp>
21#include <ginkgo/core/matrix/dense.hpp>
22#include <ginkgo/core/matrix/identity.hpp>
23#include <ginkgo/core/solver/solver_base.hpp>
24#include <ginkgo/core/stop/combined.hpp>
25#include <ginkgo/core/stop/criterion.hpp>
26
27
28namespace gko {
34namespace solver {
35
36
55template <typename ValueType = default_precision>
56 class Idr
57 : public EnableLinOp<Idr<ValueType>>,
58 public EnablePreconditionedIterativeSolver<ValueType, Idr<ValueType>>,
59 public Transposable {
60 friend class EnableLinOp<Idr>;
61 friend class EnablePolymorphicObject<Idr, LinOp>;
62 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
63
64public:
65 using value_type = ValueType;
66 using transposed_type = Idr<ValueType>;
67
68 std::unique_ptr<LinOp> transpose() const override;
69
70 std::unique_ptr<LinOp> conj_transpose() const override;
71
77 bool apply_uses_initial_guess() const override { return true; }
78
83 size_type get_subspace_dim() const { return parameters_.subspace_dim; }
84
89 void set_subspace_dim(const size_type other)
90 {
91 parameters_.subspace_dim = other;
92 }
93
99 remove_complex<ValueType> get_kappa() const { return parameters_.kappa; }
100
106 void set_kappa(const remove_complex<ValueType> other)
107 {
108 parameters_.kappa = other;
109 }
110
116 bool get_deterministic() const { return parameters_.deterministic; }
117
123 void set_deterministic(const bool other)
124 {
125 parameters_.deterministic = other;
126 }
127
133 bool get_complex_subspace() const { return parameters_.complex_subspace; }
134
141 GKO_DEPRECATED("Use set_complex_subspace instead")
142 void set_complex_subpsace(const bool other)
143 {
144 this->set_complex_subspace(other);
145 }
146
152 void set_complex_subspace(const bool other)
153 {
154 parameters_.complex_subspace = other;
155 }
156
157 class Factory;
158
159 struct parameters_type
160 : enable_preconditioned_iterative_solver_factory_parameters<
161 parameters_type, Factory> {
166 size_type GKO_FACTORY_PARAMETER_SCALAR(subspace_dim, 2u);
167
174 remove_complex<ValueType> GKO_FACTORY_PARAMETER_SCALAR(kappa, 0.7);
175
185 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic, false);
186
194 bool GKO_FACTORY_PARAMETER_SCALAR(complex_subspace, false);
195 };
196 GKO_ENABLE_LIN_OP_FACTORY(Idr, parameters, Factory);
197 GKO_ENABLE_BUILD_METHOD(Factory);
198
212 static parameters_type parse(const config::pnode& config,
213 const config::registry& context,
214 const config::type_descriptor& td_for_child =
215 config::make_type_descriptor<ValueType>());
216
217protected:
218 void apply_impl(const LinOp* b, LinOp* x) const override;
219
220 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
221 LinOp* x) const override;
222
223 template <typename VectorType>
224 void iterate(const VectorType* dense_b, VectorType* dense_x) const;
225
226 explicit Idr(std::shared_ptr<const Executor> exec)
227 : EnableLinOp<Idr>(std::move(exec))
228 {}
229
230 explicit Idr(const Factory* factory,
231 std::shared_ptr<const LinOp> system_matrix)
232 : EnableLinOp<Idr>(factory->get_executor(),
233 gko::transpose(system_matrix->get_size())),
234 EnablePreconditionedIterativeSolver<ValueType, Idr<ValueType>>{
235 std::move(system_matrix), factory->get_parameters()},
236 parameters_{factory->get_parameters()}
237 {}
238};
239
240
241template <typename ValueType>
242 struct workspace_traits<Idr<ValueType>> {
243 using Solver = Idr<ValueType>;
244 // number of vectors used by this workspace
245 static int num_vectors(const Solver&);
246 // number of arrays used by this workspace
247 static int num_arrays(const Solver&);
248 // array containing the num_vectors names for the workspace vectors
249 static std::vector<std::string> op_names(const Solver&);
250 // array containing the num_arrays names for the workspace vectors
251 static std::vector<std::string> array_names(const Solver&);
252 // array containing all varying scalar vectors (independent of problem size)
253 static std::vector<int> scalars(const Solver&);
254 // array containing all varying vectors (dependent on problem size)
255 static std::vector<int> vectors(const Solver&);
256
257 // residual vector
258 constexpr static int residual = 0;
259 // v vector
260 constexpr static int v = 1;
261 // t vector
262 constexpr static int t = 2;
263 // helper vector
264 constexpr static int helper = 3;
265 // m multivector
266 constexpr static int m = 4;
267 // g multivector
268 constexpr static int g = 5;
269 // u multivector
270 constexpr static int u = 6;
271 // subspace multivector
272 constexpr static int subspace = 7;
273 // f "multiscalar"
274 constexpr static int f = 8;
275 // c "multiscalar"
276 constexpr static int c = 9;
277 // omega scalar
278 constexpr static int omega = 10;
279 // residual norm scalar
280 constexpr static int residual_norm = 11;
281 // T^H*T scalar
282 constexpr static int tht = 12;
283 // alpha "multiscalar"
284 constexpr static int alpha = 13;
285 // constant 1.0 scalar
286 constexpr static int one = 14;
287 // constant -1.0 scalar
288 constexpr static int minus_one = 15;
289 // constant -1.0 scalar
290 constexpr static int subspace_minus_one = 16;
291
292 // stopping status array
293 constexpr static int stop = 0;
294 // reduction tmp array
295 constexpr static int tmp = 1;
296};
297
298
299} // namespace solver
300} // namespace gko
301
302
303#endif // GKO_PUBLIC_CORE_SOLVER_IDR_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::Idr
IDR(s) is an efficient method for solving large nonsymmetric systems of linear equations.
Definition idr.hpp:59
gko::solver::Idr::set_kappa
void set_kappa(const remove_complex< ValueType > other)
Sets the kappa parameter of the solver.
Definition idr.hpp:106
gko::solver::Idr< ValueType >::set_complex_subpsace
void set_complex_subpsace(const bool other)
Definition idr.hpp:142
gko::solver::Idr::set_subspace_dim
void set_subspace_dim(const size_type other)
Sets the subspace dimension of the solver.
Definition idr.hpp:89
gko::solver::Idr::set_deterministic
void set_deterministic(const bool other)
Sets the deterministic parameter of the solver.
Definition idr.hpp:123
gko::solver::Idr::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 idr.hpp:77
gko::solver::Idr::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Idr::set_complex_subspace
void set_complex_subspace(const bool other)
Sets the complex_subspace parameter of the solver.
Definition idr.hpp:152
gko::solver::Idr::get_complex_subspace
bool get_complex_subspace() const
Gets the complex_subspace parameter of the solver.
Definition idr.hpp:133
gko::solver::Idr::get_subspace_dim
size_type get_subspace_dim() const
Gets the subspace dimension of the solver.
Definition idr.hpp:83
gko::solver::Idr::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::Idr::get_deterministic
bool get_deterministic() const
Gets the deterministic parameter of the solver.
Definition idr.hpp:116
gko::solver::Idr::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::solver::Idr::get_kappa
remove_complex< ValueType > get_kappa() const
Gets the kappa parameter of the solver.
Definition idr.hpp:99
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::remove_complex
typename detail::remove_complex_s< T >::type remove_complex
Obtain the type which removed the complex of complex/scalar type or the template parameter of class b...
Definition math.hpp:264
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::Idr::parameters_type
Definition idr.hpp:161
gko::solver::Idr::parameters_type::complex_subspace
bool complex_subspace
If set to true, IDR will use a complex subspace S also for real problems, allowing for faster converg...
Definition idr.hpp:194
gko::solver::Idr::parameters_type::kappa
remove_complex< ValueType > kappa
Threshold to determine if Av_n and v_n are too close to being perpendicular.
Definition idr.hpp:174
gko::solver::Idr::parameters_type::deterministic
bool deterministic
If set to true, the vectors spanning the subspace S are chosen deterministically.
Definition idr.hpp:185
gko::solver::Idr::parameters_type::subspace_dim
size_type subspace_dim
Dimension of the subspace S.
Definition idr.hpp:166
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