Reference documentation for deal.II version Git 06d359936b 20200919 18:16:22 0400

#include <deal.II/matrix_free/dof_info.h>
Public Types  
enum  IndexStorageVariants : unsigned char { IndexStorageVariants::full, IndexStorageVariants::interleaved, IndexStorageVariants::contiguous, IndexStorageVariants::interleaved_contiguous, IndexStorageVariants::interleaved_contiguous_strided, IndexStorageVariants::interleaved_contiguous_mixed_strides } 
enum  DoFAccessIndex : unsigned char { dof_access_face_interior = 0, dof_access_face_exterior = 1, dof_access_cell = 2 } 
Public Member Functions  
DoFInfo ()  
DoFInfo (const DoFInfo &)=default  
void  clear () 
unsigned int  fe_index_from_degree (const unsigned int first_selected_component, const unsigned int fe_degree) const 
void  get_dof_indices_on_cell_batch (std::vector< unsigned int > &locall_indices, const unsigned int cell, const bool with_constraints=true) const 
template<typename number >  
void  read_dof_indices (const std::vector< types::global_dof_index > &local_indices, const std::vector< unsigned int > &lexicographic_inv, const ::AffineConstraints< number > &constraints, const unsigned int cell_number, ConstraintValues< double > &constraint_values, bool &cell_at_boundary) 
void  assign_ghosts (const std::vector< unsigned int > &boundary_cells) 
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) 
void  compute_cell_index_compression (const std::vector< unsigned char > &irregular_cells) 
template<int length>  
void  compute_face_index_compression (const std::vector< FaceToCellTopology< length >> &faces) 
void  make_connectivity_graph (const TaskInfo &task_info, const std::vector< unsigned int > &renumbering, DynamicSparsityPattern &connectivity) const 
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) 
void  compute_dof_renumbering (std::vector< types::global_dof_index > &renumbering) 
template<int length>  
void  compute_vector_zero_access_pattern (const TaskInfo &task_info, const std::vector< FaceToCellTopology< length >> &faces) 
std::size_t  memory_consumption () const 
template<typename StreamType >  
void  print_memory_consumption (StreamType &out, const TaskInfo &size_info) const 
template<typename Number >  
void  print (const std::vector< Number > &constraint_pool_data, const std::vector< unsigned int > &constraint_pool_row_index, std::ostream &out) const 
Public Attributes  
unsigned int  dimension 
unsigned int  vectorization_length 
std::array< std::vector< IndexStorageVariants >, 3 >  index_storage_variants 
std::vector< std::pair< unsigned int, unsigned int > >  row_starts 
std::vector< unsigned int >  dof_indices 
std::vector< std::pair< unsigned short, unsigned short > >  constraint_indicator 
std::vector< unsigned int >  dof_indices_interleaved 
std::array< std::vector< unsigned int >, 3 >  dof_indices_contiguous 
std::array< std::vector< unsigned int >, 3 >  dof_indices_interleave_strides 
std::array< std::vector< unsigned char >, 3 >  n_vectorization_lanes_filled 
std::shared_ptr< const Utilities::MPI::Partitioner >  vector_partitioner 
std::array< std::shared_ptr< const Utilities::MPI::Partitioner >, 5 >  vector_partitioner_face_variants 
std::vector< unsigned int >  constrained_dofs 
std::vector< unsigned int >  row_starts_plain_indices 
std::vector< unsigned int >  plain_dof_indices 
unsigned int  global_base_element_offset 
unsigned int  n_base_elements 
std::vector< unsigned int >  n_components 
std::vector< unsigned int >  start_components 
std::vector< unsigned int >  component_to_base_index 
std::vector< std::vector< unsigned int > >  component_dof_indices_offset 
std::vector< unsigned int >  dofs_per_cell 
std::vector< unsigned int >  dofs_per_face 
bool  store_plain_indices 
std::vector< unsigned int >  cell_active_fe_index 
unsigned int  max_fe_index 
std::vector< std::vector< unsigned int > >  fe_index_conversion 
std::vector< types::global_dof_index >  ghost_dofs 
std::vector< unsigned int >  vector_zero_range_list_index 
std::vector< std::pair< unsigned int, unsigned int > >  vector_zero_range_list 
std::vector< unsigned int >  cell_loop_pre_list_index 
std::vector< std::pair< unsigned int, unsigned int > >  cell_loop_pre_list 
std::vector< unsigned int >  cell_loop_post_list_index 
std::vector< std::pair< unsigned int, unsigned int > >  cell_loop_post_list 
Static Public Attributes  
static const unsigned int  chunk_size_zero_vector = 64 
The class that stores the indices of the degrees of freedom for all the cells. Essentially, this is a smart number cache in the style of a DoFHandler that also embeds the description of constraints directly on the cell level without the need to refer to the external AffineConstraints object.
This class only stores index relations. The weights for hanging node constraints are stored in a different field. This is because a different field allows for the same compressed weight data on different DoFHandlers for vectorvalued problems. There, the indices might be constrained differently on different components (e.g. Dirichlet conditions only on selected components), whereas the weights from hanging nodes are the same and need to be stored only once. The combination will be handled in the MatrixFree class.
Definition at line 98 of file dof_info.h.

strong 
Enum for various storage variants of the indices. This storage format is used to implement more efficient indexing schemes in case the underlying data structures allow for them, and to inform the access functions in FEEvaluationBase::read_write_operation() on which array to get the data from. One example of more efficient storage is the enum value IndexStorageVariants::contiguous, which means that one can get the indices to all degrees of freedom of a cell by reading only the first index for each cell, whereas all subsequent indices are merely an offset from the first index.
Enumerator  

full  This value indicates that no index compression was found and the only valid storage is to access all indices present on the cell, possibly including constraints. For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array 
interleaved  This value indicates that the indices are interleaved for access with vectorized gather and scatter operation. This storage variant is possible in case there are no constraints on the cell and the indices in the batch of cells are not pointing to the same global index in different slots of a vectorized array (in order to support scatter operations). For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array 
contiguous  This value indicates that the indices within a cell are all contiguous, and one can get the index to the cell by reading that single value for each of the cells in the cell batch. For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array 
interleaved_contiguous  This value indicates that the indices with a cell are contiguous and interleaved for vectorization, i.e., the first DoF index on a cell to the four or eight cells in the vectorization batch come first, than the second DoF index, and so on. Furthermore, the interleaving between cells implies that only the batches for vectorization can be accessed efficiently, whereas there is a strided access for getting only some of the entries. The two additional categories For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array 
interleaved_contiguous_strided  Similar to interleaved_contiguous storage, but for the case when the interleaved indices are only contiguous within the degrees of freedom, but not also over the components of a vectorized array. This happens typically on faces with DG where the cells have 
interleaved_contiguous_mixed_strides  Similar to interleaved_contiguous_separate storage, but for the case when the interleaved indices are not 
Definition at line 309 of file dof_info.h.
enum internal::MatrixFreeFunctions::DoFInfo::DoFAccessIndex : unsigned char 
Enum used to distinguish the data arrays for the vectorization type in cells and faces.
Definition at line 396 of file dof_info.h.
internal::MatrixFreeFunctions::DoFInfo::DoFInfo  (  ) 
Default empty constructor.

default 
Copy constructor.
void internal::MatrixFreeFunctions::DoFInfo::clear  (  ) 
Clear all data fields in this class.
unsigned int internal::MatrixFreeFunctions::DoFInfo::fe_index_from_degree  (  const unsigned int  first_selected_component, 
const unsigned int  fe_degree  
)  const 
Return the FE index for a given finite element degree. If not in hp mode, this function always returns index 0. If an index is not found in hp mode, it returns numbers::invalid_unsigned_int.
void internal::MatrixFreeFunctions::DoFInfo::get_dof_indices_on_cell_batch  (  std::vector< unsigned int > &  locall_indices, 
const unsigned int  cell,  
const bool  with_constraints = true 

)  const 
Populate the vector locall_indices
with locally owned degrees of freedom stored on the cell block cell
. If with_constraints
is true
, then the returned vector will contain indices required to resolve constraints.
The image below illustrates the output of this function for cell blocks zero and one with zero Dirichlet boundary conditions at the bottom of the domain. Note that due to the presence of constraints, the DoFs returned by this function for the case with_constraints = true
are not a simple union of per cell DoFs on the cell block cell
.
std::sort()
followed by std::unique()
and std::vector::erase()
. template void internal::MatrixFreeFunctions::DoFInfo::read_dof_indices< float >  (  const std::vector< types::global_dof_index > &  local_indices, 
const std::vector< unsigned int > &  lexicographic_inv,  
const ::AffineConstraints< number > &  constraints,  
const unsigned int  cell_number,  
ConstraintValues< double > &  constraint_values,  
bool &  cell_at_boundary  
) 
This internal method takes the local indices on a cell and fills them into this class. It resolves the constraints and distributes the results. Ghost indices, i.e., indices that are located on another processor, get a temporary number by this function, and will later be assigned the correct index after all the ghost indices have been collected by the call to assign_ghosts
.
void internal::MatrixFreeFunctions::DoFInfo::assign_ghosts  (  const std::vector< unsigned int > &  boundary_cells  ) 
This method assigns the correct indices to ghost indices from the temporary numbering employed by the read_dof_indices
function. The numbers are localized with respect to the MPI process, and ghosts start at the end of the locally owned range. This way, we get direct access to all vector entries.
void internal::MatrixFreeFunctions::DoFInfo::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  
) 
This method reorders the way cells are gone through based on a given renumbering of the cells. It also takes vectorization_length
cells together and interprets them as one cell only, as is needed for vectorization.
void internal::MatrixFreeFunctions::DoFInfo::compute_cell_index_compression  (  const std::vector< unsigned char > &  irregular_cells  ) 
Finds possible compression for the cell indices that we can apply for increased efficiency. Run at the end of reorder_cells.
template void internal::MatrixFreeFunctions::DoFInfo::compute_face_index_compression< 16 >  (  const std::vector< FaceToCellTopology< length >> &  faces  ) 
Finds possible compression for the face indices that we can apply for increased efficiency. Run at the end of reorder_cells.
void internal::MatrixFreeFunctions::DoFInfo::make_connectivity_graph  (  const TaskInfo &  task_info, 
const std::vector< unsigned int > &  renumbering,  
DynamicSparsityPattern &  connectivity  
)  const 
This function computes the connectivity of the currently stored indices in terms of connections between the individual cells and fills the structure into a sparsity pattern.
void internal::MatrixFreeFunctions::DoFInfo::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  
) 
In case face integrals are enabled, find out whether certain loops over the unknowns only access a subset of all the ghost dofs we keep in the main partitioner.
void internal::MatrixFreeFunctions::DoFInfo::compute_dof_renumbering  (  std::vector< types::global_dof_index > &  renumbering  ) 
Compute a renumbering of the degrees of freedom to improve the data access patterns for this class that can be utilized by the categories in the IndexStorageVariants enum. For example, the index ordering can be improved for typical DG elements by interleaving the degrees of freedom from batches of cells, which avoids the explicit data transposition in IndexStorageVariants::contiguous. Currently, these more advanced features are not implemented, so there is only limited value of this function.
template void internal::MatrixFreeFunctions::DoFInfo::compute_vector_zero_access_pattern< 16 >  (  const TaskInfo &  task_info, 
const std::vector< FaceToCellTopology< length >> &  faces  
) 
Fills the array that defines how to zero selected ranges in the result vector within the cell loop, filling the two member variables vector_zero_range_list_index
and vector_zero_range_list
.
The intent of this pattern is to zero the vector entries in close temporal proximity to the first access and thus keeping the vector entries in cache.
std::size_t internal::MatrixFreeFunctions::DoFInfo::memory_consumption  (  )  const 
Return the memory consumption in bytes of this class.
template void internal::MatrixFreeFunctions::DoFInfo::print_memory_consumption< ConditionalOStream >  (  StreamType &  out, 
const TaskInfo &  size_info  
)  const 
Prints a detailed summary of memory consumption in the different structures of this class to the given output stream.
template void internal::MatrixFreeFunctions::DoFInfo::print< float >  (  const std::vector< Number > &  constraint_pool_data, 
const std::vector< unsigned int > &  constraint_pool_row_index,  
std::ostream &  out  
)  const 
Prints a representation of the indices in the class to the given output stream.

static 
This value is used to define subranges in the vectors which we can zero inside the MatrixFree::loop() call. The goal is to only clear a part of the vector at a time to keep the values that are zeroed in caches, saving one global vector access for the case where this is applied rather than vector = 0.;
.
We set the granularity to 64  that is a number sufficiently large to minimize loop peel overhead within the work (and compatible with vectorization lengths of up to 16) and small enough to not waste on the size of the individual chunks.
Definition at line 112 of file dof_info.h.
unsigned int internal::MatrixFreeFunctions::DoFInfo::dimension 
Stores the dimension of the underlying DoFHandler. Since the indices are not templated, this is the variable that makes the dimension accessible in the (rare) cases it is needed inside this class.
Definition at line 417 of file dof_info.h.
unsigned int internal::MatrixFreeFunctions::DoFInfo::vectorization_length 
For efficiency reasons, always keep a fixed number of cells with similar properties together. This variable controls the number of cells batched together. As opposed to the other classes which are templated on the number type, this class as a pure index container is not templated, so we need to keep the information otherwise contained in VectorizedArrayType::size().
Definition at line 427 of file dof_info.h.
std::array<std::vector<IndexStorageVariants>, 3> internal::MatrixFreeFunctions::DoFInfo::index_storage_variants 
Stores the index storage variant of all cell and face batches.
The three arrays given here address the types for the faces decorated as interior (0), the faces decorated with as exterior (1), and the cells (2) according to CellOrFaceAccess.
Definition at line 436 of file dof_info.h.
std::vector<std::pair<unsigned int, unsigned int> > internal::MatrixFreeFunctions::DoFInfo::row_starts 
Stores the rowstart indices of the compressed row storage in the dof_indices
and constraint_indicator
fields. These two fields are always accessed together, so it is simpler to keep just one variable for them. This also obviates keeping two rowstart vectors in sync.
Definition at line 444 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dof_indices 
Stores the indices of the degrees of freedom for each cell. These indices are computed in MPIlocal index space, i.e., each processor stores the locally owned indices as numbers between 0
and n_locally_owned_dofs1
and ghost indices in the range n_locally_owned_dofs
to n_locally_owned_dofs+n_ghost_dofs
. The translation between this MPIlocal index space and the global numbering of degrees of freedom is stored in the vector_partitioner
data structure. This array also includes the indirect contributions from constraints, which are described by the constraint_indicator
field. Because of variable lengths of rows, this would be a vector of a vector. However, we use one contiguous memory region and store the rowstart in the variable row_starts
.
Definition at line 461 of file dof_info.h.
std::vector<std::pair<unsigned short, unsigned short> > internal::MatrixFreeFunctions::DoFInfo::constraint_indicator 
This variable describes the position of constraints in terms of the local numbering of degrees of freedom on a cell. The first number stores the distance from one constrained degree of freedom to the next. This allows to identify the position of constrained DoFs as we loop through the local degrees of freedom of the cell when reading from or writing to a vector. The second number stores the index of the constraint weights, stored in the variable constraint_pool_data.
Definition at line 473 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dof_indices_interleaved 
Reordered index storage for IndexStorageVariants::interleaved
.
Definition at line 478 of file dof_info.h.
std::array<std::vector<unsigned int>, 3> internal::MatrixFreeFunctions::DoFInfo::dof_indices_contiguous 
Compressed index storage for faster access than through dof_indices
used according to the description in IndexStorageVariants.
The three arrays given here address the types for the faces decorated as interior (0), the faces decorated with as exterior (1), and the cells (2) according to CellOrFaceAccess.
Definition at line 488 of file dof_info.h.
std::array<std::vector<unsigned int>, 3> internal::MatrixFreeFunctions::DoFInfo::dof_indices_interleave_strides 
Compressed index storage for faster access than through dof_indices
used according to the description in IndexStorageVariants.
The three arrays given here address the types for the faces decorated as minus (0), the faces decorated with as plus (1), and the cells (2).
Definition at line 498 of file dof_info.h.
std::array<std::vector<unsigned char>, 3> internal::MatrixFreeFunctions::DoFInfo::n_vectorization_lanes_filled 
Caches the number of indices filled when vectorizing. This information can implicitly deduced from the row_starts data fields, but this field allows for faster access.
The three arrays given here address the types for the faces decorated as interior (0), the faces decorated with as exterior (1), and the cells (2) according to CellOrFaceAccess.
Definition at line 509 of file dof_info.h.
std::shared_ptr<const Utilities::MPI::Partitioner> internal::MatrixFreeFunctions::DoFInfo::vector_partitioner 
This stores the parallel partitioning that can be used to set up vectors. The partitioner includes the description of the local range in the vector, and also includes how the ghosts look like. This enables initialization of vectors based on the DoFInfo field.
Definition at line 517 of file dof_info.h.
std::array<std::shared_ptr<const Utilities::MPI::Partitioner>, 5> internal::MatrixFreeFunctions::DoFInfo::vector_partitioner_face_variants 
This partitioning selects a subset of ghost indices to the full vector partitioner stored in vector_partitioner
. These partitioners are used in specialized loops that only import parts of the ghosted region for reducing the amount of communication. There are five variants of the partitioner initialized:
Definition at line 538 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::constrained_dofs 
This stores a (sorted) list of all locally owned degrees of freedom that are constrained.
Definition at line 544 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::row_starts_plain_indices 
Stores the rowstart indices of the compressed row storage in the plain_dof_indices
fields.
Definition at line 550 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::plain_dof_indices 
Stores the indices of the degrees of freedom for each cell. This array does not include the indirect contributions from constraints, which are included in dof_indices
. Because of variable lengths of rows, this would be a vector of a vector. However, we use one contiguous memory region and store the rowstart in the variable row_starts_plain_indices
.
Definition at line 560 of file dof_info.h.
unsigned int internal::MatrixFreeFunctions::DoFInfo::global_base_element_offset 
Stores the offset in terms of the number of base elements over all DoFInfo objects.
Definition at line 566 of file dof_info.h.
unsigned int internal::MatrixFreeFunctions::DoFInfo::n_base_elements 
Stores the number of base elements in the DoFHandler where the indices have been read from.
Definition at line 572 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::n_components 
Stores the number of components of each base element in the finite element where the indices have been read from.
Definition at line 578 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::start_components 
The ith entry of this vector stores the component number of the given base element.
Definition at line 584 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::component_to_base_index 
For a given component in an FESystem, this variable tells which base element the index belongs to.
Definition at line 590 of file dof_info.h.
std::vector<std::vector<unsigned int> > internal::MatrixFreeFunctions::DoFInfo::component_dof_indices_offset 
For a vectorvalued element, this gives the constant offset in the number of degrees of freedom starting at the given component, as the degrees are numbered by degrees of freedom. This data structure does not take possible constraints and thus, shorter or longer lists, into account. This information is encoded in the row_starts variables directly.
The outer vector goes through the various fe indices in the hp case, similarly to the dofs_per_cell
variable.
Definition at line 603 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dofs_per_cell 
Stores the number of degrees of freedom per cell.
Definition at line 608 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dofs_per_face 
Stores the number of degrees of freedom per face.
Definition at line 613 of file dof_info.h.
bool internal::MatrixFreeFunctions::DoFInfo::store_plain_indices 
Informs on whether plain indices are cached.
Definition at line 618 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::cell_active_fe_index 
Stores the index of the active finite element in the hp case.
Definition at line 623 of file dof_info.h.
unsigned int internal::MatrixFreeFunctions::DoFInfo::max_fe_index 
Stores the maximum degree of different finite elements for the hp case.
Definition at line 629 of file dof_info.h.
std::vector<std::vector<unsigned int> > internal::MatrixFreeFunctions::DoFInfo::fe_index_conversion 
To each of the slots in an hp adaptive case, the inner vector stores the corresponding element degree. This is used by the constructor of FEEvaluationBase to identify the correct data slot in the hp case.
Definition at line 636 of file dof_info.h.
std::vector<types::global_dof_index> internal::MatrixFreeFunctions::DoFInfo::ghost_dofs 
Temporarily stores the numbers of ghosts during setup. Cleared when calling assign_ghosts
. Then, all information is collected by the partitioner.
Definition at line 643 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::vector_zero_range_list_index 
Stores an integer to each partition in TaskInfo that indicates whether to clear certain parts in the result vector if the user requested it with the respective argument in the MatrixFree::loop.
Definition at line 650 of file dof_info.h.
std::vector<std::pair<unsigned int, unsigned int> > internal::MatrixFreeFunctions::DoFInfo::vector_zero_range_list 
Stores the actual ranges in the vector to be cleared.
Definition at line 655 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::cell_loop_pre_list_index 
Stores an integer to each partition in TaskInfo that indicates when to schedule operations that will be done before any access to vector entries.
Definition at line 662 of file dof_info.h.
std::vector<std::pair<unsigned int, unsigned int> > internal::MatrixFreeFunctions::DoFInfo::cell_loop_pre_list 
Stores the actual ranges of the operation before any access to vector entries.
Definition at line 668 of file dof_info.h.
std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::cell_loop_post_list_index 
Stores an integer to each partition in TaskInfo that indicates when to schedule operations that will be done after all access to vector entries.
Definition at line 675 of file dof_info.h.
std::vector<std::pair<unsigned int, unsigned int> > internal::MatrixFreeFunctions::DoFInfo::cell_loop_post_list 
Stores the actual ranges of the operation after all access to vector entries.
Definition at line 681 of file dof_info.h.