Ginkgo Generated from branch based on main. Ginkgo version 1.9.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#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/config/config.hpp>
18#include <ginkgo/core/config/registry.hpp>
19#include <ginkgo/core/log/logger.hpp>
20#include <ginkgo/core/matrix/dense.hpp>
21#include <ginkgo/core/matrix/identity.hpp>
22#include <ginkgo/core/solver/solver_base.hpp>
23#include <ginkgo/core/stop/combined.hpp>
24#include <ginkgo/core/stop/criterion.hpp>
25
26
27namespace gko {
28namespace solver {
29
30
31namespace cb_gmres {
32
33
61enum class storage_precision {
62 keep,
63 reduce1,
64 reduce2,
65 integer,
66 ireduce1,
67 ireduce2
68};
69
70
71} // namespace cb_gmres
72
73
95template <typename ValueType = default_precision>
96class CbGmres : public EnableLinOp<CbGmres<ValueType>>,
97 public EnablePreconditionedIterativeSolver<ValueType,
98 CbGmres<ValueType>> {
99 friend class EnableLinOp<CbGmres>;
100 friend class EnablePolymorphicObject<CbGmres, LinOp>;
101
102public:
103 using value_type = ValueType;
104
110 size_type get_krylov_dim() const { return parameters_.krylov_dim; }
111
117 void set_krylov_dim(size_type other) { parameters_.krylov_dim = other; }
118
124 cb_gmres::storage_precision get_storage_precision() const
125 {
126 return parameters_.storage_precision;
127 }
128
129 class Factory;
130
133 parameters_type, Factory> {
137 cb_gmres::storage_precision GKO_FACTORY_PARAMETER_SCALAR(
138 storage_precision, cb_gmres::storage_precision::reduce1);
139
144 };
145
146 GKO_ENABLE_LIN_OP_FACTORY(CbGmres, parameters, Factory);
148
162 static parameters_type parse(const config::pnode& config,
163 const config::registry& context,
164 const config::type_descriptor& td_for_child =
165 config::make_type_descriptor<ValueType>());
166
167protected:
168 void apply_impl(const LinOp* b, LinOp* x) const override;
169
170 void apply_dense_impl(const matrix::Dense<ValueType>* b,
171 matrix::Dense<ValueType>* x) const;
172
173 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
174 LinOp* x) const override;
175
176 explicit CbGmres(std::shared_ptr<const Executor> exec)
177 : EnableLinOp<CbGmres>(std::move(exec))
178 {}
179
180 explicit CbGmres(const Factory* factory,
181 std::shared_ptr<const LinOp> system_matrix)
182 : EnableLinOp<CbGmres>(factory->get_executor(),
183 transpose(system_matrix->get_size())),
184 EnablePreconditionedIterativeSolver<ValueType, CbGmres<ValueType>>{
185 std::move(system_matrix), factory->get_parameters()},
186 parameters_{factory->get_parameters()}
187 {}
188};
189
190
191} // namespace solver
192} // namespace gko
193
194
195#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:879
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:662
Definition lin_op.hpp:117
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition lin_op.hpp:210
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:234
pnode describes a tree of properties.
Definition property_tree.hpp:28
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:117
CB-GMRES or the compressed basis generalized minimal residual method is an iterative type Krylov subs...
Definition cb_gmres.hpp:98
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.
size_type get_krylov_dim() const
Returns the Krylov dimension.
Definition cb_gmres.hpp:110
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition cb_gmres.hpp:117
cb_gmres::storage_precision get_storage_precision() const
Returns the storage precision used internally.
Definition cb_gmres.hpp:124
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:787
#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:1017
The ginkgo Solve namespace.
Definition bicg.hpp:28
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
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
STL namespace.
Definition cb_gmres.hpp:133
size_type krylov_dim
Krylov dimension factory.
Definition cb_gmres.hpp:143
cb_gmres::storage_precision storage_precision
Determines which storage type is used.
Definition cb_gmres.hpp:138