Ginkgo: ginkgo/core/preconditioner/isai.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
isai.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_PRECONDITIONER_ISAI_HPP_
6#define GKO_PUBLIC_CORE_PRECONDITIONER_ISAI_HPP_
7
8
9#include <memory>
10
11#include <ginkgo/core/base/composition.hpp>
12#include <ginkgo/core/base/exception_helpers.hpp>
13#include <ginkgo/core/base/executor.hpp>
14#include <ginkgo/core/base/lin_op.hpp>
15#include <ginkgo/core/config/config.hpp>
16#include <ginkgo/core/config/registry.hpp>
17#include <ginkgo/core/matrix/csr.hpp>
18#include <ginkgo/core/matrix/dense.hpp>
19
20
21namespace gko {
27namespace preconditioner {
28
29
36 enum struct isai_type { lower, upper, general, spd };
37
78template <isai_type IsaiType, typename ValueType, typename IndexType>
79 class Isai : public EnableLinOp<Isai<IsaiType, ValueType, IndexType>>,
80 public Transposable {
81 friend class EnableLinOp<Isai>;
82 friend class EnablePolymorphicObject<Isai, LinOp>;
83 friend class Isai<isai_type::general, ValueType, IndexType>;
84 friend class Isai<isai_type::lower, ValueType, IndexType>;
85 friend class Isai<isai_type::upper, ValueType, IndexType>;
86 friend class Isai<isai_type::spd, ValueType, IndexType>;
87 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
88
89public:
90 using value_type = ValueType;
91 using index_type = IndexType;
92 using transposed_type =
93 Isai<IsaiType == isai_type::general ? isai_type::general
94 : IsaiType == isai_type::spd ? isai_type::spd
95 : IsaiType == isai_type::lower ? isai_type::upper
96 : isai_type::lower,
97 ValueType, IndexType>;
98 using Comp = Composition<ValueType>;
99 using Csr = matrix::Csr<ValueType, IndexType>;
100 using Dense = matrix::Dense<ValueType>;
101 static constexpr isai_type type{IsaiType};
102
110 std::shared_ptr<const typename std::conditional<IsaiType == isai_type::spd,
111 Comp, Csr>::type>
112 get_approximate_inverse() const
113 {
114 return as<typename std::conditional<IsaiType == isai_type::spd, Comp,
115 Csr>::type>(approximate_inverse_);
116 }
117
123 Isai& operator=(const Isai& other);
124
131 Isai& operator=(Isai&& other);
132
137 Isai(const Isai& other);
138
144 Isai(Isai&& other);
145
146 GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
147 {
156 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
157
166 int GKO_FACTORY_PARAMETER_SCALAR(sparsity_power, 1);
167
179 size_type GKO_FACTORY_PARAMETER_SCALAR(excess_limit, 0u);
180
187 std::shared_ptr<const LinOpFactory> GKO_DEFERRED_FACTORY_PARAMETER(
188 excess_solver_factory);
189
190 remove_complex<value_type> GKO_FACTORY_PARAMETER_SCALAR(
191 excess_solver_reduction,
192 static_cast<remove_complex<value_type>>(1e-6));
193 };
194
195 GKO_ENABLE_LIN_OP_FACTORY(Isai, parameters, Factory);
196 GKO_ENABLE_BUILD_METHOD(Factory);
197
211 static parameters_type parse(
212 const config::pnode& config, const config::registry& context,
213 const config::type_descriptor& td_for_child =
214 config::make_type_descriptor<ValueType, IndexType>());
215
216 std::unique_ptr<LinOp> transpose() const override;
217
218 std::unique_ptr<LinOp> conj_transpose() const override;
219
220protected:
221 explicit Isai(std::shared_ptr<const Executor> exec)
222 : EnableLinOp<Isai>(std::move(exec))
223 {}
224
231 explicit Isai(const Factory* factory,
232 std::shared_ptr<const LinOp> system_matrix)
233 : EnableLinOp<Isai>(factory->get_executor(), system_matrix->get_size()),
234 parameters_{factory->get_parameters()}
235 {
236 const auto skip_sorting = parameters_.skip_sorting;
237 const auto power = parameters_.sparsity_power;
238 const auto excess_limit = parameters_.excess_limit;
239 generate_inverse(system_matrix, skip_sorting, power, excess_limit,
240 static_cast<remove_complex<value_type>>(
241 parameters_.excess_solver_reduction));
242 if (IsaiType == isai_type::spd) {
243 auto inv = share(as<Csr>(approximate_inverse_));
244 auto inv_transp = share(inv->conj_transpose());
245 approximate_inverse_ =
246 Composition<ValueType>::create(inv_transp, inv);
247 }
248 }
249
250 void apply_impl(const LinOp* b, LinOp* x) const override
251 {
252 approximate_inverse_->apply(b, x);
253 }
254
255 void apply_impl(const LinOp* alpha, const LinOp* b, const LinOp* beta,
256 LinOp* x) const override
257 {
258 approximate_inverse_->apply(alpha, b, beta, x);
259 }
260
261private:
272 void generate_inverse(std::shared_ptr<const LinOp> to_invert,
273 bool skip_sorting, int power, index_type excess_limit,
274 remove_complex<value_type> excess_solver_reduction);
275
276private:
277 std::shared_ptr<LinOp> approximate_inverse_;
278};
279
280
281template <typename ValueType = default_precision, typename IndexType = int32>
282using LowerIsai = Isai<isai_type::lower, ValueType, IndexType>;
283
284template <typename ValueType = default_precision, typename IndexType = int32>
285using UpperIsai = Isai<isai_type::upper, ValueType, IndexType>;
286
287template <typename ValueType = default_precision, typename IndexType = int32>
288using GeneralIsai = Isai<isai_type::general, ValueType, IndexType>;
289
290template <typename ValueType = default_precision, typename IndexType = int32>
291using SpdIsai = Isai<isai_type::spd, ValueType, IndexType>;
292
293
294} // namespace preconditioner
295} // namespace gko
296
297
298#endif // GKO_PUBLIC_CORE_PRECONDITIONER_ISAI_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::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::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
gko::matrix::Dense
Dense is a matrix format which explicitly stores all values of the matrix.
Definition dense.hpp:120
gko::preconditioner::Isai::Factory
Definition isai.hpp:195
gko::preconditioner::Isai
The Incomplete Sparse Approximate Inverse (ISAI) Preconditioner generates an approximate inverse matr...
Definition isai.hpp:80
gko::preconditioner::Isai::Isai
Isai(const Isai &other)
Copy-constructs an ISAI preconditioner.
gko::preconditioner::Isai::transpose
std::unique_ptr< LinOp > transpose() const override
Returns a LinOp representing the transpose of the Transposable object.
gko::preconditioner::Isai::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, IndexType >())
Create the parameters from the property_tree.
gko::preconditioner::Isai::operator=
Isai & operator=(Isai &&other)
Move-assigns an ISAI preconditioner.
gko::preconditioner::Isai::Isai
Isai(Isai &&other)
Move-constructs an ISAI preconditioner.
gko::preconditioner::Isai::conj_transpose
std::unique_ptr< LinOp > conj_transpose() const override
Returns a LinOp representing the conjugate transpose of the Transposable object.
gko::preconditioner::Isai::get_approximate_inverse
std::shared_ptr< const typename std::conditional< IsaiType==isai_type::spd, Comp, Csr >::type > get_approximate_inverse() const
Returns the approximate inverse of the given matrix (either a CSR matrix for IsaiType general,...
Definition isai.hpp:112
gko::preconditioner::Isai::operator=
Isai & operator=(const Isai &other)
Copy-assigns an ISAI preconditioner.
GKO_CREATE_FACTORY_PARAMETERS
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition abstract_factory.hpp:280
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::preconditioner
The Preconditioner namespace.
Definition gauss_seidel.hpp:19
gko::preconditioner::isai_type
isai_type
This enum lists the types of the ISAI preconditioner.
Definition isai.hpp:36
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::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::as
std::decay_t< T > * as(U *obj)
Performs polymorphic type conversion.
Definition utils_helper.hpp:307
gko::share
detail::shared_type< OwningPointer > share(OwningPointer &&p)
Marks the object pointed to by p as shared.
Definition utils_helper.hpp:224
std
STL namespace.
gko::preconditioner::Isai::parameters_type::skip_sorting
bool skip_sorting
Optimization parameter that skips the sorting of the input matrix (only skip if it is known that it i...
Definition isai.hpp:156
gko::preconditioner::Isai::parameters_type::excess_solver_factory
std::shared_ptr< const LinOpFactory > excess_solver_factory
Factory for the Excess System solver.
Definition isai.hpp:188
gko::preconditioner::Isai::parameters_type::sparsity_power
int sparsity_power
Which power of the input matrix should be used for the sparsity pattern.
Definition isai.hpp:166
gko::preconditioner::Isai::parameters_type::excess_limit
size_type excess_limit
Size limit for the excess system.
Definition isai.hpp:179