From: Peter Munch <peterrmuench@gmail.com>
Date: Sat, 24 Oct 2020 08:11:28 +0000 (+0200)
Subject: Document reference cells in simplex module page
X-Git-Tag: v9.3.0-rc1~871^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ffc06588ad8b4004f11976034ba9906d957b8f82;p=dealii.git

Document reference cells in simplex module page
---

diff --git a/doc/doxygen/headers/simplex.h b/doc/doxygen/headers/simplex.h
index b54c67a405..eb70be846d 100644
--- a/doc/doxygen/headers/simplex.h
+++ b/doc/doxygen/headers/simplex.h
@@ -17,5 +17,72 @@
 /**
  * @defgroup simplex Simplex support (experimental)
  *
- * This module describes the experimental simplex support in deal.II.
+ * @brief This module describes the experimental simplex support in deal.II.
+ *
+ * @section simplex_reference_cells Reference cells
+ *
+ * In 2D, we provide triangles and quadrilaterals with the following possible
+ * orientations in 3D:
+ *
+ * <div class="twocolumn" style="width: 100%">
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_0.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       2D: triangle and quadrilateral
+ *     </div>
+ *   </div>
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_1.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       Possible orientations of triangles and quadrilaterals in 3D
+ *     </div>
+ *   </div>
+ * </div>
+ *
+ * In 3D, tetrahedrons, pyramids, wedges, and hexahedrons are available:
+ *
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_2.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       3D: Tetrahedron
+ *     </div>
+ *   </div>
+ *
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_3.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       3D: Pyramid
+ *     </div>
+ *   </div>
+ *
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_4.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       3D: Wedge
+ *     </div>
+ *   </div>
+ *
+ *   <div class="parent">
+ *     <div class="img" align="center">
+ *       @image html reference_cells_5.png
+ *     </div>
+ *     <div class="text" align="center">
+ *       3D: Hexahedron
+ *     </div>
+ *   </div>
+ *
+ * Each surface of a 3D reference cell consists of 2D reference cells. The
+ * documentation of the enumeration of the numbering of their vertices and
+ * lines are given in the right columns.
+ *
  */
diff --git a/doc/doxygen/images/reference_cells_0.png b/doc/doxygen/images/reference_cells_0.png
new file mode 100644
index 0000000000..8ba7d23de4
Binary files /dev/null and b/doc/doxygen/images/reference_cells_0.png differ
diff --git a/doc/doxygen/images/reference_cells_1.png b/doc/doxygen/images/reference_cells_1.png
new file mode 100644
index 0000000000..db5c43bba2
Binary files /dev/null and b/doc/doxygen/images/reference_cells_1.png differ
diff --git a/doc/doxygen/images/reference_cells_2.png b/doc/doxygen/images/reference_cells_2.png
new file mode 100644
index 0000000000..d0069a2831
Binary files /dev/null and b/doc/doxygen/images/reference_cells_2.png differ
diff --git a/doc/doxygen/images/reference_cells_3.png b/doc/doxygen/images/reference_cells_3.png
new file mode 100644
index 0000000000..fdffb5a179
Binary files /dev/null and b/doc/doxygen/images/reference_cells_3.png differ
diff --git a/doc/doxygen/images/reference_cells_4.png b/doc/doxygen/images/reference_cells_4.png
new file mode 100644
index 0000000000..d1fe2c5183
Binary files /dev/null and b/doc/doxygen/images/reference_cells_4.png differ
diff --git a/doc/doxygen/images/reference_cells_5.png b/doc/doxygen/images/reference_cells_5.png
new file mode 100644
index 0000000000..3ef8687156
Binary files /dev/null and b/doc/doxygen/images/reference_cells_5.png differ