deal.II version GIT relicensing-3321-g4b434670a0 2025-05-16 17:40:00+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
Functions | Variables
ReferenceCells Namespace Reference

Functions

template<int dim>
constexpr const ReferenceCellget_simplex ()
 
template<int dim>
constexpr const ReferenceCellget_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>
constexpr const ReferenceCell & ReferenceCells::get_simplex ( )
inlineconstexprprivate

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 2770 of file reference_cell.h.

◆ get_hypercube()

template<int dim>
constexpr const ReferenceCell & ReferenceCells::get_hypercube ( )
inlineconstexprprivate

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 2792 of file reference_cell.h.

◆ max_n_vertices()

template<int structdim>
constexpr unsigned int ReferenceCells::max_n_vertices ( )
inlineconstexprprivate

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 2814 of file reference_cell.h.

◆ max_n_lines()

template<int structdim>
constexpr unsigned int ReferenceCells::max_n_lines ( )
inlineconstexprprivate

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 2823 of file reference_cell.h.

◆ max_n_faces()

template<int structdim>
constexpr unsigned int ReferenceCells::max_n_faces ( )
inlineconstexprprivate

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;

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

Definition at line 2832 of file reference_cell.h.

Variable Documentation

◆ Vertex

constexpr ReferenceCell ReferenceCells::Vertex = internal::make_reference_cell_from_int(0)
constexprprivate

Definition at line 1244 of file reference_cell.h.

◆ Line

constexpr ReferenceCell ReferenceCells::Line = internal::make_reference_cell_from_int(1)
constexprprivate

Definition at line 1245 of file reference_cell.h.

◆ Triangle

constexpr ReferenceCell ReferenceCells::Triangle = internal::make_reference_cell_from_int(2)
constexprprivate

Definition at line 1246 of file reference_cell.h.

◆ Quadrilateral

constexpr ReferenceCell ReferenceCells::Quadrilateral
constexprprivate
Initial value:
=
constexpr ReferenceCell make_reference_cell_from_int(const std::uint8_t kind)

Definition at line 1247 of file reference_cell.h.

◆ Tetrahedron

constexpr ReferenceCell ReferenceCells::Tetrahedron
constexprprivate
Initial value:

Definition at line 1249 of file reference_cell.h.

◆ Pyramid

constexpr ReferenceCell ReferenceCells::Pyramid = internal::make_reference_cell_from_int(5)
constexprprivate

Definition at line 1251 of file reference_cell.h.

◆ Wedge

constexpr ReferenceCell ReferenceCells::Wedge = internal::make_reference_cell_from_int(6)
constexprprivate

Definition at line 1252 of file reference_cell.h.

◆ Hexahedron

constexpr ReferenceCell ReferenceCells::Hexahedron
constexprprivate
Initial value:

Definition at line 1253 of file reference_cell.h.

◆ Invalid

constexpr ReferenceCell ReferenceCells::Invalid
constexprprivate
Initial value:
std::numeric_limits<std::uint8_t>::max())

Definition at line 1255 of file reference_cell.h.