GridTools::PeriodicFacePair< CellIterator > Struct Template Reference

#include <deal.II/grid/grid_tools.h>

Inheritance diagram for GridTools::PeriodicFacePair< CellIterator >:

Public Member Functions
std::size_t	memory_consumption () const

Public Attributes
CellIterator	cell [2]
unsigned int	face_idx [2]
unsigned char	orientation
FullMatrix< double >	matrix

Detailed Description

template<typename CellIterator>
struct GridTools::PeriodicFacePair< CellIterator >

Data type that provides all information necessary to create periodicity constraints and a periodic p4est forest with respect to two 'periodic' cell faces.

Definition at line 2332 of file grid_tools.h.

Member Function Documentation

memory_consumption()

template<typename CellIterator >

std::size_t GridTools::PeriodicFacePair< CellIterator >::memory_consumption

(

)

const

Return an estimate, in bytes, for the memory consumption of the object.

Member Data Documentation

cell

template<typename CellIterator >

CellIterator GridTools::PeriodicFacePair< CellIterator >::cell[2]

The cells associated with the two 'periodic' faces.

Definition at line 2337 of file grid_tools.h.

face_idx

template<typename CellIterator >

unsigned int GridTools::PeriodicFacePair< CellIterator >::face_idx[2]

The local face indices (with respect to the specified cells) of the two 'periodic' faces.

Definition at line 2343 of file grid_tools.h.

orientation

template<typename CellIterator >

unsigned char GridTools::PeriodicFacePair< CellIterator >::orientation

The relative orientation of the first face with respect to the second face as described in orthogonal_equality() and DoFTools::make_periodicity_constraints().

Definition at line 2350 of file grid_tools.h.

matrix

template<typename CellIterator >

FullMatrix<double> GridTools::PeriodicFacePair< CellIterator >::matrix

A dim \(\times\) dim rotation matrix that describes how vector valued DoFs of the first face should be modified prior to constraining to the DoFs of the second face.

The rotation matrix is used in DoFTools::make_periodicity_constraints() by applying the rotation to all vector valued blocks listed in the parameter first_vector_components of the finite element space. For more details see DoFTools::make_periodicity_constraints() and the glossary glossary entry on periodic conditions.

Definition at line 2364 of file grid_tools.h.

---

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

• include/deal.II/grid/grid_tools.h