Ginkgo Generated from branch based on master. 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/config/config.hpp>
16#include <ginkgo/core/config/registry.hpp>
17#include <ginkgo/core/matrix/csr.hpp>
18
19
20namespace gko {
26namespace factorization {
27
28
70template <typename ValueType = default_precision, typename IndexType = int32>
71class ParIlu : public Composition<ValueType> {
72public:
73 using value_type = ValueType;
74 using index_type = IndexType;
78
79 std::shared_ptr<const matrix_type> get_l_factor() const
80 {
81 // Can be `static_cast` since the type is guaranteed in this class
82 return std::static_pointer_cast<const matrix_type>(
83 this->get_operators()[0]);
84 }
85
86 std::shared_ptr<const matrix_type> get_u_factor() const
87 {
88 // Can be `static_cast` since the type is guaranteed in this class
89 return std::static_pointer_cast<const matrix_type>(
90 this->get_operators()[1]);
91 }
92
93 // Remove the possibility of calling `create`, which was enabled by
94 // `Composition`
95 template <typename... Args>
96 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
97 delete;
98
100 {
108
119 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
120
125 std::shared_ptr<typename matrix_type::strategy_type>
126 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
127
132 std::shared_ptr<typename matrix_type::strategy_type>
133 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
134 };
137
152 const config::pnode& config, const config::registry& context,
153 const config::type_descriptor& td_for_child =
154 config::make_type_descriptor<ValueType, IndexType>());
155
156protected:
157 explicit ParIlu(const Factory* factory,
158 std::shared_ptr<const LinOp> system_matrix)
159 : Composition<ValueType>(factory->get_executor()),
160 parameters_{factory->get_parameters()}
161 {
162 if (parameters_.l_strategy == nullptr) {
163 parameters_.l_strategy =
164 std::make_shared<typename matrix_type::classical>();
165 }
166 if (parameters_.u_strategy == nullptr) {
167 parameters_.u_strategy =
168 std::make_shared<typename matrix_type::classical>();
169 }
170 generate_l_u(system_matrix, parameters_.skip_sorting,
171 parameters_.l_strategy, parameters_.u_strategy)
172 ->move_to(this);
173 }
174
192 std::unique_ptr<Composition<ValueType>> generate_l_u(
193 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
194 std::shared_ptr<typename matrix_type::strategy_type> l_strategy,
195 std::shared_ptr<typename matrix_type::strategy_type> u_strategy) const;
196};
197
198
199} // namespace factorization
200} // namespace gko
201
202
203#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
Definition composition.hpp:54
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:235
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:168
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:37
Definition par_ilu.hpp:135
ParILU is an incomplete LU factorization which is computed in parallel.
Definition par_ilu.hpp:71
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 sparsity_csr.hpp:22
#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
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:86
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilu.hpp:126
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ilu.hpp:119
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilu.hpp:133