Reference documentation for deal.II version GIT relicensing-12-g89ba5bf9db 2024-02-24 00:00:03+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
dof_info.h
Go to the documentation of this file.
1// ------------------------------------------------------------------------
2//
3// SPDX-License-Identifier: LGPL-2.1-or-later
4// Copyright (C) 2012 - 2023 by the deal.II authors
5//
6// This file is part of the deal.II library.
7//
8// Part of the source code is dual licensed under Apache-2.0 WITH
9// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10// governing the source code and code contributions can be found in
11// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12//
13// ------------------------------------------------------------------------
14
15
16#ifndef dealii_matrix_free_dof_info_h
17#define dealii_matrix_free_dof_info_h
18
19
20#include <deal.II/base/config.h>
21
24
27
28#include <array>
29#include <memory>
30
31
33
34#ifndef DOXYGEN
35
36// forward declarations
37
38namespace internal
39{
40 namespace MatrixFreeFunctions
41 {
42 template <int dim>
43 class HangingNodes;
44
45 struct TaskInfo;
46
47 template <typename Number>
48 struct ConstraintValues;
49
50 namespace VectorDataExchange
51 {
52 class Base;
53 }
54 } // namespace MatrixFreeFunctions
55} // namespace internal
56
57template <typename>
59
61
62template <typename>
63class TriaIterator;
64
65template <int, int, bool>
66class DoFCellAccessor;
67
68namespace Utilities
69{
70 namespace MPI
71 {
72 class Partitioner;
73 }
74} // namespace Utilities
75
76#endif
77
78namespace internal
79{
80 namespace MatrixFreeFunctions
81 {
86 using compressed_constraint_kind = std::uint8_t;
87
106 struct DoFInfo
107 {
120 static const unsigned int chunk_size_zero_vector = 64;
121
125 DoFInfo();
126
130 DoFInfo(const DoFInfo &) = default;
131
135 DoFInfo(DoFInfo &&) noexcept = default;
136
140 ~DoFInfo() = default;
141
145 DoFInfo &
146 operator=(const DoFInfo &) = default;
147
151 DoFInfo &
152 operator=(DoFInfo &&) noexcept = default;
153
157 void
158 clear();
159
165 unsigned int
166 fe_index_from_degree(const unsigned int first_selected_component,
167 const unsigned int fe_degree) const;
168
188 void
189 get_dof_indices_on_cell_batch(std::vector<unsigned int> &local_indices,
190 const unsigned int cell_batch,
191 const bool with_constraints = true) const;
192
202 template <typename number>
203 void
205 const std::vector<types::global_dof_index> &local_indices_resolved,
206 const std::vector<types::global_dof_index> &local_indices,
207 const bool cell_has_hanging_nodes,
208 const ::AffineConstraints<number> &constraints,
209 const unsigned int cell_number,
210 ConstraintValues<double> &constraint_values,
211 bool &cell_at_boundary);
212
217 template <int dim>
218 bool
220 const HangingNodes<dim> &hanging_nodes,
221 const std::vector<std::vector<unsigned int>> &lexicographic_mapping,
222 const unsigned int cell_number,
223 const TriaIterator<DoFCellAccessor<dim, dim, false>> &cell,
224 std::vector<types::global_dof_index> &dof_indices);
225
233 void
234 assign_ghosts(const std::vector<unsigned int> &boundary_cells,
235 const MPI_Comm communicator_sm,
236 const bool use_vector_data_exchanger_full);
237
244 void
245 reorder_cells(const TaskInfo &task_info,
246 const std::vector<unsigned int> &renumbering,
247 const std::vector<unsigned int> &constraint_pool_row_index,
248 const std::vector<unsigned char> &irregular_cells);
249
254 void
256 const std::vector<unsigned char> &irregular_cells);
257
262 template <int length>
263 void
265 const std::vector<FaceToCellTopology<length>> &faces);
266
272 void
273 make_connectivity_graph(const TaskInfo &task_info,
274 const std::vector<unsigned int> &renumbering,
275 DynamicSparsityPattern &connectivity) const;
276
282 void
284 const Table<2, ShapeInfo<double>> &shape_info,
285 const unsigned int n_owned_cells,
286 const unsigned int n_lanes,
287 const std::vector<FaceToCellTopology<1>> &inner_faces,
288 const std::vector<FaceToCellTopology<1>> &ghosted_faces,
289 const bool fill_cell_centric,
290 const MPI_Comm communicator_sm,
291 const bool use_vector_data_exchanger_full);
292
298 void
300 std::array<std::vector<std::pair<unsigned int, unsigned int>>, 3>
301 &cell_indices_contiguous_sm);
302
313 void
315 std::vector<types::global_dof_index> &renumbering);
316
326 template <int length>
327 void
329 const TaskInfo &task_info,
330 const std::vector<FaceToCellTopology<length>> &faces);
331
335 std::size_t
336 memory_consumption() const;
337
342 template <typename StreamType>
343 void
345 const TaskInfo &size_info) const;
346
351 template <typename Number>
352 void
353 print(const std::vector<Number> &constraint_pool_data,
354 const std::vector<unsigned int> &constraint_pool_row_index,
355 std::ostream &out) const;
356
450
470
480
488 std::array<std::vector<IndexStorageVariants>, 3> index_storage_variants;
489
496 std::vector<std::pair<unsigned int, unsigned int>> row_starts;
497
513 std::vector<unsigned int> dof_indices;
514
519 std::vector<std::vector<bool>> hanging_node_constraint_masks_comp;
520
525 std::vector<compressed_constraint_kind> hanging_node_constraint_masks;
526
536 std::vector<std::pair<unsigned short, unsigned short>>
538
542 std::vector<unsigned int> dof_indices_interleaved;
543
552 std::array<std::vector<unsigned int>, 3> dof_indices_contiguous;
553
562 std::array<std::vector<std::pair<unsigned int, unsigned int>>, 3>
564
573 std::array<std::vector<unsigned int>, 3> dof_indices_interleave_strides;
574
584 std::array<std::vector<unsigned char>, 3> n_vectorization_lanes_filled;
585
592 std::shared_ptr<const Utilities::MPI::Partitioner> vector_partitioner;
593
597 std::shared_ptr<
600
620 std::array<
621 std::shared_ptr<
623 5>
625
630 std::vector<unsigned int> constrained_dofs;
631
636 std::vector<unsigned int> row_starts_plain_indices;
637
646 std::vector<unsigned int> plain_dof_indices;
647
653
658 unsigned int n_base_elements;
659
664 std::vector<unsigned int> n_components;
665
670 std::vector<unsigned int> start_components;
671
676 std::vector<unsigned int> component_to_base_index;
677
689 std::vector<std::vector<unsigned int>> component_dof_indices_offset;
690
694 std::vector<unsigned int> dofs_per_cell;
695
699 std::vector<unsigned int> dofs_per_face;
700
705
709 std::vector<unsigned int> cell_active_fe_index;
710
715 unsigned int max_fe_index;
716
722 std::vector<std::vector<unsigned int>> fe_index_conversion;
723
729 std::vector<types::global_dof_index> ghost_dofs;
730
736 std::vector<unsigned int> vector_zero_range_list_index;
737
741 std::vector<std::pair<unsigned int, unsigned int>> vector_zero_range_list;
742
748 std::vector<unsigned int> cell_loop_pre_list_index;
749
754 std::vector<std::pair<unsigned int, unsigned int>> cell_loop_pre_list;
755
761 std::vector<unsigned int> cell_loop_post_list_index;
762
767 std::vector<std::pair<unsigned int, unsigned int>> cell_loop_post_list;
768 };
769
770
771 /*-------------------------- Inline functions ---------------------------*/
772
773#ifndef DOXYGEN
774
775
776 inline unsigned int
777 DoFInfo::fe_index_from_degree(const unsigned int first_selected_component,
778 const unsigned int fe_degree) const
779 {
780 const unsigned int n_indices = fe_index_conversion.size();
781 if (n_indices <= 1)
782 return 0;
783 for (unsigned int i = 0; i < n_indices; ++i)
784 if (fe_index_conversion[i][first_selected_component] == fe_degree)
785 return i;
787 }
788
789#endif // ifndef DOXYGEN
790
791 } // end of namespace MatrixFreeFunctions
792} // end of namespace internal
793
795
796#endif
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:502
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:503
std::uint8_t compressed_constraint_kind
Definition dof_info.h:86
static const unsigned int invalid_unsigned_int
Definition types.h:220
STL namespace.
Definition types.h:32
void print(const std::vector< Number > &constraint_pool_data, const std::vector< unsigned int > &constraint_pool_row_index, std::ostream &out) const
void reorder_cells(const TaskInfo &task_info, const std::vector< unsigned int > &renumbering, const std::vector< unsigned int > &constraint_pool_row_index, const std::vector< unsigned char > &irregular_cells)
Definition dof_info.cc:298
std::vector< std::pair< unsigned short, unsigned short > > constraint_indicator
Definition dof_info.h:537
std::vector< unsigned int > cell_loop_pre_list_index
Definition dof_info.h:748
std::vector< std::pair< unsigned int, unsigned int > > row_starts
Definition dof_info.h:496
std::vector< std::vector< unsigned int > > component_dof_indices_offset
Definition dof_info.h:689
void compute_tight_partitioners(const Table< 2, ShapeInfo< double > > &shape_info, const unsigned int n_owned_cells, const unsigned int n_lanes, const std::vector< FaceToCellTopology< 1 > > &inner_faces, const std::vector< FaceToCellTopology< 1 > > &ghosted_faces, const bool fill_cell_centric, const MPI_Comm communicator_sm, const bool use_vector_data_exchanger_full)
Definition dof_info.cc:895
std::vector< std::vector< bool > > hanging_node_constraint_masks_comp
Definition dof_info.h:519
void get_dof_indices_on_cell_batch(std::vector< unsigned int > &local_indices, const unsigned int cell_batch, const bool with_constraints=true) const
Definition dof_info.cc:82
unsigned int fe_index_from_degree(const unsigned int first_selected_component, const unsigned int fe_degree) const
void compute_cell_index_compression(const std::vector< unsigned char > &irregular_cells)
Definition dof_info.cc:530
void compute_face_index_compression(const std::vector< FaceToCellTopology< length > > &faces)
std::vector< unsigned int > cell_loop_post_list_index
Definition dof_info.h:761
std::vector< unsigned int > dofs_per_cell
Definition dof_info.h:694
void assign_ghosts(const std::vector< unsigned int > &boundary_cells, const MPI_Comm communicator_sm, const bool use_vector_data_exchanger_full)
Definition dof_info.cc:155
void compute_dof_renumbering(std::vector< types::global_dof_index > &renumbering)
Definition dof_info.cc:1469
static const unsigned int chunk_size_zero_vector
Definition dof_info.h:120
std::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base > vector_exchanger
Definition dof_info.h:599
std::vector< std::vector< unsigned int > > fe_index_conversion
Definition dof_info.h:722
std::vector< unsigned int > dof_indices
Definition dof_info.h:513
std::vector< std::pair< unsigned int, unsigned int > > vector_zero_range_list
Definition dof_info.h:741
std::shared_ptr< const Utilities::MPI::Partitioner > vector_partitioner
Definition dof_info.h:592
std::vector< compressed_constraint_kind > hanging_node_constraint_masks
Definition dof_info.h:525
std::array< std::vector< unsigned int >, 3 > dof_indices_interleave_strides
Definition dof_info.h:573
std::array< std::vector< std::pair< unsigned int, unsigned int > >, 3 > dof_indices_contiguous_sm
Definition dof_info.h:563
std::vector< unsigned int > row_starts_plain_indices
Definition dof_info.h:636
std::vector< unsigned int > dofs_per_face
Definition dof_info.h:699
std::vector< unsigned int > component_to_base_index
Definition dof_info.h:676
void compute_vector_zero_access_pattern(const TaskInfo &task_info, const std::vector< FaceToCellTopology< length > > &faces)
std::vector< unsigned int > n_components
Definition dof_info.h:664
void print_memory_consumption(StreamType &out, const TaskInfo &size_info) const
std::vector< std::pair< unsigned int, unsigned int > > cell_loop_pre_list
Definition dof_info.h:754
std::vector< types::global_dof_index > ghost_dofs
Definition dof_info.h:729
void read_dof_indices(const std::vector< types::global_dof_index > &local_indices_resolved, const std::vector< types::global_dof_index > &local_indices, const bool cell_has_hanging_nodes, const ::AffineConstraints< number > &constraints, const unsigned int cell_number, ConstraintValues< double > &constraint_values, bool &cell_at_boundary)
std::array< std::vector< unsigned int >, 3 > dof_indices_contiguous
Definition dof_info.h:552
bool process_hanging_node_constraints(const HangingNodes< dim > &hanging_nodes, const std::vector< std::vector< unsigned int > > &lexicographic_mapping, const unsigned int cell_number, const TriaIterator< DoFCellAccessor< dim, dim, false > > &cell, std::vector< types::global_dof_index > &dof_indices)
DoFInfo(const DoFInfo &)=default
std::vector< unsigned int > cell_active_fe_index
Definition dof_info.h:709
std::array< std::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base >, 5 > vector_exchanger_face_variants
Definition dof_info.h:624
std::vector< unsigned int > plain_dof_indices
Definition dof_info.h:646
std::array< std::vector< unsigned char >, 3 > n_vectorization_lanes_filled
Definition dof_info.h:584
std::vector< unsigned int > start_components
Definition dof_info.h:670
std::vector< unsigned int > dof_indices_interleaved
Definition dof_info.h:542
std::vector< unsigned int > constrained_dofs
Definition dof_info.h:630
std::array< std::vector< IndexStorageVariants >, 3 > index_storage_variants
Definition dof_info.h:488
void make_connectivity_graph(const TaskInfo &task_info, const std::vector< unsigned int > &renumbering, DynamicSparsityPattern &connectivity) const
Definition dof_info.cc:1392
std::vector< unsigned int > vector_zero_range_list_index
Definition dof_info.h:736
void compute_shared_memory_contiguous_indices(std::array< std::vector< std::pair< unsigned int, unsigned int > >, 3 > &cell_indices_contiguous_sm)
Definition dof_info.cc:1241
std::vector< std::pair< unsigned int, unsigned int > > cell_loop_post_list
Definition dof_info.h:767
DoFInfo(DoFInfo &&) noexcept=default