#include <deal.II/matrix_free/dof_info.h>

Public Types
enum class	IndexStorageVariants : unsigned char { full , interleaved , contiguous , interleaved_contiguous , interleaved_contiguous_strided , 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

	DoFInfo (DoFInfo &&) noexcept=default

	~DoFInfo ()=default

DoFInfo &	operator= (const DoFInfo &)=default

DoFInfo &	operator= (DoFInfo &&) noexcept=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 > &local_indices, const unsigned int cell_batch, const bool with_constraints=true) const

template<typename number >
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)

template<int dim>
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)

void	assign_ghosts (const std::vector< unsigned int > &boundary_cells, const MPI_Comm &communicator_sm, const bool use_vector_data_exchanger_full)

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, const MPI_Comm &communicator_sm, const bool use_vector_data_exchanger_full)

void	compute_shared_memory_contiguous_indices (std::array< std::vector< std::pair< unsigned int, unsigned int > >, 3 > &cell_indices_contiguous_sm)

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::vector< bool > >	hanging_node_constraint_masks_comp

std::vector< compressed_constraint_kind >	hanging_node_constraint_masks

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< std::pair< unsigned int, unsigned int > >, 3 >	dof_indices_contiguous_sm

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::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base >	vector_exchanger

std::array< std::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base >, 5 >	vector_exchanger_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

Detailed Description

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 vector-valued 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 128 of file dof_info.h.

Member Enumeration Documentation

◆ IndexStorageVariants

enum class internal::MatrixFreeFunctions::DoFInfo::IndexStorageVariants : unsigned char

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 `dof_indices` with the index `row_starts[cell_indexn_vectorizationn_components].first`.
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 `dof_indices_interleaved` with the index `row_starts[cell_indexn_vectorizationn_components].first`.
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 `dof_indices_contiguous` with the index `cell_indexn_vectorizationn_components`.
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 `interleaved_contiguous_strided` and `interleaved_contiguous_mixed_strides` are a consequence of this storage type. The former is for faces where at least one of the two adjacent sides will break with the interleaved storage. We then have to make a strided access as described in the next category. The last category `interleaved_contiguous_mixed_strides` appears in the ghost layer, see the more detailed description of that category below. Again, this is something that cannot be avoided in general once we interleave the indices between cells. For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array `dof_indices_contiguous` with the index `cell_indexn_vectorizationn_components`.
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` storage but the faces' numbering is not the same as the cell's numbering. For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array `dof_indices_contiguous` with the index `cell_indexn_vectorizationn_components`.
interleaved_contiguous_mixed_strides	Similar to interleaved_contiguous_separate storage, but for the case when the interleaved indices are not `n_vectorization apart`. This happens typically within the ghost layer of DG where the remote owner has applied an interleaved storage and the current processor only sees some of the cells. For a cell/face of this index type, the data access in FEEvaluationBase is directed to the array `dof_indices_contiguous` with the index `cell_indexn_vectorizationn_components`, including the array `dof_indices_interleave_strides` for the information about the actual stride.

Definition at line 390 of file dof_info.h.

◆ DoFAccessIndex

enum internal::MatrixFreeFunctions::DoFInfo::DoFAccessIndex : unsigned char

Enum used to distinguish the data arrays for the vectorization type in cells and faces.

Enumerator
dof_access_face_interior	The data index for the faces designated as interior
dof_access_face_exterior	The data index for the faces designated as exterior
dof_access_cell	The data index for the cells

Definition at line 477 of file dof_info.h.

Constructor & Destructor Documentation

◆ DoFInfo() [1/3]

internal::MatrixFreeFunctions::DoFInfo::DoFInfo ( )

Default empty constructor.

Definition at line 38 of file dof_info.cc.

◆ DoFInfo() [2/3]

internal::MatrixFreeFunctions::DoFInfo::DoFInfo ( const DoFInfo & )

default

Copy constructor.

◆ DoFInfo() [3/3]

internal::MatrixFreeFunctions::DoFInfo::DoFInfo ( DoFInfo && )

defaultnoexcept

Move constructor.

◆ ~DoFInfo()

internal::MatrixFreeFunctions::DoFInfo::~DoFInfo ( )

default

Destructor.

Member Function Documentation

◆ operator=() [1/2]

DoFInfo & internal::MatrixFreeFunctions::DoFInfo::operator= ( const DoFInfo & )

default

Copy assignment operator.

◆ operator=() [2/2]

DoFInfo & internal::MatrixFreeFunctions::DoFInfo::operator= ( DoFInfo && )

defaultnoexcept

Move assignment operator.

◆ clear()

void internal::MatrixFreeFunctions::DoFInfo::clear ( )

Clear all data fields in this class.

Definition at line 46 of file dof_info.cc.

◆ fe_index_from_degree()

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.

◆ get_dof_indices_on_cell_batch()

void internal::MatrixFreeFunctions::DoFInfo::get_dof_indices_on_cell_batch	(	std::vector< unsigned int > &	local_indices,
		const unsigned int	cell_batch,
		const bool	with_constraints = `true`
	)		const

Populate the vector local_indices with locally owned degrees of freedom stored on the cell batch cell_batch. 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.

Note: The returned indices may contain duplicates. The unique set can be obtain using std::sort() followed by std::unique() and std::vector::erase().

Definition at line 80 of file dof_info.cc.

◆ read_dof_indices()

template<typename number >

template void internal::MatrixFreeFunctions::DoFInfo::read_dof_indices< float >	(	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
	)

This internal method takes the local indices on a cell (two versions: hanging-node constraints resolved if possible and plain, i.e., not resolved) 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.

◆ process_hanging_node_constraints()

template<int dim>

template bool internal::MatrixFreeFunctions::DoFInfo::process_hanging_node_constraints< 3 >	(	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
	)

For a given cell, determine if it has hanging node constraints. If yes, adjust the dof indices, store the mask, and return true as indication.

◆ assign_ghosts()

void internal::MatrixFreeFunctions::DoFInfo::assign_ghosts	(	const std::vector< unsigned int > &	boundary_cells,
		const MPI_Comm &	communicator_sm,
		const bool	use_vector_data_exchanger_full
	)

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.

Definition at line 153 of file dof_info.cc.

◆ reorder_cells()

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.

Definition at line 296 of file dof_info.cc.

◆ compute_cell_index_compression()

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.

Definition at line 528 of file dof_info.cc.

◆ compute_face_index_compression()

template<int length>

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.

◆ make_connectivity_graph()

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.

Definition at line 1359 of file dof_info.cc.

◆ compute_tight_partitioners()

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,
		const MPI_Comm &	communicator_sm,
		const bool	use_vector_data_exchanger_full
	)

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.

Definition at line 860 of file dof_info.cc.

◆ compute_shared_memory_contiguous_indices()

void internal::MatrixFreeFunctions::DoFInfo::compute_shared_memory_contiguous_indices ( std::array< std::vector< std::pair< unsigned int, unsigned int > >, 3 > & cell_indices_contiguous_sm )

Given cell_indices_contiguous_sm containing the local index of cells of macro faces (inner/outer) and macro faces compute dof_indices_contiguous_sm.

Definition at line 1210 of file dof_info.cc.

◆ compute_dof_renumbering()

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.

Definition at line 1436 of file dof_info.cc.

◆ compute_vector_zero_access_pattern()

template<int length>

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.

◆ memory_consumption()

std::size_t internal::MatrixFreeFunctions::DoFInfo::memory_consumption ( ) const

Return the memory consumption in bytes of this class.

Definition at line 1494 of file dof_info.cc.

◆ print_memory_consumption()

template<typename StreamType >

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.

◆ print()

template<typename Number >

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.

Member Data Documentation

◆ chunk_size_zero_vector

const unsigned int internal::MatrixFreeFunctions::DoFInfo::chunk_size_zero_vector = 64

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 142 of file dof_info.h.

◆ dimension

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 498 of file dof_info.h.

◆ vectorization_length

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 508 of file dof_info.h.

◆ index_storage_variants

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 517 of file dof_info.h.

◆ row_starts

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 525 of file dof_info.h.

◆ dof_indices

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 MPI-local index space, i.e., each processor stores the locally owned indices as numbers between 0 and n_locally_owned_dofs-1 and ghost indices in the range n_locally_owned_dofs to n_locally_owned_dofs+n_ghost_dofs. The translation between this MPI-local 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 542 of file dof_info.h.

◆ hanging_node_constraint_masks_comp

std::vector<std::vector<bool> > internal::MatrixFreeFunctions::DoFInfo::hanging_node_constraint_masks_comp

Supported components of all entries of the hp::FECollection object of the given DoFHandler.

Definition at line 548 of file dof_info.h.

◆ hanging_node_constraint_masks

std::vector<compressed_constraint_kind> internal::MatrixFreeFunctions::DoFInfo::hanging_node_constraint_masks

Masks indicating for each cell and component if the optimized hanging-node constraint is applicable and if yes which type.

Definition at line 554 of file dof_info.h.

◆ constraint_indicator

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 566 of file dof_info.h.

◆ dof_indices_interleaved

std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dof_indices_interleaved

Reordered index storage for IndexStorageVariants::interleaved.

Definition at line 571 of file dof_info.h.

◆ dof_indices_contiguous

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 581 of file dof_info.h.

◆ dof_indices_contiguous_sm

std::array<std::vector<std::pair<unsigned int, unsigned int> >, 3> internal::MatrixFreeFunctions::DoFInfo::dof_indices_contiguous_sm

The same as above but for shared-memory usage. The first value of the pair is identifying the owning process and the second the index within that locally-owned data of that process.

Note: This data structure is only set up if all entries in index_storage_variants[2] are IndexStorageVariants::contiguous.

Definition at line 592 of file dof_info.h.

◆ dof_indices_interleave_strides

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 602 of file dof_info.h.

◆ n_vectorization_lanes_filled

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 613 of file dof_info.h.

◆ vector_partitioner

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 621 of file dof_info.h.

◆ vector_exchanger

std::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base> internal::MatrixFreeFunctions::DoFInfo::vector_exchanger

Vector exchanger compatible with vector_partitioner.

Definition at line 628 of file dof_info.h.

◆ vector_exchanger_face_variants

std::array< std::shared_ptr< const internal::MatrixFreeFunctions::VectorDataExchange::Base>, 5> internal::MatrixFreeFunctions::DoFInfo::vector_exchanger_face_variants

Vector exchanger compatible with partitioners that select 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:

one that queries only the cell values,
one that additionally describes the indices for evaluating the function values on relevant faces,
one that describes the indices for evaluation both the function values and the gradients on relevant faces adjacent to the locally owned cells,
one that additionally describes the indices for evaluating the function values on all faces, and
one that describes the indices for evaluation both the function values and the gradients on all faces adjacent to the locally owned cells.

Definition at line 653 of file dof_info.h.

◆ constrained_dofs

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 659 of file dof_info.h.

◆ row_starts_plain_indices

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 665 of file dof_info.h.

◆ plain_dof_indices

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 675 of file dof_info.h.

◆ global_base_element_offset

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 681 of file dof_info.h.

◆ n_base_elements

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 687 of file dof_info.h.

◆ n_components

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 693 of file dof_info.h.

◆ start_components

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 699 of file dof_info.h.

◆ component_to_base_index

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 705 of file dof_info.h.

◆ component_dof_indices_offset

std::vector<std::vector<unsigned int> > internal::MatrixFreeFunctions::DoFInfo::component_dof_indices_offset

For a vector-valued 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 718 of file dof_info.h.

◆ dofs_per_cell

std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dofs_per_cell

Stores the number of degrees of freedom per cell.

Definition at line 723 of file dof_info.h.

◆ dofs_per_face

std::vector<unsigned int> internal::MatrixFreeFunctions::DoFInfo::dofs_per_face

Stores the number of degrees of freedom per face.

Definition at line 728 of file dof_info.h.

◆ store_plain_indices

bool internal::MatrixFreeFunctions::DoFInfo::store_plain_indices

Informs on whether plain indices are cached.

Definition at line 733 of file dof_info.h.

◆ cell_active_fe_index

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 738 of file dof_info.h.

◆ max_fe_index

unsigned int internal::MatrixFreeFunctions::DoFInfo::max_fe_index

Stores the maximum degree of different finite elements for the hp- case.

Definition at line 744 of file dof_info.h.

◆ fe_index_conversion

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 751 of file dof_info.h.

◆ ghost_dofs

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 758 of file dof_info.h.

◆ vector_zero_range_list_index

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 765 of file dof_info.h.

◆ vector_zero_range_list

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 770 of file dof_info.h.

◆ cell_loop_pre_list_index

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 777 of file dof_info.h.

◆ cell_loop_pre_list

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 783 of file dof_info.h.

◆ cell_loop_post_list_index

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 790 of file dof_info.h.

◆ cell_loop_post_list

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 796 of file dof_info.h.

The documentation for this struct was generated from the following files:

include/deal.II/matrix_free/dof_info.h
source/matrix_free/dof_info.cc

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ IndexStorageVariants

◆ DoFAccessIndex

Constructor & Destructor Documentation

◆ DoFInfo() [1/3]

◆ DoFInfo() [2/3]

◆ DoFInfo() [3/3]

◆ ~DoFInfo()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ clear()

◆ fe_index_from_degree()

◆ get_dof_indices_on_cell_batch()

◆ read_dof_indices()

◆ process_hanging_node_constraints()

◆ assign_ghosts()

◆ reorder_cells()

◆ compute_cell_index_compression()

◆ compute_face_index_compression()

◆ make_connectivity_graph()

◆ compute_tight_partitioners()

◆ compute_shared_memory_contiguous_indices()

◆ compute_dof_renumbering()

◆ compute_vector_zero_access_pattern()

◆ memory_consumption()

◆ print_memory_consumption()

◆ print()

Member Data Documentation

◆ chunk_size_zero_vector

◆ dimension

◆ vectorization_length

◆ index_storage_variants

◆ row_starts

◆ dof_indices

◆ hanging_node_constraint_masks_comp

◆ hanging_node_constraint_masks

◆ constraint_indicator

◆ dof_indices_interleaved

◆ dof_indices_contiguous

◆ dof_indices_contiguous_sm

◆ dof_indices_interleave_strides

◆ n_vectorization_lanes_filled

◆ vector_partitioner

◆ vector_exchanger

◆ vector_exchanger_face_variants

◆ constrained_dofs

◆ row_starts_plain_indices

◆ plain_dof_indices

◆ global_base_element_offset

◆ n_base_elements

◆ n_components

◆ start_components

◆ component_to_base_index

◆ component_dof_indices_offset

◆ dofs_per_cell

◆ dofs_per_face

◆ store_plain_indices

◆ cell_active_fe_index

◆ max_fe_index

◆ fe_index_conversion

◆ ghost_dofs

◆ vector_zero_range_list_index

◆ vector_zero_range_list

◆ cell_loop_pre_list_index

◆ cell_loop_pre_list

◆ cell_loop_post_list_index

◆ cell_loop_post_list