Ginkgo: ginkgo/core/preconditioner/sor.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
sor.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_
6#define GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_
7
8
9#include <vector>
10
11#include <ginkgo/core/base/abstract_factory.hpp>
12#include <ginkgo/core/base/composition.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/polymorphic_object.hpp>
15#include <ginkgo/core/config/config.hpp>
16
17
18namespace gko {
19namespace preconditioner {
20
21
50template <typename ValueType = default_precision, typename IndexType = int32>
51 class Sor
52 : public EnablePolymorphicObject<Sor<ValueType, IndexType>, LinOpFactory>,
53 public EnablePolymorphicAssignment<Sor<ValueType, IndexType>> {
54 friend class EnablePolymorphicObject<Sor, LinOpFactory>;
55 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
56
57public:
58 struct parameters_type;
59 friend class enable_parameters_type<parameters_type, Sor>;
60
61 using value_type = ValueType;
62 using index_type = IndexType;
63 using composition_type = Composition<ValueType>;
64
65 struct parameters_type
66 : public enable_parameters_type<parameters_type, Sor> {
67 // skip sorting of input matrix
68 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
69
70 // determines if SOR or SSOR should be used
71 bool GKO_FACTORY_PARAMETER_SCALAR(symmetric, false);
72
73 // has to be between 0.0 and 2.0
74 remove_complex<value_type> GKO_FACTORY_PARAMETER_SCALAR(
75 relaxation_factor, remove_complex<value_type>(1.2));
76
77 // factory for the lower triangular factor solver, defaults to LowerTrs
78 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
79 l_solver);
80
81 // factory for the upper triangular factor solver, unused if symmetric
82 // is false, defaults to UpperTrs
83 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
84 u_solver);
85 };
86
92 const parameters_type& get_parameters() { return parameters_; }
93
97 const parameters_type& get_parameters() const { return parameters_; }
98
106 std::unique_ptr<composition_type> generate(
107 std::shared_ptr<const LinOp> system_matrix) const;
108
110 static parameters_type build() { return {}; }
111
112 static parameters_type parse(
113 const config::pnode& config, const config::registry& context,
114 const config::type_descriptor& td_for_child =
115 config::make_type_descriptor<ValueType, IndexType>());
116
117protected:
118 explicit Sor(std::shared_ptr<const Executor> exec,
119 const parameters_type& params = {})
120 : EnablePolymorphicObject<Sor, LinOpFactory>(exec), parameters_(params)
121 {
122 GKO_ASSERT(parameters_.relaxation_factor > 0.0 &&
123 parameters_.relaxation_factor < 2.0);
124 }
125
126 std::unique_ptr<LinOp> generate_impl(
127 std::shared_ptr<const LinOp> system_matrix) const override;
128
129private:
130 parameters_type parameters_;
131};
132} // namespace preconditioner
133} // namespace gko
134
135
136#endif // GKO_PUBLIC_CORE_PRECONDITIONER_SOR_HPP_
gko::Composition
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
gko::EnablePolymorphicAssignment
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:743
gko::EnablePolymorphicObject
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:668
gko::LinOpFactory
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:385
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::enable_parameters_type
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
gko::preconditioner::Sor
This class generates the (S)SOR preconditioner.
Definition sor.hpp:53
gko::preconditioner::Sor::get_parameters
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition sor.hpp:92
gko::preconditioner::Sor::build
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition sor.hpp:110
gko::preconditioner::Sor::get_parameters
const parameters_type & get_parameters() const
Returns the parameters used to construct the factory.
Definition sor.hpp:97
gko::preconditioner::Sor::generate
std::unique_ptr< composition_type > generate(std::shared_ptr< const LinOp > system_matrix) const
Creates a new product from the given components.
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::preconditioner
The Preconditioner namespace.
Definition gauss_seidel.hpp:19
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::remove_complex
typename detail::remove_complex_s< T >::type remove_complex
Obtain the type which removed the complex of complex/scalar type or the template parameter of class b...
Definition math.hpp:264
gko::preconditioner::Sor::parameters_type
Definition sor.hpp:66