Ginkgo: ginkgo/core/factorization/par_ilu.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_ilu.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_ILU_HPP_
6#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILU_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
69template <typename ValueType = default_precision, typename IndexType = int32>
70 class ParIlu : public Composition<ValueType> {
71 GKO_ASSERT_SUPPORTED_VALUE_AND_INDEX_TYPE;
72
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
100 GKO_CREATE_FACTORY_PARAMETERS(parameters, Factory)
101 {
108 size_type GKO_FACTORY_PARAMETER_SCALAR(iterations, 0);
109
120 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
121
126 std::shared_ptr<typename matrix_type::strategy_type>
127 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
128
133 std::shared_ptr<typename matrix_type::strategy_type>
134 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
135 };
136 GKO_ENABLE_LIN_OP_FACTORY(ParIlu, parameters, Factory);
137 GKO_ENABLE_BUILD_METHOD(Factory);
138
152 static parameters_type parse(
153 const config::pnode& config, const config::registry& context,
154 const config::type_descriptor& td_for_child =
155 config::make_type_descriptor<ValueType, IndexType>());
156
157protected:
158 explicit ParIlu(const Factory* factory,
159 std::shared_ptr<const LinOp> system_matrix)
160 : Composition<ValueType>(factory->get_executor()),
161 parameters_{factory->get_parameters()}
162 {
163 if (parameters_.l_strategy == nullptr) {
164 parameters_.l_strategy =
165 std::make_shared<typename matrix_type::classical>();
166 }
167 if (parameters_.u_strategy == nullptr) {
168 parameters_.u_strategy =
169 std::make_shared<typename matrix_type::classical>();
170 }
171 generate_l_u(system_matrix, parameters_.skip_sorting,
172 parameters_.l_strategy, parameters_.u_strategy)
173 ->move_to(this);
174 }
175
193 std::unique_ptr<Composition<ValueType>> generate_l_u(
194 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
195 std::shared_ptr<typename matrix_type::strategy_type> l_strategy,
196 std::shared_ptr<typename matrix_type::strategy_type> u_strategy) const;
197};
198
199
200} // namespace factorization
201} // namespace gko
202
203
204#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILU_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::ParIlu::Factory
Definition par_ilu.hpp:136
gko::factorization::ParIlu::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::ParIlu::parameters_type
Definition par_ilu.hpp:101
gko::factorization::ParIlu::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_ilu.hpp:127
gko::factorization::ParIlu::parameters_type::skip_sorting
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ilu.hpp:120
gko::factorization::ParIlu::parameters_type::iterations
size_type iterations
The number of iterations the compute kernel will use when doing the factorization.
Definition par_ilu.hpp:108
gko::factorization::ParIlu::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_ilu.hpp:134