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_ilut.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_ILUT_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_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
72template <typename ValueType = default_precision, typename IndexType = int32>
73class ParIlut : public Composition<ValueType> {
74public:
75 using value_type = ValueType;
76 using index_type = IndexType;
80
81 std::shared_ptr<const matrix_type> get_l_factor() const
82 {
83 // Can be `static_cast` since the type is guaranteed in this class
84 return std::static_pointer_cast<const matrix_type>(
85 this->get_operators()[0]);
86 }
87
88 std::shared_ptr<const matrix_type> get_u_factor() const
89 {
90 // Can be `static_cast` since the type is guaranteed in this class
91 return std::static_pointer_cast<const matrix_type>(
92 this->get_operators()[1]);
93 }
94
95 // Remove the possibility of calling `create`, which was enabled by
96 // `Composition`
97 template <typename... Args>
98 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
99 delete;
100
102 {
108
126 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
127
142 bool GKO_FACTORY_PARAMETER_SCALAR(approximate_select, true);
143
161 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic_sample, false);
162
176 double GKO_FACTORY_PARAMETER_SCALAR(fill_in_limit, 2.0);
177
182 std::shared_ptr<typename matrix_type::strategy_type>
183 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
184
189 std::shared_ptr<typename matrix_type::strategy_type>
190 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
191 };
194
209 const config::pnode& config, const config::registry& context,
210 const config::type_descriptor& td_for_child =
211 config::make_type_descriptor<ValueType, IndexType>());
212
213protected:
214 explicit ParIlut(const Factory* factory,
215 std::shared_ptr<const LinOp> system_matrix)
216 : Composition<ValueType>(factory->get_executor()),
217 parameters_{factory->get_parameters()}
218 {
219 if (parameters_.l_strategy == nullptr) {
220 parameters_.l_strategy =
221 std::make_shared<typename matrix_type::classical>();
222 }
223 if (parameters_.u_strategy == nullptr) {
224 parameters_.u_strategy =
225 std::make_shared<typename matrix_type::classical>();
226 }
227 generate_l_u(std::move(system_matrix))->move_to(this);
228 }
229
242 std::unique_ptr<Composition<ValueType>> generate_l_u(
243 const std::shared_ptr<const LinOp>& system_matrix) const;
244};
245
246
247} // namespace factorization
248} // namespace gko
249
250
251#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_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_ilut.hpp:192
ParILUT is an incomplete threshold-based LU factorization which is computed in parallel.
Definition par_ilut.hpp:73
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_ilut.hpp:183
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilut.hpp:190