Ginkgo Generated from branch based on main. Ginkgo version 1.9.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#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/matrix/csr.hpp>
17
18
19namespace gko {
25namespace factorization {
26
27
71template <typename ValueType = default_precision, typename IndexType = int32>
72class ParIlut : public Composition<ValueType> {
73public:
74 using value_type = ValueType;
75 using index_type = IndexType;
76 using matrix_type = matrix::Csr<ValueType, IndexType>;
77 using l_matrix_type = matrix_type;
78 using u_matrix_type = matrix_type;
79
80 std::shared_ptr<const matrix_type> get_l_factor() const
81 {
82 // Can be `static_cast` since the type is guaranteed in this class
83 return std::static_pointer_cast<const matrix_type>(
84 this->get_operators()[0]);
85 }
86
87 std::shared_ptr<const matrix_type> get_u_factor() const
88 {
89 // Can be `static_cast` since the type is guaranteed in this class
90 return std::static_pointer_cast<const matrix_type>(
91 this->get_operators()[1]);
92 }
93
94 // Remove the possibility of calling `create`, which was enabled by
95 // `Composition`
96 template <typename... Args>
97 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
98 delete;
99
101 {
107
126
142
161
176
181 std::shared_ptr<typename matrix_type::strategy_type>
183
188 std::shared_ptr<typename matrix_type::strategy_type>
190 };
191 GKO_ENABLE_LIN_OP_FACTORY(ParIlut, parameters, Factory);
193
208 const config::pnode& config, const config::registry& context,
209 const config::type_descriptor& td_for_child =
210 config::make_type_descriptor<ValueType, IndexType>());
211
212protected:
213 explicit ParIlut(const Factory* factory,
214 std::shared_ptr<const LinOp> system_matrix)
215 : Composition<ValueType>(factory->get_executor()),
216 parameters_{factory->get_parameters()}
217 {
218 if (parameters_.l_strategy == nullptr) {
219 parameters_.l_strategy =
220 std::make_shared<typename matrix_type::classical>();
221 }
222 if (parameters_.u_strategy == nullptr) {
223 parameters_.u_strategy =
224 std::make_shared<typename matrix_type::classical>();
225 }
226 generate_l_u(std::move(system_matrix))->move_to(this);
227 }
228
241 std::unique_ptr<Composition<ValueType>> generate_l_u(
242 const std::shared_ptr<const LinOp>& system_matrix) const;
243};
244
245
246} // namespace factorization
247} // namespace gko
248
249
250#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_HPP_
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:234
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 par_ilut.hpp:191
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:121
#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
The Ginkgo namespace.
Definition abstract_factory.hpp:20
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:89
double fill_in_limit
the amount of fill-in that is allowed in L and U compared to the ILU(0) factorization.
Definition par_ilut.hpp:175
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilut.hpp:182
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilut.hpp:189
bool approximate_select
true means the candidate selection will use an inexact selection algorithm.
Definition par_ilut.hpp:141
bool skip_sorting
true means it is known that the matrix given to this factory will be sorted first by row,...
Definition par_ilut.hpp:125
bool deterministic_sample
true means the sample used for the selection algorithm will be chosen deterministically.
Definition par_ilut.hpp:160
size_type iterations
The number of total iterations of ParILUT that will be executed.
Definition par_ilut.hpp:106