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
par_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_PAR_ILU_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_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
68template <typename ValueType = default_precision, typename IndexType = int32>
69class ParIlu : public Composition<ValueType> {
70public:
71 using value_type = ValueType;
72 using index_type = IndexType;
76
77 std::shared_ptr<const matrix_type> get_l_factor() const
78 {
79 // Can be `static_cast` since the type is guaranteed in this class
80 return std::static_pointer_cast<const matrix_type>(
81 this->get_operators()[0]);
82 }
83
84 std::shared_ptr<const matrix_type> get_u_factor() const
85 {
86 // Can be `static_cast` since the type is guaranteed in this class
87 return std::static_pointer_cast<const matrix_type>(
88 this->get_operators()[1]);
89 }
90
91 // Remove the possibility of calling `create`, which was enabled by
92 // `Composition`
93 template <typename... Args>
94 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
95 delete;
96
98 {
106
117 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
118
123 std::shared_ptr<typename matrix_type::strategy_type>
124 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
125
130 std::shared_ptr<typename matrix_type::strategy_type>
131 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
132 };
135
136protected:
137 explicit ParIlu(const Factory* factory,
138 std::shared_ptr<const LinOp> system_matrix)
139 : Composition<ValueType>(factory->get_executor()),
140 parameters_{factory->get_parameters()}
141 {
142 if (parameters_.l_strategy == nullptr) {
143 parameters_.l_strategy =
144 std::make_shared<typename matrix_type::classical>();
145 }
146 if (parameters_.u_strategy == nullptr) {
147 parameters_.u_strategy =
148 std::make_shared<typename matrix_type::classical>();
149 }
150 generate_l_u(system_matrix, parameters_.skip_sorting,
151 parameters_.l_strategy, parameters_.u_strategy)
152 ->move_to(this);
153 }
154
172 std::unique_ptr<Composition<ValueType>> generate_l_u(
173 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
174 std::shared_ptr<typename matrix_type::strategy_type> l_strategy,
175 std::shared_ptr<typename matrix_type::strategy_type> u_strategy) const;
176};
177
178
179} // namespace factorization
180} // namespace gko
181
182
183#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_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
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
Definition par_ilu.hpp:133
ParILU is an incomplete LU factorization which is computed in parallel.
Definition par_ilu.hpp:69
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::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:92
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilu.hpp:124
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ilu.hpp:117
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilu.hpp:131