Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
ilu.hpp
1/*******************************<GINKGO LICENSE>******************************
2Copyright (c) 2017-2023, the Ginkgo authors
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions
7are met:
8
91. Redistributions of source code must retain the above copyright
10notice, this list of conditions and the following disclaimer.
11
122. Redistributions in binary form must reproduce the above copyright
13notice, this list of conditions and the following disclaimer in the
14documentation and/or other materials provided with the distribution.
15
163. Neither the name of the copyright holder nor the names of its
17contributors may be used to endorse or promote products derived from
18this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
21IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31******************************<GINKGO LICENSE>*******************************/
32
33#ifndef GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
34#define GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
35
36
37#include <memory>
38
39
40#include <ginkgo/core/base/composition.hpp>
41#include <ginkgo/core/base/lin_op.hpp>
42#include <ginkgo/core/base/types.hpp>
43#include <ginkgo/core/matrix/csr.hpp>
44
45
46namespace gko {
52namespace factorization {
53
54
69template <typename ValueType = gko::default_precision,
70 typename IndexType = gko::int32>
71class Ilu : public Composition<ValueType> {
72public:
73 using value_type = ValueType;
74 using index_type = IndexType;
76
77 std::shared_ptr<const matrix_type> get_l_factor() const
78 {
79 // Can be `static_cast` since the type is guaranteed in this class
80 return std::static_pointer_cast<const matrix_type>(
81 this->get_operators()[0]);
82 }
83
84 std::shared_ptr<const matrix_type> get_u_factor() const
85 {
86 // Can be `static_cast` since the type is guaranteed in this class
87 return std::static_pointer_cast<const matrix_type>(
88 this->get_operators()[1]);
89 }
90
91 // Remove the possibility of calling `create`, which was enabled by
92 // `Composition`
93 template <typename... Args>
94 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
95 delete;
96
98 {
103 std::shared_ptr<typename matrix_type::strategy_type>
104 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
105
110 std::shared_ptr<typename matrix_type::strategy_type>
111 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
112
123 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
124 };
127
128protected:
129 Ilu(const Factory* factory, std::shared_ptr<const gko::LinOp> system_matrix)
130 : Composition<ValueType>{factory->get_executor()},
131 parameters_{factory->get_parameters()}
132 {
133 if (parameters_.l_strategy == nullptr) {
134 parameters_.l_strategy =
135 std::make_shared<typename matrix_type::classical>();
136 }
137 if (parameters_.u_strategy == nullptr) {
138 parameters_.u_strategy =
139 std::make_shared<typename matrix_type::classical>();
140 }
141 generate_l_u(system_matrix, parameters_.skip_sorting)->move_to(this);
142 }
143
159 std::unique_ptr<Composition<ValueType>> generate_l_u(
160 const std::shared_ptr<const LinOp>& system_matrix,
161 bool skip_sorting) const;
162};
163
164
165} // namespace factorization
166} // namespace gko
167
168
169#endif // GKO_PUBLIC_CORE_FACTORIZATION_ILU_HPP_
The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the opera...
Definition composition.hpp:69
const std::vector< std::shared_ptr< const LinOp > > & get_operators() const noexcept
Returns a list of operators of the composition.
Definition composition.hpp:82
Definition ilu.hpp:125
Represents an incomplete LU factorization – ILU(0) – of a sparse matrix.
Definition ilu.hpp:71
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:146
#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:308
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:473
#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:422
#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:1046
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803
std::int32_t int32
32-bit signed integral type.
Definition types.hpp:137
double default_precision
Precision used if no precision is explicitly specified.
Definition types.hpp:205
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition ilu.hpp:123
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition ilu.hpp:104
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition ilu.hpp:111