Ginkgo: ginkgo/core/solver/chebyshev.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
chebyshev.hpp
1// SPDX-FileCopyrightText: 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_SOLVER_CHEBYSHEV_HPP_
6#define GKO_PUBLIC_CORE_SOLVER_CHEBYSHEV_HPP_
7
8
9#include <vector>
10
11#include <ginkgo/core/base/exception_helpers.hpp>
12#include <ginkgo/core/base/lin_op.hpp>
13#include <ginkgo/core/base/types.hpp>
14#include <ginkgo/core/config/config.hpp>
15#include <ginkgo/core/config/registry.hpp>
16#include <ginkgo/core/matrix/dense.hpp>
17#include <ginkgo/core/matrix/identity.hpp>
18#include <ginkgo/core/solver/solver_base.hpp>
19#include <ginkgo/core/stop/combined.hpp>
20#include <ginkgo/core/stop/criterion.hpp>
21#include <ginkgo/core/stop/iteration.hpp>
22
23
24namespace gko {
25namespace solver {
26namespace detail {
27
28
29template <typename T>
30using coeff_type =
31 std::conditional_t<is_complex<T>(), std::complex<double>, double>;
32
33
34}
35
61template <typename ValueType = default_precision>
62 class Chebyshev final
63 : public EnableLinOp<Chebyshev<ValueType>>,
64 public EnablePreconditionedIterativeSolver<ValueType,
65 Chebyshev<ValueType>>,
66 public EnableApplyWithInitialGuess<Chebyshev<ValueType>>,
67 public Transposable {
68 friend class EnableLinOp<Chebyshev>;
69 friend class EnablePolymorphicObject<Chebyshev, LinOp>;
70 friend class EnableApplyWithInitialGuess<Chebyshev>;
71 GKO_ASSERT_SUPPORTED_VALUE_TYPE;
72
73public:
74 using value_type = ValueType;
75 using transposed_type = Chebyshev<ValueType>;
76
77 std::unique_ptr<LinOp> transpose() const override;
78
79 std::unique_ptr<LinOp> conj_transpose() const override;
80
86 bool apply_uses_initial_guess() const override
87 {
88 return this->get_default_initial_guess() ==
89 initial_guess_mode::provided;
90 }
91
98 Chebyshev& operator=(const Chebyshev&);
99
107 Chebyshev& operator=(Chebyshev&&);
108
113 Chebyshev(const Chebyshev&);
114
121 Chebyshev(Chebyshev&&);
122
123 class Factory;
124
125 struct parameters_type
126 : enable_preconditioned_iterative_solver_factory_parameters<
127 parameters_type, Factory> {
135 std::pair<detail::coeff_type<value_type>,
136 detail::coeff_type<value_type>>
137 GKO_FACTORY_PARAMETER_VECTOR(foci,
138 detail::coeff_type<value_type>{0},
139 detail::coeff_type<value_type>{1});
140
145 initial_guess_mode GKO_FACTORY_PARAMETER_SCALAR(
146 default_initial_guess, initial_guess_mode::provided);
147 };
148
149 GKO_ENABLE_LIN_OP_FACTORY(Chebyshev, parameters, Factory);
150 GKO_ENABLE_BUILD_METHOD(Factory);
151
165 static parameters_type parse(const config::pnode& config,
166 const config::registry& context,
167 const config::type_descriptor& td_for_child =
168 config::make_type_descriptor<ValueType>());
169
170protected:
171 void apply_impl(const LinOp* b, LinOp* x) const override;
172
173 template <typename VectorType>
174 void apply_dense_impl(const VectorType* b, VectorType* x,
175 initial_guess_mode guess) const;
176
177 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
178 LinOp* x) const override;
179
180 void apply_with_initial_guess_impl(const LinOp* b, LinOp* x,
181 initial_guess_mode guess) const override;
182
183 void apply_with_initial_guess_impl(const LinOp* alpha, const LinOp* b,
184 const LinOp* beta, LinOp* x,
185 initial_guess_mode guess) const override;
186
187 explicit Chebyshev(std::shared_ptr<const Executor> exec);
188
189 explicit Chebyshev(const Factory* factory,
190 std::shared_ptr<const LinOp> system_matrix);
191
192private:
193 std::shared_ptr<const LinOp> solver_{};
194 detail::coeff_type<value_type> center_;
195 detail::coeff_type<value_type> foci_direction_;
196};
197
198
199template <typename ValueType>
200 struct workspace_traits<Chebyshev<ValueType>> {
201 using Solver = Chebyshev<ValueType>;
202 // number of vectors used by this workspace
203 static int num_vectors(const Solver&);
204 // number of arrays used by this workspace
205 static int num_arrays(const Solver&);
206 // array containing the num_vectors names for the workspace vectors
207 static std::vector<std::string> op_names(const Solver&);
208 // array containing the num_arrays names for the workspace vectors
209 static std::vector<std::string> array_names(const Solver&);
210 // array containing all varying scalar vectors (independent of problem size)
211 static std::vector<int> scalars(const Solver&);
212 // array containing all varying vectors (dependent on problem size)
213 static std::vector<int> vectors(const Solver&);
214
215 // residual vector
216 constexpr static int residual = 0;
217 // inner solution vector
218 constexpr static int inner_solution = 1;
219 // update solution
220 constexpr static int update_solution = 2;
221 // constant 1.0 scalar
222 constexpr static int one = 3;
223 // constant -1.0 scalar
224 constexpr static int minus_one = 4;
225
226 // stopping status array
227 constexpr static int stop = 0;
228};
229
230
231} // namespace solver
232} // namespace gko
233
234
235#endif // GKO_PUBLIC_CORE_SOLVER_CHEBYSHEV_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::Transposable
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
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::solver::Chebyshev
Chebyshev iteration is an iterative method for solving nonsymmetric problems based on some knowledge ...
Definition chebyshev.hpp:67
gko::solver::Chebyshev::Chebyshev
Chebyshev(Chebyshev &&)
Move-constructs an Chebyshev solver.
gko::solver::Chebyshev::Chebyshev
Chebyshev(const Chebyshev &)
Copy-constructs an Chebyshev solver.
gko::solver::Chebyshev::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::Chebyshev::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::solver::Chebyshev::apply_uses_initial_guess
bool apply_uses_initial_guess() const override
Return true as iterative solvers use the data in x as an initial guess.
Definition chebyshev.hpp:86
gko::solver::Chebyshev::operator=
Chebyshev & operator=(const Chebyshev &)
Copy-assigns a Chebyshev solver.
gko::solver::Chebyshev::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::solver::Chebyshev::operator=
Chebyshev & operator=(Chebyshev &&)
Move-assigns a Chebyshev solver.
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_FACTORY_PARAMETER_VECTOR
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:461
gko::solver
The ginkgo Solve namespace.
Definition bicg.hpp:28
gko::solver::initial_guess_mode
initial_guess_mode
Give a initial guess mode about the input of the apply method.
Definition solver_base.hpp:33
gko::solver::initial_guess_mode::provided
@ provided
the input is provided
Definition solver_base.hpp:45
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::solver::Chebyshev::parameters_type
Definition chebyshev.hpp:127
gko::solver::Chebyshev::parameters_type::foci
std::pair< detail::coeff_type< value_type >, detail::coeff_type< value_type > > foci
The pair of foci of ellipse, which covers the eigenvalues of preconditioned system.
Definition chebyshev.hpp:139
gko::solver::Chebyshev::parameters_type::default_initial_guess
initial_guess_mode default_initial_guess
Default initial guess mode.
Definition chebyshev.hpp:146
gko::solver::enable_preconditioned_iterative_solver_factory_parameters
Definition solver_base.hpp:855
gko::solver::workspace_traits
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238