Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
ilu.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#ifndef GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
7
8
9#include <memory>
10
11
12#include <ginkgo/core/base/composition.hpp>
13#include <ginkgo/core/base/lin_op.hpp>
14#include <ginkgo/core/base/types.hpp>
15#include <ginkgo/core/matrix/csr.hpp>
16
17
18namespace gko {
24namespace factorization {
25
26
41template <typename ValueType = gko::default_precision,
42 typename IndexType = gko::int32>
43class Ilu : public Composition<ValueType> {
44public:
45 using value_type = ValueType;
46 using index_type = IndexType;
48
49 std::shared_ptr<const matrix_type> get_l_factor() const
50 {
51 // Can be `static_cast` since the type is guaranteed in this class
52 return std::static_pointer_cast<const matrix_type>(
53 this->get_operators()[0]);
54 }
55
56 std::shared_ptr<const matrix_type> get_u_factor() const
57 {
58 // Can be `static_cast` since the type is guaranteed in this class
59 return std::static_pointer_cast<const matrix_type>(
60 this->get_operators()[1]);
61 }
62
63 // Remove the possibility of calling `create`, which was enabled by
64 // `Composition`
65 template <typename... Args>
66 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
67 delete;
68
70 {
75 std::shared_ptr<typename matrix_type::strategy_type>
76 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
77
82 std::shared_ptr<typename matrix_type::strategy_type>
83 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
84
95 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
96 };
99
100protected:
101 Ilu(const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
102 : Composition<ValueType>{factory->get_executor()},
103 parameters_{factory->get_parameters()}
104 {
105 if (parameters_.l_strategy == nullptr) {
106 parameters_.l_strategy =
107 std::make_shared<typename matrix_type::classical>();
108 }
109 if (parameters_.u_strategy == nullptr) {
110 parameters_.u_strategy =
111 std::make_shared<typename matrix_type::classical>();
112 }
113 generate_l_u(system_matrix, parameters_.skip_sorting)->move_to(this);
114 }
115
131 std::unique_ptr<Composition<ValueType>> generate_l_u(
132 const std::shared_ptr<const LinOp>& system_matrix,
133 bool skip_sorting) const;
134};
135
136
137} // namespace factorization
138} // namespace gko
139
140
141#endif // GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:41
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Returns a list of operators of the composition.
Definition composition.hpp:54
Represents an incomplete LU factorization – ILU(0) – of a sparse matrix.
Definition ilu.hpp:43
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:117
#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
#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:1018
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:109
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:177
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition ilu.hpp:95
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition ilu.hpp:76
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition ilu.hpp:83