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
ilu.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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#include <ginkgo/core/base/composition.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/factorization/incomplete_factorization.hpp>
17#include <ginkgo/core/matrix/csr.hpp>
18
19
20namespace gko {
26namespace factorization {
27
28
43template <typename ValueType = gko::default_precision,
44 typename IndexType = gko::int32>
45class Ilu : public Composition<ValueType> {
46public:
47 using value_type = ValueType;
48 using index_type = IndexType;
49 using matrix_type = matrix::Csr<ValueType, IndexType>;
50
51 std::shared_ptr<const matrix_type> get_l_factor() const
52 {
53 // Can be `static_cast` since the type is guaranteed in this class
54 return std::static_pointer_cast<const matrix_type>(
55 this->get_operators()[0]);
56 }
57
58 std::shared_ptr<const matrix_type> get_u_factor() const
59 {
60 // Can be `static_cast` since the type is guaranteed in this class
61 return std::static_pointer_cast<const matrix_type>(
62 this->get_operators()[1]);
63 }
64
65 // Remove the possibility of calling `create`, which was enabled by
66 // `Composition`
67 template <typename... Args>
68 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
69 delete;
70
72 {
77 std::shared_ptr<typename matrix_type::strategy_type>
79
84 std::shared_ptr<typename matrix_type::strategy_type>
86
98
107 algorithm, incomplete_algorithm::sparselib);
108 };
109 GKO_ENABLE_LIN_OP_FACTORY(Ilu, parameters, Factory);
111
126 const config::pnode& config, const config::registry& context,
127 const config::type_descriptor& td_for_child =
128 config::make_type_descriptor<ValueType, IndexType>());
129
130protected:
131 Ilu(const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
132 : Composition<ValueType>{factory->get_executor()},
133 parameters_{factory->get_parameters()}
134 {
135 if (parameters_.l_strategy == nullptr) {
136 parameters_.l_strategy =
137 std::make_shared<typename matrix_type::classical>();
138 }
139 if (parameters_.u_strategy == nullptr) {
140 parameters_.u_strategy =
141 std::make_shared<typename matrix_type::classical>();
142 }
143 generate_l_u(system_matrix, parameters_.skip_sorting)->move_to(this);
144 }
145
161 std::unique_ptr<Composition<ValueType>> generate_l_u(
162 const std::shared_ptr<const LinOp>& system_matrix,
163 bool skip_sorting) const;
164};
165
166
167} // namespace factorization
168} // namespace gko
169
170
171#endif // GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Definition composition.hpp:54
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
Definition ilu.hpp:109
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.
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
#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:1017
The Factorization namespace.
Definition ic.hpp:26
incomplete_algorithm
An enum class for algorithm selection in the incomplete factorization.
Definition incomplete_factorization.hpp:19
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:107
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:172
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition ilu.hpp:97
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition ilu.hpp:78
incomplete_algorithm algorithm
Select the implementation which is supposed to be used for the incomplete factorization.
Definition ilu.hpp:107
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition ilu.hpp:85