From 218e3bbadda303ccc36676f024effbf61492a89d Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sun, 7 Feb 2021 12:02:22 -0700 Subject: [PATCH] Provide some more documentation. --- include/deal.II/grid/reference_cell.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/include/deal.II/grid/reference_cell.h b/include/deal.II/grid/reference_cell.h index 796ddba00f..e6341c7b92 100644 --- a/include/deal.II/grid/reference_cell.h +++ b/include/deal.II/grid/reference_cell.h @@ -67,6 +67,15 @@ namespace internal * This includes quadrilaterals and hexahedra (i.e., "hypercubes"), * triangles and tetrahedra (simplices), and the pyramids and wedges * necessary when using mixed 3d meshes. + * + * Objects of this type should not be created in user code, and as a + * consequence the class does not have a user-accessible constructor + * other than the default constructor (which creates an invalid object). + * Rather, there is a finite number of specific reference cell objects + * defined in the ReferenceCells namespace that completely enumerate + * all of the possible values. User codes should therefore rely + * exclusively on assigning ReferenceCell objects from these special + * objects, and comparing against those special objects. */ class ReferenceCell { @@ -344,6 +353,13 @@ namespace internal +/** + * 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. + * + * @relates ReferenceCell + */ namespace ReferenceCells { DEAL_II_CONSTEXPR const ReferenceCell Vertex = -- 2.39.5