33#ifndef GKO_PUBLIC_CORE_SOLVER_IDR_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_IDR_HPP_
42#include <ginkgo/core/base/array.hpp>
43#include <ginkgo/core/base/exception_helpers.hpp>
44#include <ginkgo/core/base/lin_op.hpp>
45#include <ginkgo/core/base/math.hpp>
46#include <ginkgo/core/base/types.hpp>
47#include <ginkgo/core/log/logger.hpp>
48#include <ginkgo/core/matrix/dense.hpp>
49#include <ginkgo/core/matrix/identity.hpp>
50#include <ginkgo/core/solver/solver_base.hpp>
51#include <ginkgo/core/stop/combined.hpp>
52#include <ginkgo/core/stop/criterion.hpp>
82template <
typename ValueType = default_precision>
91 using value_type = ValueType;
167 GKO_DEPRECATED(
"Use set_complex_subspace instead")
187 parameters_type, Factory> {
226 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
229 LinOp* x)
const override;
231 template <
typename VectorType>
234 explicit Idr(std::shared_ptr<const Executor> exec)
239 std::shared_ptr<const LinOp> system_matrix)
243 std::move(system_matrix), factory->get_parameters()},
244 parameters_{factory->get_parameters()}
249template <
typename ValueType>
253 static int num_vectors(
const Solver&);
255 static int num_arrays(
const Solver&);
257 static std::vector<std::string> op_names(
const Solver&);
259 static std::vector<std::string> array_names(
const Solver&);
261 static std::vector<int> scalars(
const Solver&);
263 static std::vector<int> vectors(
const Solver&);
266 constexpr static int residual = 0;
268 constexpr static int v = 1;
270 constexpr static int t = 2;
272 constexpr static int helper = 3;
274 constexpr static int m = 4;
276 constexpr static int g = 5;
278 constexpr static int u = 6;
280 constexpr static int subspace = 7;
282 constexpr static int f = 8;
284 constexpr static int c = 9;
286 constexpr static int omega = 10;
288 constexpr static int residual_norm = 11;
290 constexpr static int tht = 12;
292 constexpr static int alpha = 13;
294 constexpr static int one = 14;
296 constexpr static int minus_one = 15;
298 constexpr static int subspace_minus_one = 16;
301 constexpr static int stop = 0;
303 constexpr static int tmp = 1;
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:908
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:691
Definition lin_op.hpp:146
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:462
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:816
IDR(s) is an efficient method for solving large nonsymmetric systems of linear equations.
Definition idr.hpp:86
void set_kappa(const remove_complex< ValueType > other)
Sets the kappa parameter of the solver.
Definition idr.hpp:132
void set_complex_subpsace(const bool other)
Sets the complex_subspace parameter of the solver.
Definition idr.hpp:168
void set_subspace_dim(const size_type other)
Sets the subspace dimension of the solver.
Definition idr.hpp:115
void set_deterministic(const bool other)
Sets the deterministic parameter of the solver.
Definition idr.hpp:149
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition idr.hpp:103
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
void set_complex_subspace(const bool other)
Sets the complex_subspace parameter of the solver.
Definition idr.hpp:178
bool get_complex_subspace() const
Gets the complex_subspace parameter of the solver.
Definition idr.hpp:159
size_type get_subspace_dim() const
Gets the subspace dimension of the solver.
Definition idr.hpp:109
bool get_deterministic() const
Gets the deterministic parameter of the solver.
Definition idr.hpp:142
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
remove_complex< ValueType > get_kappa() const
Gets the kappa parameter of the solver.
Definition idr.hpp:125
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
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:354
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
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:220
remove_complex< ValueType > kappa
Threshold to determine if Av_n and v_n are too close to being perpendicular.
Definition idr.hpp:200
bool deterministic
If set to true, the vectors spanning the subspace S are chosen deterministically.
Definition idr.hpp:211
size_type subspace_dim
Dimension of the subspace S.
Definition idr.hpp:192
Definition solver_base.hpp:869
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:267