]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Document reference cells in simplex module page 11095/head
authorPeter Munch <peterrmuench@gmail.com>
Sat, 24 Oct 2020 08:11:28 +0000 (10:11 +0200)
committerPeter Munch <peterrmuench@gmail.com>
Sat, 21 Nov 2020 19:33:12 +0000 (20:33 +0100)
doc/doxygen/headers/simplex.h
doc/doxygen/images/reference_cells_0.png [new file with mode: 0644]
doc/doxygen/images/reference_cells_1.png [new file with mode: 0644]
doc/doxygen/images/reference_cells_2.png [new file with mode: 0644]
doc/doxygen/images/reference_cells_3.png [new file with mode: 0644]
doc/doxygen/images/reference_cells_4.png [new file with mode: 0644]
doc/doxygen/images/reference_cells_5.png [new file with mode: 0644]

index b54c67a405ef788dd5446644cf79b7074558f74c..eb70be846d0a2e9d3bdd83df6db259772c4b5655 100644 (file)
 /**
  * @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 (file)
index 0000000..8ba7d23
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 (file)
index 0000000..db5c43b
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 (file)
index 0000000..d0069a2
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 (file)
index 0000000..fdffb5a
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 (file)
index 0000000..d1fe2c5
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 (file)
index 0000000..3ef8687
Binary files /dev/null and b/doc/doxygen/images/reference_cells_5.png differ

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.