Ginkgo: ginkgo/core/solver/cb_gmres.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
cb_gmres.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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>
96 class CbGmres : public EnableLinOp<CbGmres<ValueType>>,
97 public EnablePreconditionedIterativeSolver<ValueType,
98 CbGmres<ValueType>> {
99 friend class EnableLinOp<CbGmres>;
100 friend class EnablePolymorphicObject<CbGmres, LinOp>;
101 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
102
103public:
104 using value_type = ValueType;
105
111 size_type get_krylov_dim() const { return parameters_.krylov_dim; }
112
118 void set_krylov_dim(size_type other) { parameters_.krylov_dim = other; }
119
125 cb_gmres::storage_precision get_storage_precision() const
126 {
127 return parameters_.storage_precision;
128 }
129
130 class Factory;
131
132 struct parameters_type
133 : enable_preconditioned_iterative_solver_factory_parameters<
134 parameters_type, Factory> {
138 cb_gmres::storage_precision GKO_FACTORY_PARAMETER_SCALAR(
139 storage_precision, cb_gmres::storage_precision::reduce1);
140
144 size_type GKO_FACTORY_PARAMETER_SCALAR(krylov_dim, 100u);
145 };
146
147 GKO_ENABLE_LIN_OP_FACTORY(CbGmres, parameters, Factory);
148 GKO_ENABLE_BUILD_METHOD(Factory);
149
163 static parameters_type parse(const config::pnode& config,
164 const config::registry& context,
165 const config::type_descriptor& td_for_child =
166 config::make_type_descriptor<ValueType>());
167
168protected:
169 void apply_impl(const LinOp* b, LinOp* x) const override;
170
171 void apply_dense_impl(const matrix::Dense<ValueType>* b,
172 matrix::Dense<ValueType>* x) const;
173
174 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
175 LinOp* x) const override;
176
177 explicit CbGmres(std::shared_ptr<const Executor> exec)
178 : EnableLinOp<CbGmres>(std::move(exec))
179 {}
180
181 explicit CbGmres(const Factory* factory,
182 std::shared_ptr<const LinOp> system_matrix)
183 : EnableLinOp<CbGmres>(factory->get_executor(),
184 transpose(system_matrix->get_size())),
185 EnablePreconditionedIterativeSolver<ValueType, CbGmres<ValueType>>{
186 std::move(system_matrix), factory->get_parameters()},
187 parameters_{factory->get_parameters()}
188 {}
189};
190
191
192} // namespace solver
193} // namespace gko
194
195
196#endif // GKO_PUBLIC_CORE_SOLVER_CB_GMRES_HPP_
gko::EnableLinOp
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition lin_op.hpp:879
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::LinOp
Definition lin_op.hpp:117
gko::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
gko::config::type_descriptor
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
gko::solver::CbGmres
CB-GMRES or the compressed basis generalized minimal residual method is an iterative type Krylov subs...
Definition cb_gmres.hpp:98
gko::solver::CbGmres::parse
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.
gko::solver::CbGmres::get_krylov_dim
size_type get_krylov_dim() const
Returns the Krylov dimension.
Definition cb_gmres.hpp:111
gko::solver::CbGmres::set_krylov_dim
void set_krylov_dim(size_type other)
Sets the Krylov dimension.
Definition cb_gmres.hpp:118
gko::solver::CbGmres::get_storage_precision
cb_gmres::storage_precision get_storage_precision() const
Returns the storage precision used internally.
Definition cb_gmres.hpp:125
gko::solver::EnablePreconditionedIterativeSolver
A LinOp implementing this interface stores a system matrix and stopping criterion factory.
Definition solver_base.hpp:802
gko::solver::Factory
Definition ir.hpp:184
GKO_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
GKO_ENABLE_BUILD_METHOD
#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
GKO_ENABLE_LIN_OP_FACTORY
#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
gko::solver
The ginkgo Solve namespace.
Definition bicg.hpp:28
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::transpose
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
std
STL namespace.
gko::solver::CbGmres::parameters_type
Definition cb_gmres.hpp:134
gko::solver::CbGmres::parameters_type::krylov_dim
size_type krylov_dim
Krylov dimension factory.
Definition cb_gmres.hpp:144
gko::solver::CbGmres::parameters_type::storage_precision
cb_gmres::storage_precision storage_precision
Determines which storage type is used.
Definition cb_gmres.hpp:139
gko::solver::enable_preconditioned_iterative_solver_factory_parameters
Definition solver_base.hpp:855