Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
cb_gmres.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_CB_GMRES_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_CB_GMRES_HPP_
7
8
9#include <memory>
10#include <vector>
11
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/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
30namespace cb_gmres {
31
32
60enum class storage_precision {
61 keep,
62 reduce1,
63 reduce2,
64 integer,
65 ireduce1,
66 ireduce2
67};
68
69
70} // namespace cb_gmres
71
72
94template <typename ValueType = default_precision>
95class CbGmres : public EnableLinOp<CbGmres<ValueType>>,
97 CbGmres<ValueType>> {
98 friend class EnableLinOp<CbGmres>;
100
101public:
102 using value_type = ValueType;
103
109 size_type get_krylov_dim() const { return parameters_.krylov_dim; }
110
117
123 cb_gmres::storage_precision get_storage_precision() const
124 {
125 return parameters_.storage_precision;
126 }
127
128 class Factory;
129
132 parameters_type, Factory> {
136 cb_gmres::storage_precision GKO_FACTORY_PARAMETER_SCALAR(
137 storage_precision, cb_gmres::storage_precision::reduce1);
138
143 };
144
147
148protected:
149 void apply_impl(const LinOp* b, LinOp* x) const override;
150
151 void apply_dense_impl(const matrix::Dense<ValueType>* b,
152 matrix::Dense<ValueType>* x) const;
153
154 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
155 LinOp* x) const override;
156
157 explicit CbGmres(std::shared_ptr<const Executor> exec)
158 : EnableLinOp<CbGmres>(std::move(exec))
159 {}
160
161 explicit CbGmres(const Factory* factory,
162 std::shared_ptr<const LinOp> system_matrix)
163 : EnableLinOp<CbGmres>(factory->get_executor(),
164 transpose(system_matrix->get_size())),
165 EnablePreconditionedIterativeSolver<ValueType, CbGmres<ValueType>>{
166 std::move(system_matrix), factory->get_parameters()},
167 parameters_{factory->get_parameters()}
168 {}
169};
170
171
172} // namespace solver
173} // namespace gko
174
175
176#endif // GKO_PUBLIC_CORE_SOLVER_CB_GMRES_HPP_
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
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:107
Definition cb_gmres.hpp:145
CB-GMRES or the compressed basis generalized minimal residual method is an iterative type Krylov subs...
Definition cb_gmres.hpp:97
size_type get_krylov_dim() const
Returns the Krylov dimension.
Definition cb_gmres.hpp:109
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition cb_gmres.hpp:116
cb_gmres::storage_precision get_storage_precision() const
Returns the storage precision used internally.
Definition cb_gmres.hpp:123
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:788
#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
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:120
Definition cb_gmres.hpp:132
size_type krylov_dim
Krylov dimension factory.
Definition cb_gmres.hpp:142
cb_gmres::storage_precision storage_precision
Determines which storage type is used.
Definition cb_gmres.hpp:137