Functions
template<int dim>
constexpr const ReferenceCell &	get_simplex ()
template<int dim>
constexpr const ReferenceCell &	get_hypercube ()
template<int structdim>
constexpr unsigned int	max_n_vertices ()
template<int structdim>
constexpr unsigned int	max_n_lines ()
template<int structdim>
constexpr unsigned int	max_n_faces ()

Variables
constexpr ReferenceCell	Vertex = internal::make_reference_cell_from_int(0)
constexpr ReferenceCell	Line = internal::make_reference_cell_from_int(1)
constexpr ReferenceCell	Triangle = internal::make_reference_cell_from_int(2)
constexpr ReferenceCell	Quadrilateral
constexpr ReferenceCell	Tetrahedron
constexpr ReferenceCell	Pyramid = internal::make_reference_cell_from_int(5)
constexpr ReferenceCell	Wedge = internal::make_reference_cell_from_int(6)
constexpr ReferenceCell	Hexahedron
constexpr ReferenceCell	Invalid

Detailed Description

A namespace in which we define objects that correspond to specific reference cells. The objects defined here are a complete enumeration of all possible reference cells that can be used in deal.II.

Function Documentation

◆ get_simplex()

template<int dim>

const ReferenceCell & ReferenceCells::get_simplex ( )

inlineconstexpr

Return the correct simplex reference cell type for the given dimension dim. Depending on the template argument dim, this function returns a reference to either Vertex, Line, Triangle, or Tetrahedron.

Definition at line 2782 of file reference_cell.h.

◆ get_hypercube()

template<int dim>

const ReferenceCell & ReferenceCells::get_hypercube ( )

inlineconstexpr

Return the correct hypercube reference cell type for the given dimension dim. Depending on the template argument dim, this function returns a reference to either Vertex, Quadrilateral, or Hexahedron.

Definition at line 2804 of file reference_cell.h.

◆ max_n_vertices()

template<int structdim>

unsigned int ReferenceCells::max_n_vertices ( )

inlineconstexpr

Return the maximum number of vertices an object of dimension structdim can have. This is always the number of vertices of a structdim-dimensional hypercube.

See also: ReferenceCells::max_n_faces()

Definition at line 2826 of file reference_cell.h.

◆ max_n_lines()

template<int structdim>

unsigned int ReferenceCells::max_n_lines ( )

inlineconstexpr

Return the maximum number of lines an object of dimension structdim can have. This is always the number of lines of a structdim-dimensional hypercube.

See also: ReferenceCells::max_n_faces()

Definition at line 2835 of file reference_cell.h.

◆ max_n_faces()

template<int structdim>

unsigned int ReferenceCells::max_n_faces ( )

inlineconstexpr

Return the maximum number of faces an object of dimension structdim can have. This is always the number of faces of a structdim-dimensional hypercube.

Note: The primary use case of this and the other maxima functions is to enable simple array indexing to per-face data by cell index and face number, e.g.,

cell->index() * ReferenceCells::max_n_faces<dim>() + face_no;

ReferenceCells::max_n_faces

constexpr unsigned int max_n_faces()

Definition reference_cell.h:2844

is a unique index to the face_noth face of the current cell.

Definition at line 2844 of file reference_cell.h.