DOLFIN-X
DOLFIN-X C++ interface
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 <Eigen/Dense>
10 #include <dolfinx/common/MPI.h>
11 #include <memory>
12 #include <string>
13 #include <utility>
14 #include <vector>
15 
16 namespace dolfinx
17 {
18 
19 namespace graph
20 {
21 template <typename T>
22 class AdjacencyList;
23 }
24 
25 namespace common
26 {
27 class IndexMap;
28 }
29 
30 namespace la
31 {
32 
35 
37 {
38 
39 public:
42  MPI_Comm comm,
43  const std::array<std::shared_ptr<const common::IndexMap>, 2>& index_maps);
44 
55  MPI_Comm comm,
56  const std::vector<std::vector<const SparsityPattern*>>& patterns,
57  const std::array<
58  std::vector<std::reference_wrapper<const common::IndexMap>>, 2>&
59  maps);
60 
61  SparsityPattern(const SparsityPattern& pattern) = delete;
62 
64  SparsityPattern(SparsityPattern&& pattern) = default;
65 
67  ~SparsityPattern() = default;
68 
70  SparsityPattern& operator=(SparsityPattern&& pattern) = default;
71 
73  std::array<std::int64_t, 2> local_range(int dim) const;
74 
76  std::shared_ptr<const common::IndexMap> index_map(int dim) const;
77 
79  void
80  insert(const Eigen::Ref<const Eigen::Array<std::int32_t, Eigen::Dynamic, 1>>&
81  rows,
82  const Eigen::Ref<const Eigen::Array<std::int32_t, Eigen::Dynamic, 1>>&
83  cols);
84 
88  void insert_diagonal(
89  const Eigen::Ref<const Eigen::Array<std::int32_t, Eigen::Dynamic, 1>>&
90  rows);
91 
93  void assemble();
94 
96  std::int64_t num_nonzeros() const;
97 
101 
105 
107  MPI_Comm mpi_comm() const;
108 
109 private:
110  // MPI communicator
111  dolfinx::MPI::Comm _mpi_comm;
112 
113  // common::IndexMaps for each dimension
114  std::array<std::shared_ptr<const common::IndexMap>, 2> _index_maps;
115 
116  // Caches for diagonal and off-diagonal blocks
117  std::vector<std::vector<std::int32_t>> _diagonal_cache;
118  std::vector<std::vector<std::int64_t>> _off_diagonal_cache;
119 
120  // Sparsity pattern data (computed once pattern is finalised)
121  std::shared_ptr<graph::AdjacencyList<std::int32_t>> _diagonal;
122  std::shared_ptr<graph::AdjacencyList<std::int64_t>> _off_diagonal;
123 };
124 } // namespace la
125 } // namespace dolfinx
dolfinx::la::SparsityPattern::SparsityPattern
SparsityPattern(MPI_Comm comm, const std::array< std::shared_ptr< const common::IndexMap >, 2 > &index_maps)
Create an empty sparsity pattern with specified dimensions.
Definition: SparsityPattern.cpp:19
dolfinx::la::SparsityPattern::local_range
std::array< std::int64_t, 2 > local_range(int dim) const
Return local range for dimension dim.
Definition: SparsityPattern.cpp:172
dolfinx::la::SparsityPattern::insert
void insert(const Eigen::Ref< const Eigen::Array< std::int32_t, Eigen::Dynamic, 1 >> &rows, const Eigen::Ref< const Eigen::Array< std::int32_t, Eigen::Dynamic, 1 >> &cols)
Insert non-zero locations using local (process-wise) indices.
Definition: SparsityPattern.cpp:185
dolfinx::la::SparsityPattern
This class provides a sparsity pattern data structure that can be used to initialize sparse matrices.
Definition: SparsityPattern.h:36
dolfinx::la::SparsityPattern::mpi_comm
MPI_Comm mpi_comm() const
Return MPI communicator.
Definition: SparsityPattern.cpp:409
dolfinx::la::SparsityPattern::insert_diagonal
void insert_diagonal(const Eigen::Ref< const Eigen::Array< std::int32_t, Eigen::Dynamic, 1 >> &rows)
Insert non-zero locations on the diagonal.
Definition: SparsityPattern.cpp:230
dolfinx::graph::AdjacencyList
This class provides a static adjacency list data structure. It is commonly used to store directed gra...
Definition: AdjacencyList.h:27
dolfinx::la::SparsityPattern::~SparsityPattern
~SparsityPattern()=default
Destructor.
dolfinx::la::SparsityPattern::assemble
void assemble()
Finalize sparsity pattern and communicate off-process entries.
Definition: SparsityPattern.cpp:255
dolfinx::la::SparsityPattern::diagonal_pattern
const graph::AdjacencyList< std::int32_t > & diagonal_pattern() const
Sparsity pattern for the owned (diagonal) block. Uses local indices for the columns.
Definition: SparsityPattern.cpp:394
dolfinx::MPI::Comm
A duplicate MPI communicator and manage lifetime of the communicator.
Definition: MPI.h:35
dolfinx::la::SparsityPattern::operator=
SparsityPattern & operator=(SparsityPattern &&pattern)=default
Move assignment.
dolfinx::la::SparsityPattern::index_map
std::shared_ptr< const common::IndexMap > index_map(int dim) const
Return index map for dimension dim.
Definition: SparsityPattern.cpp:180
dolfinx::la::SparsityPattern::num_nonzeros
std::int64_t num_nonzeros() const
Return number of local nonzeros.
Definition: SparsityPattern.cpp:385
dolfinx::la::SparsityPattern::off_diagonal_pattern
const graph::AdjacencyList< std::int64_t > & off_diagonal_pattern() const
Sparsity pattern for the un-owned (off-diagonal) columns. Uses global indices for the columns.
Definition: SparsityPattern.cpp:402