5#ifndef GKO_PUBLIC_CORE_SOLVER_GCR_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_GCR_HPP_
12#include <ginkgo/core/base/array.hpp>
13#include <ginkgo/core/base/exception_helpers.hpp>
14#include <ginkgo/core/base/lin_op.hpp>
15#include <ginkgo/core/base/math.hpp>
16#include <ginkgo/core/base/types.hpp>
17#include <ginkgo/core/log/logger.hpp>
18#include <ginkgo/core/matrix/dense.hpp>
19#include <ginkgo/core/matrix/identity.hpp>
20#include <ginkgo/core/solver/solver_base.hpp>
21#include <ginkgo/core/stop/combined.hpp>
22#include <ginkgo/core/stop/criterion.hpp>
29constexpr size_type gcr_default_krylov_dim = 100u;
46template <
typename ValueType = default_precision>
55 using value_type = ValueType;
87 parameters_type, Factory> {
95 void apply_impl(
const LinOp* b,
LinOp* x)
const override;
97 template <
typename VectorType>
101 LinOp* x)
const override;
103 explicit Gcr(std::shared_ptr<const Executor> exec)
108 std::shared_ptr<const LinOp> system_matrix)
112 std::move(system_matrix), factory->get_parameters()},
113 parameters_{factory->get_parameters()}
116 parameters_.
krylov_dim = gcr_default_krylov_dim;
122template <
typename ValueType>
126 static int num_vectors(
const Solver&);
128 static int num_arrays(
const Solver&);
130 static std::vector<std::string> op_names(
const Solver&);
132 static std::vector<std::string> array_names(
const Solver&);
134 static std::vector<int> scalars(
const Solver&);
136 static std::vector<int> vectors(
const Solver&);
139 constexpr static int residual = 0;
141 constexpr static int precon_residual = 1;
143 constexpr static int A_precon_residual = 2;
145 constexpr static int krylov_bases_p = 3;
147 constexpr static int mapped_krylov_bases_Ap = 4;
149 constexpr static int tmp_rAp = 5;
151 constexpr static int tmp_minus_beta = 6;
153 constexpr static int Ap_norms = 7;
155 constexpr static int residual_norm = 8;
157 constexpr static int one = 9;
159 constexpr static int minus_one = 10;
162 constexpr static int stop = 0;
164 constexpr static int tmp = 1;
166 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:880
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
Definition lin_op.hpp:118
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:434
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:788
GCR or the generalized conjugate residual method is an iterative type Krylov subspace method similar ...
Definition gcr.hpp:50
size_type get_krylov_dim() const
Gets the Krylov dimension of the solver.
Definition gcr.hpp:74
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition gcr.hpp:81
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition gcr.hpp:67
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
#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
#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:1018
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:92
size_type krylov_dim
Krylov subspace dimension/restart value.
Definition gcr.hpp:89
Definition solver_base.hpp:841
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:239