Ginkgo Generated from develop branch based on develop. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
lu.hpp
1// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors
2//
3// SPDX-License-Identifier: BSD-3-Clause
4
5#include <memory>
6
7
8#include <ginkgo/core/base/composition.hpp>
9#include <ginkgo/core/base/lin_op.hpp>
10#include <ginkgo/core/base/polymorphic_object.hpp>
11#include <ginkgo/core/factorization/factorization.hpp>
12#include <ginkgo/core/matrix/csr.hpp>
13#include <ginkgo/core/matrix/sparsity_csr.hpp>
14
15
16namespace gko {
17namespace experimental {
18namespace factorization {
19
20
21enum class symbolic_type {
23 general,
29 near_symmetric,
36 symmetric
37};
38
39
50template <typename ValueType, typename IndexType>
51class Lu
52 : public EnablePolymorphicObject<Lu<ValueType, IndexType>, LinOpFactory>,
53 public EnablePolymorphicAssignment<Lu<ValueType, IndexType>> {
54public:
55 struct parameters_type;
58
59 using value_type = ValueType;
60 using index_type = IndexType;
64
66 : public enable_parameters_type<parameters_type, Lu> {
75 std::shared_ptr<const sparsity_pattern_type>
77
86 symbolic_type::general);
87
99 };
100
106 const parameters_type& get_parameters() { return parameters_; }
107
115 std::unique_ptr<factorization_type> generate(
116 std::shared_ptr<const LinOp> system_matrix) const;
117
119 static parameters_type build() { return {}; }
120
121protected:
122 explicit Lu(std::shared_ptr<const Executor> exec,
123 const parameters_type& params = {});
124
125 std::unique_ptr<LinOp> generate_impl(
126 std::shared_ptr<const LinOp> system_matrix) const override;
127
128private:
129 parameters_type parameters_;
130};
131
132
133} // namespace factorization
134} // namespace experimental
135} // namespace gko
This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...
Definition polymorphic_object.hpp:724
This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...
Definition polymorphic_object.hpp:663
A LinOpFactory represents a higher order mapping which transforms one linear operator into another.
Definition lin_op.hpp:386
The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...
Definition abstract_factory.hpp:211
Represents a generic factorization consisting of two triangular factors (upper and lower) and an opti...
Definition factorization.hpp:76
Computes an LU factorization of a sparse matrix.
Definition lu.hpp:53
std::unique_ptr< factorization_type > generate(std::shared_ptr< const LinOp > system_matrix) const
const parameters_type & get_parameters()
Returns the parameters used to construct the factory.
Definition lu.hpp:106
static parameters_type build()
Creates a new parameter_type to set up the factory.
Definition lu.hpp:119
CSR is a matrix format which stores only the nonzero coefficients by compressing each row of the matr...
Definition csr.hpp:117
SparsityCsr is a matrix format which stores only the sparsity pattern of a sparse matrix by compressi...
Definition sparsity_csr.hpp:57
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition abstract_factory.hpp:445
The Ginkgo namespace.
Definition abstract_factory.hpp:20
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:775
bool skip_sorting
The system_matrix, which will be given to this factory, must be sorted (first by row,...
Definition lu.hpp:98
std::shared_ptr< const sparsity_pattern_type > symbolic_factorization
The combined sparsity pattern L + U of the factors L and U.
Definition lu.hpp:76
symbolic_type symbolic_algorithm
If the symbolic factorization of the matrix is not provided to the factory, this parameter controls w...
Definition lu.hpp:86