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_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#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>
70class ParIlu : public Composition<ValueType> {
71public:
72 using value_type = ValueType;
73 using index_type = IndexType;
74 using matrix_type = matrix::Csr<ValueType, IndexType>;
75 using l_matrix_type = matrix_type;
76 using u_matrix_type = matrix_type;
77
78 std::shared_ptr<const matrix_type> get_l_factor() const
79 {
80 // Can be `static_cast` since the type is guaranteed in this class
81 return std::static_pointer_cast<const matrix_type>(
82 this->get_operators()[0]);
83 }
84
85 std::shared_ptr<const matrix_type> get_u_factor() const
86 {
87 // Can be `static_cast` since the type is guaranteed in this class
88 return std::static_pointer_cast<const matrix_type>(
89 this->get_operators()[1]);
90 }
91
92 // Remove the possibility of calling `create`, which was enabled by
93 // `Composition`
94 template <typename... Args>
95 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
96 delete;
97
99 {
107
119
124 std::shared_ptr<typename matrix_type::strategy_type>
126
131 std::shared_ptr<typename matrix_type::strategy_type>
133 };
134 GKO_ENABLE_LIN_OP_FACTORY(ParIlu, parameters, Factory);
136
151 const config::pnode& config, const config::registry& context,
152 const config::type_descriptor& td_for_child =
153 config::make_type_descriptor<ValueType, IndexType>());
154
155protected:
156 explicit ParIlu(const Factory* factory,
157 std::shared_ptr<const LinOp> system_matrix)
158 : Composition<ValueType>(factory->get_executor()),
159 parameters_{factory->get_parameters()}
160 {
161 if (parameters_.l_strategy == nullptr) {
162 parameters_.l_strategy =
163 std::make_shared<typename matrix_type::classical>();
164 }
165 if (parameters_.u_strategy == nullptr) {
166 parameters_.u_strategy =
167 std::make_shared<typename matrix_type::classical>();
168 }
169 generate_l_u(system_matrix, parameters_.skip_sorting,
170 parameters_.l_strategy, parameters_.u_strategy)
171 ->move_to(this);
172 }
173
191 std::unique_ptr<Composition<ValueType>> generate_l_u(
192 const std::shared_ptr<const LinOp>& system_matrix, bool skip_sorting,
193 std::shared_ptr<typename matrix_type::strategy_type> l_strategy,
194 std::shared_ptr<typename matrix_type::strategy_type> u_strategy) const;
195};
196
197
198} // namespace factorization
199} // namespace gko
200
201
202#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILU_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_ilu.hpp:134
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
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilu.hpp:125
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition par_ilu.hpp:118
size_type iterations
The number of iterations the compute kernel will use when doing the factorization.
Definition par_ilu.hpp:106
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilu.hpp:132