33#ifndef GKO_PUBLIC_CORE_SOLVER_GMRES_HPP_
34#define GKO_PUBLIC_CORE_SOLVER_GMRES_HPP_
40#include <ginkgo/core/base/array.hpp>
41#include <ginkgo/core/base/exception_helpers.hpp>
42#include <ginkgo/core/base/lin_op.hpp>
43#include <ginkgo/core/base/math.hpp>
44#include <ginkgo/core/base/types.hpp>
45#include <ginkgo/core/log/logger.hpp>
46#include <ginkgo/core/matrix/dense.hpp>
47#include <ginkgo/core/matrix/identity.hpp>
48#include <ginkgo/core/solver/solver_base.hpp>
49#include <ginkgo/core/stop/combined.hpp>
50#include <ginkgo/core/stop/criterion.hpp>
59constexpr size_type gmres_default_krylov_dim = 100u;
75template <
typename ValueType = default_precision>
84 using value_type = ValueType;
117 parameters_type, Factory> {
128 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
130 template <
typename VectorType>
134 LinOp* x)
const override;
136 explicit Gmres(std::shared_ptr<const Executor> exec)
141 std::shared_ptr<const LinOp> system_matrix)
145 std::move(system_matrix), factory->get_parameters()},
146 parameters_{factory->get_parameters()}
149 parameters_.
krylov_dim = gmres_default_krylov_dim;
155template <
typename ValueType>
159 static int num_vectors(
const Solver&);
161 static int num_arrays(
const Solver&);
163 static std::vector<std::string> op_names(
const Solver&);
165 static std::vector<std::string> array_names(
const Solver&);
167 static std::vector<int> scalars(
const Solver&);
169 static std::vector<int> vectors(
const Solver&);
172 constexpr static int residual = 0;
174 constexpr static int preconditioned_vector = 1;
176 constexpr static int krylov_bases = 2;
178 constexpr static int hessenberg = 3;
180 constexpr static int givens_sin = 4;
182 constexpr static int givens_cos = 5;
184 constexpr static int residual_norm_collection = 6;
186 constexpr static int residual_norm = 7;
188 constexpr static int y = 8;
190 constexpr static int before_preconditioner = 9;
192 constexpr static int after_preconditioner = 10;
194 constexpr static int one = 11;
196 constexpr static int minus_one = 12;
198 constexpr static int next_krylov_norm_tmp = 13;
200 constexpr static int preconditioned_krylov_bases = 14;
203 constexpr static int stop = 0;
205 constexpr static int tmp = 1;
207 constexpr static int final_iter_nums = 2;
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
GMRES or the generalized minimal residual method is an iterative type Krylov subspace method which is...
Definition gmres.hpp:79
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
size_type get_krylov_dim() const
Gets the Krylov dimension of the solver.
Definition gmres.hpp:103
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition gmres.hpp:96
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition gmres.hpp:110
#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
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
size_type krylov_dim
Krylov subspace dimension/restart value.
Definition gmres.hpp:119
bool flexible
Flexible GMRES.
Definition gmres.hpp:122
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