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
nested_dissection.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_REORDER_NESTED_DISSECTION_HPP_
34#define GKO_PUBLIC_CORE_REORDER_NESTED_DISSECTION_HPP_
35
36
37#include <ginkgo/config.hpp>
38
39
40#if GKO_HAVE_METIS
41
42
43#include <memory>
44#include <unordered_map>
45
46
47#include <ginkgo/core/base/abstract_factory.hpp>
48#include <ginkgo/core/base/array.hpp>
49#include <ginkgo/core/base/dim.hpp>
50#include <ginkgo/core/base/lin_op.hpp>
51#include <ginkgo/core/base/polymorphic_object.hpp>
52#include <ginkgo/core/base/types.hpp>
53#include <ginkgo/core/matrix/csr.hpp>
54#include <ginkgo/core/matrix/permutation.hpp>
55
56
57namespace gko {
58namespace experimental {
64namespace reorder {
65
66
75template <typename ValueType, typename IndexType>
77 : public EnablePolymorphicObject<NestedDissection<ValueType, IndexType>,
78 LinOpFactory>,
79 public EnablePolymorphicAssignment<
80 NestedDissection<ValueType, IndexType>> {
81public:
82 struct parameters_type;
83 friend class EnablePolymorphicObject<NestedDissection<ValueType, IndexType>,
84 LinOpFactory>;
85 friend class enable_parameters_type<parameters_type,
86 NestedDissection<ValueType, IndexType>>;
87
88 using value_type = ValueType;
89 using index_type = IndexType;
90 using matrix_type = matrix::Csr<value_type, index_type>;
91 using permutation_type = matrix::Permutation<index_type>;
92
93 struct parameters_type
94 : public enable_parameters_type<
95 parameters_type, NestedDissection<ValueType, IndexType>> {
100 std::unordered_map<int, int> options;
101
106 parameters_type& with_options(std::unordered_map<int, int> options)
107 {
108 this->options = std::move(options);
109 return *this;
110 }
111 };
112
118 const parameters_type& get_parameters() { return parameters_; }
119
127 std::unique_ptr<permutation_type> generate(
128 std::shared_ptr<const LinOp> system_matrix) const;
129
131 static parameters_type build() { return {}; }
132
133protected:
134 explicit NestedDissection(std::shared_ptr<const Executor> exec,
135 const parameters_type& params = {});
136
137 std::unique_ptr<LinOp> generate_impl(
138 std::shared_ptr<const LinOp> system_matrix) const override;
139
140private:
141 parameters_type parameters_;
142};
143
144
145} // namespace reorder
146} // namespace experimental
147} // namespace gko
148
149
150#endif // GKO_HAVE_METIS
151
152
153#endif // GKO_PUBLIC_CORE_REORDER_NESTED_DISSECTION_HPP_
The Ginkgo namespace.
Definition abstract_factory.hpp:48
constexpr T one()
Returns the multiplicative identity for T.
Definition math.hpp:803