Ginkgo Generated from branch based on main. Ginkgo version 1.10.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>
62class 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>;
70 friend class EnableApplyWithInitialGuess<Chebyshev>;
71
72public:
73 using value_type = ValueType;
74 using transposed_type = Chebyshev<ValueType>;
75
76 std::unique_ptr<LinOp> transpose() const override;
77
78 std::unique_ptr<LinOp> conj_transpose() const override;
79
85 bool apply_uses_initial_guess() const override
86 {
87 return this->get_default_initial_guess() ==
89 }
90
98
107
113
121
122 class Factory;
123
126 parameters_type, Factory> {
134 std::pair<detail::coeff_type<value_type>,
135 detail::coeff_type<value_type>>
137 detail::coeff_type<value_type>{0},
138 detail::coeff_type<value_type>{1});
139
146 };
147
150
164 static parameters_type parse(const config::pnode& config,
165 const config::registry& context,
166 const config::type_descriptor& td_for_child =
167 config::make_type_descriptor<ValueType>());
168
169protected:
170 void apply_impl(const LinOp* b, LinOp* x) const override;
171
172 template <typename VectorType>
173 void apply_dense_impl(const VectorType* b, VectorType* x,
174 initial_guess_mode guess) const;
175
176 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
177 LinOp* x) const override;
178
179 void apply_with_initial_guess_impl(const LinOp* b, LinOp* x,
180 initial_guess_mode guess) const override;
181
182 void apply_with_initial_guess_impl(const LinOp* alpha, const LinOp* b,
183 const LinOp* beta, LinOp* x,
184 initial_guess_mode guess) const override;
185
186 explicit Chebyshev(std::shared_ptr<const Executor> exec);
187
188 explicit Chebyshev(const Factory* factory,
189 std::shared_ptr<const LinOp> system_matrix);
190
191private:
192 std::shared_ptr<const LinOp> solver_{};
193 detail::coeff_type<value_type> center_;
194 detail::coeff_type<value_type> foci_direction_;
195};
196
197
198template <typename ValueType>
199struct workspace_traits<Chebyshev<ValueType>> {
200 using Solver = Chebyshev<ValueType>;
201 // number of vectors used by this workspace
202 static int num_vectors(const Solver&);
203 // number of arrays used by this workspace
204 static int num_arrays(const Solver&);
205 // array containing the num_vectors names for the workspace vectors
206 static std::vector<std::string> op_names(const Solver&);
207 // array containing the num_arrays names for the workspace vectors
208 static std::vector<std::string> array_names(const Solver&);
209 // array containing all varying scalar vectors (independent of problem size)
210 static std::vector<int> scalars(const Solver&);
211 // array containing all varying vectors (dependent on problem size)
212 static std::vector<int> vectors(const Solver&);
213
214 // residual vector
215 constexpr static int residual = 0;
216 // inner solution vector
217 constexpr static int inner_solution = 1;
218 // update solution
219 constexpr static int update_solution = 2;
220 // constant 1.0 scalar
221 constexpr static int one = 3;
222 // constant -1.0 scalar
223 constexpr static int minus_one = 4;
224
225 // stopping status array
226 constexpr static int stop = 0;
227};
228
229
230} // namespace solver
231} // namespace gko
232
233
234#endif // GKO_PUBLIC_CORE_SOLVER_CHEBYSHEV_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:668
Definition lin_op.hpp:117
Linear operators which support transposition should implement the Transposable interface.
Definition lin_op.hpp:433
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
Chebyshev iteration is an iterative method for solving nonsymmetric problems based on some knowledge ...
Definition chebyshev.hpp:67
Chebyshev(Chebyshev &&)
Move-constructs an Chebyshev solver.
Chebyshev(const Chebyshev &)
Copy-constructs an Chebyshev solver.
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.
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate 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 chebyshev.hpp:85
Chebyshev & operator=(const Chebyshev &)
Copy-assigns a Chebyshev solver.
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
Chebyshev & operator=(Chebyshev &&)
Move-assigns a Chebyshev solver.
#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
#define GKO_FACTORY_PARAMETER_VECTOR(_name,...)
Creates a vector factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:461
The ginkgo Solve namespace.
Definition bicg.hpp:28
initial_guess_mode
Give a initial guess mode about the input of the apply method.
Definition solver_base.hpp:33
@ provided
the input is provided
Definition solver_base.hpp:45
The Ginkgo namespace.
Definition abstract_factory.hpp:20
Definition chebyshev.hpp:126
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:138
initial_guess_mode default_initial_guess
Default initial guess mode.
Definition chebyshev.hpp:145
Traits class providing information on the type and location of workspace vectors inside a solver.
Definition solver_base.hpp:238