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
par_ilut.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_PAR_ILUT_HPP_
34#define GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_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
98template <typename ValueType = default_precision, typename IndexType = int32>
99class ParIlut : public Composition<ValueType> {
100public:
101 using value_type = ValueType;
102 using index_type = IndexType;
106
107 std::shared_ptr<const matrix_type> get_l_factor() const
108 {
109 // Can be `static_cast` since the type is guaranteed in this class
110 return std::static_pointer_cast<const matrix_type>(
111 this->get_operators()[0]);
112 }
113
114 std::shared_ptr<const matrix_type> get_u_factor() const
115 {
116 // Can be `static_cast` since the type is guaranteed in this class
117 return std::static_pointer_cast<const matrix_type>(
118 this->get_operators()[1]);
119 }
120
121 // Remove the possibility of calling `create`, which was enabled by
122 // `Composition`
123 template <typename... Args>
124 static std::unique_ptr<Composition<ValueType>> create(Args&&... args) =
125 delete;
126
128 {
134
152 bool GKO_FACTORY_PARAMETER_SCALAR(skip_sorting, false);
153
168 bool GKO_FACTORY_PARAMETER_SCALAR(approximate_select, true);
169
187 bool GKO_FACTORY_PARAMETER_SCALAR(deterministic_sample, false);
188
202 double GKO_FACTORY_PARAMETER_SCALAR(fill_in_limit, 2.0);
203
208 std::shared_ptr<typename matrix_type::strategy_type>
209 GKO_FACTORY_PARAMETER_SCALAR(l_strategy, nullptr);
210
215 std::shared_ptr<typename matrix_type::strategy_type>
216 GKO_FACTORY_PARAMETER_SCALAR(u_strategy, nullptr);
217 };
220
221protected:
222 explicit ParIlut(const Factory* factory,
223 std::shared_ptr<const LinOp> system_matrix)
224 : Composition<ValueType>(factory->get_executor()),
225 parameters_{factory->get_parameters()}
226 {
227 if (parameters_.l_strategy == nullptr) {
228 parameters_.l_strategy =
229 std::make_shared<typename matrix_type::classical>();
230 }
231 if (parameters_.u_strategy == nullptr) {
232 parameters_.u_strategy =
233 std::make_shared<typename matrix_type::classical>();
234 }
235 generate_l_u(std::move(system_matrix))->move_to(this);
236 }
237
250 std::unique_ptr<Composition<ValueType>> generate_l_u(
251 const std::shared_ptr<const LinOp>& system_matrix) const;
252};
253
254
255} // namespace factorization
256} // namespace gko
257
258
259#endif // GKO_PUBLIC_CORE_FACTORIZATION_PAR_ILUT_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
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition polymorphic_object.hpp:263
Definition par_ilut.hpp:218
ParILUT is an incomplete threshold-based LU factorization which is computed in parallel.
Definition par_ilut.hpp:99
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::size_t size_type
Integral type used for allocation quantities.
Definition types.hpp:120
std::shared_ptr< typename matrix_type::strategy_type > l_strategy
Strategy which will be used by the L matrix.
Definition par_ilut.hpp:209
std::shared_ptr< typename matrix_type::strategy_type > u_strategy
Strategy which will be used by the U matrix.
Definition par_ilut.hpp:216