Loading [MathJax]/extensions/TeX/newcommand.js
 deal.II version GIT relicensing-2684-gc61376a70f 2025-02-22 15:30: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\}}
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
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 const ReferenceCell Vertex
 
constexpr const ReferenceCell Line
 
constexpr const ReferenceCell Triangle
 
constexpr const ReferenceCell Quadrilateral
 
constexpr const ReferenceCell Tetrahedron
 
constexpr const ReferenceCell Pyramid
 
constexpr const ReferenceCell Wedge
 
constexpr const ReferenceCell Hexahedron
 
constexpr const 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 2757 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 2779 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 2801 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 2810 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 2819 of file reference_cell.h.

Variable Documentation

◆ Vertex

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

Definition at line 1219 of file reference_cell.h.

◆ Line

constexpr const ReferenceCell ReferenceCells::Line
constexprprivate
Initial value:

Definition at line 1221 of file reference_cell.h.

◆ Triangle

constexpr const ReferenceCell ReferenceCells::Triangle
constexprprivate
Initial value:

Definition at line 1223 of file reference_cell.h.

◆ Quadrilateral

constexpr const ReferenceCell ReferenceCells::Quadrilateral
constexprprivate
Initial value:

Definition at line 1225 of file reference_cell.h.

◆ Tetrahedron

constexpr const ReferenceCell ReferenceCells::Tetrahedron
constexprprivate
Initial value:

Definition at line 1227 of file reference_cell.h.

◆ Pyramid

constexpr const ReferenceCell ReferenceCells::Pyramid
constexprprivate
Initial value:

Definition at line 1229 of file reference_cell.h.

◆ Wedge

constexpr const ReferenceCell ReferenceCells::Wedge
constexprprivate
Initial value:

Definition at line 1231 of file reference_cell.h.

◆ Hexahedron

constexpr const ReferenceCell ReferenceCells::Hexahedron
constexprprivate
Initial value:

Definition at line 1233 of file reference_cell.h.

◆ Invalid

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

Definition at line 1235 of file reference_cell.h.