DOLFINx 0.9.0
DOLFINx C++ interface
Loading...
Searching...
No Matches
SparsityPattern.h
1// Copyright (C) 2007-2020 Garth N. Wells
2//
3// This file is part of DOLFINx (https://www.fenicsproject.org)
4//
5// SPDX-License-Identifier: LGPL-3.0-or-later
6
7#pragma once
8
9#include <dolfinx/common/MPI.h>
10#include <memory>
11#include <span>
12#include <utility>
13#include <vector>
14
15namespace dolfinx::common
16{
17class IndexMap;
18}
19
20namespace dolfinx::la
21{
26{
27public:
34 MPI_Comm comm,
35 const std::array<std::shared_ptr<const common::IndexMap>, 2>& maps,
36 const std::array<int, 2>& bs);
37
49 MPI_Comm comm,
50 const std::vector<std::vector<const SparsityPattern*>>& patterns,
51 const std::array<
52 std::vector<
53 std::pair<std::reference_wrapper<const common::IndexMap>, int>>,
54 2>& maps,
55 const std::array<std::vector<int>, 2>& bs);
56
57 SparsityPattern(const SparsityPattern& pattern) = delete;
58
60 SparsityPattern(SparsityPattern&& pattern) = default;
61
63 ~SparsityPattern() = default;
64
67
72 void insert(std::int32_t row, std::int32_t col);
73
83 void insert(std::span<const std::int32_t> rows,
84 std::span<const std::int32_t> cols);
85
89 void insert_diagonal(std::span<const std::int32_t> rows);
90
92 void finalize();
93
98 std::shared_ptr<const common::IndexMap> index_map(int dim) const;
99
106 std::vector<std::int64_t> column_indices() const;
107
115
117 int block_size(int dim) const;
118
121 std::int64_t num_nonzeros() const;
122
126 std::int32_t nnz_diag(std::int32_t row) const;
127
131 std::int32_t nnz_off_diag(std::int32_t row) const;
132
139 std::pair<std::span<const std::int32_t>, std::span<const std::int64_t>>
140 graph() const;
141
145 std::span<const std::int32_t> off_diagonal_offsets() const;
146
148 MPI_Comm comm() const;
149
150private:
151 // MPI communicator
152 dolfinx::MPI::Comm _comm;
153
154 // Index maps for each dimension
155 std::array<std::shared_ptr<const common::IndexMap>, 2> _index_maps;
156
157 // Block size
158 std::array<int, 2> _bs;
159
160 // Non-zero ghost columns in owned rows
161 std::vector<std::int64_t> _col_ghosts;
162
163 // Owning process of ghost columns in owned rows
164 std::vector<std::int32_t> _col_ghost_owners;
165
166 // Cache for unassembled entries on owned and unowned (ghost) rows
167 std::vector<std::vector<std::int32_t>> _row_cache;
168
169 // Sparsity pattern adjacency data (computed once pattern is
170 // finalised). _edges holds the edges (connected dofs). The edges for
171 // node i are in the range [_offsets[i], _offsets[i + 1]).
172 std::vector<std::int32_t> _edges;
173 std::vector<std::int64_t> _offsets;
174
175 // Start of off-diagonal (unowned columns) on each row (row-wise)
176 std::vector<std::int32_t> _off_diagonal_offsets;
177};
178} // namespace dolfinx::la
A duplicate MPI communicator and manage lifetime of the communicator.
Definition MPI.h:43
Definition IndexMap.h:94
Definition SparsityPattern.h:26
SparsityPattern(SparsityPattern &&pattern)=default
Move constructor.
std::shared_ptr< const common::IndexMap > index_map(int dim) const
Index map for given dimension dimension. Returns the index map for rows and columns that will be set ...
Definition SparsityPattern.cpp:213
std::int32_t nnz_off_diag(std::int32_t row) const
Number of non-zeros in unowned columns (off-diagonal block) on a given row.
Definition SparsityPattern.cpp:422
void finalize()
Finalize sparsity pattern and communicate off-process entries.
Definition SparsityPattern.cpp:245
int block_size(int dim) const
Return index map block size for dimension dim.
Definition SparsityPattern.cpp:243
std::int32_t nnz_diag(std::int32_t row) const
Number of non-zeros in owned columns (diagonal block) on a given row.
Definition SparsityPattern.cpp:415
void insert(std::int32_t row, std::int32_t col)
Insert non-zero locations using local (process-wise) indices.
Definition SparsityPattern.cpp:143
void insert_diagonal(std::span< const std::int32_t > rows)
Insert non-zero locations on the diagonal.
Definition SparsityPattern.cpp:188
std::int64_t num_nonzeros() const
Number of nonzeros on this rank after assembly, including ghost rows.
Definition SparsityPattern.cpp:408
std::span< const std::int32_t > off_diagonal_offsets() const
Row-wise start of off-diagonals (unowned columns) for each row.
Definition SparsityPattern.cpp:437
std::vector< std::int64_t > column_indices() const
Global indices of non-zero columns on owned rows.
Definition SparsityPattern.cpp:218
common::IndexMap column_index_map() const
Builds the index map for columns after assembly of the sparsity pattern.
Definition SparsityPattern.cpp:232
SparsityPattern(MPI_Comm comm, const std::array< std::shared_ptr< const common::IndexMap >, 2 > &maps, const std::array< int, 2 > &bs)
Create an empty sparsity pattern with specified dimensions.
Definition SparsityPattern.cpp:19
MPI_Comm comm() const
Return MPI communicator.
Definition SparsityPattern.cpp:444
SparsityPattern & operator=(SparsityPattern &&pattern)=default
Move assignment.
~SparsityPattern()=default
Destructor.
std::pair< std::span< const std::int32_t >, std::span< const std::int64_t > > graph() const
Sparsity pattern graph after assembly. Uses local indices for the columns.
Definition SparsityPattern.cpp:430
Miscellaneous classes, functions and types.
Definition dolfinx_common.h:8
Linear algebra interface.
Definition sparsitybuild.h:15