Ginkgo: ginkgo/core/factorization/par_ilut.hpp Source File

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
par_ilut.hpp
1// SPDX-FileCopyrightText: 2017 - 2025 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>
72 class ParIlut : public Composition<ValueType> {
73 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
74
75public:
76 using value_type = ValueType;
77 using index_type = IndexType;
78 using matrix_type = matrix::Csr<ValueType, IndexType>;
79 using l_matrix_type = matrix_type;
80 using u_matrix_type = matrix_type;
81
82 std::shared_ptr<const matrix_type> get_l_factor() const
83 {
84 // Can be `static_cast` since the type is guaranteed in this class
85 return std::static_pointer_cast<const matrix_type>(
86 this->get_operators()[0]);
87 }
88
89 std::shared_ptr<const matrix_type> get_u_factor() const
90 {
91 // Can be `static_cast` since the type is guaranteed in this class
92 return std::static_pointer_cast<const matrix_type>(
93 this->get_operators()[1]);
94 }
95
96 // Remove the possibility of calling `create`, which was enabled by
97 // `Composition`
98 template <typename... Args>
99 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
100 delete;
101
102 GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
103 {
108 size_type GKO_FACTORY_PARAMETER_SCALAR(iterations, 5);
109
127 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
128
143 bool GKO_FACTORY_PARAMETER_SCALAR(approximate_select, true);
144
162 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic_sample, false);
163
177 double GKO_FACTORY_PARAMETER_SCALAR(fill_in_limit, 2.0);
178
183 std::shared_ptr<typename matrix_type::strategy_type>
184 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
185
190 std::shared_ptr<typename matrix_type::strategy_type>
191 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
192 };
193 GKO_ENABLE_LIN_OP_FACTORY(ParIlut, parameters, Factory);
194 GKO_ENABLE_BUILD_METHOD(Factory);
195
209 static parameters_type parse(
210 const config::pnode& config, const config::registry& context,
211 const config::type_descriptor& td_for_child =
212 config::make_type_descriptor<ValueType, IndexType>());
213
214protected:
215 explicit ParIlut(const Factory* factory,
216 std::shared_ptr<const LinOp> system_matrix)
217 : Composition<ValueType>(factory->get_executor()),
218 parameters_{factory->get_parameters()}
219 {
220 if (parameters_.l_strategy == nullptr) {
221 parameters_.l_strategy =
222 std::make_shared<typename matrix_type::classical>();
223 }
224 if (parameters_.u_strategy == nullptr) {
225 parameters_.u_strategy =
226 std::make_shared<typename matrix_type::classical>();
227 }
228 generate_l_u(std::move(system_matrix))->move_to(this);
229 }
230
243 std::unique_ptr<Composition<ValueType>> generate_l_u(
244 const std::shared_ptr<const LinOp>& system_matrix) const;
245};
246
247
248} // namespace factorization
249} // namespace gko
250
251
252#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_HPP_
gko::Composition< default_precision >::Composition
Composition(const Composition &)
gko::Composition< default_precision >::get_operators
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Definition composition.hpp:55
gko::config::pnode
pnode describes a tree of properties.
Definition property_tree.hpp:28
gko::config::registry
This class stores additional context for creating Ginkgo objects from configuration files.
Definition registry.hpp:167
gko::config::type_descriptor
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition type_descriptor.hpp:39
gko::factorization::ParIlut::Factory
Definition par_ilut.hpp:193
gko::factorization::ParIlut::parse
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.
gko::matrix::Csr
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:126
GKO_CREATE_FACTORY_PARAMETERS
#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
GKO_FACTORY_PARAMETER_SCALAR
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
GKO_ENABLE_BUILD_METHOD
#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
GKO_ENABLE_LIN_OP_FACTORY
#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
gko::factorization
The Factorization namespace.
Definition ic.hpp:26
gko
The Ginkgo namespace.
Definition abstract_factory.hpp:20
gko::size_type
std::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:90
gko::factorization::ParIlut::parameters_type
Definition par_ilut.hpp:103
gko::factorization::ParIlut::parameters_type::fill_in_limit
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:177
gko::factorization::ParIlut::parameters_type::l_strategy
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilut.hpp:184
gko::factorization::ParIlut::parameters_type::u_strategy
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilut.hpp:191
gko::factorization::ParIlut::parameters_type::approximate_select
bool approximate_select
true means the candidate selection will use an inexact selection algorithm.
Definition par_ilut.hpp:143
gko::factorization::ParIlut::parameters_type::skip_sorting
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:127
gko::factorization::ParIlut::parameters_type::deterministic_sample
bool deterministic_sample
true means the sample used for the selection algorithm will be chosen deterministically.
Definition par_ilut.hpp:162
gko::factorization::ParIlut::parameters_type::iterations
size_type iterations
The number of total iterations of ParILUT that will be executed.
Definition par_ilut.hpp:108