]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Provide a link to the geometry paper. 8950/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 23 Oct 2019 13:41:42 +0000 (07:41 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 23 Oct 2019 13:41:42 +0000 (07:41 -0600)
doc/doxygen/headers/glossary.h
doc/doxygen/headers/manifold.h
include/deal.II/grid/manifold.h

index 2fcb74a894279626ae5f28156d483724eddcd888..49ebf4cd131b990b0558f008a784f35856c902fc 100644 (file)
  * </dd>
  *
  *
+ * <dt class="glossary">@anchor geometry_paper <b>geometry paper</b></dt>
+ * <dd>The "geometry paper" is a paper by L. Heltai, W. Bangerth, M. Kronbichler,
+ * and A. Mola, titled
+ * "Using exact geometry information in finite element computations", that
+ * describes how deal.II describes the geometry of domains. In particular,
+ * it discusses the algorithmic foundations on which the Manifold class
+ * is based, and what kind of information it needs to provide for mesh
+ * refinement, the computation of normal vectors, and the many other places
+ * where geometry enters into finite element computations.
+ *
+ * The paper is currently available on arXiv at https://arxiv.org/abs/1910.09824 .
+ * The full reference for this paper is as follows:
+ * @code{.bib}
+@misc{heltai2019using,
+    title={Using exact geometry information in finite element computations},
+    author={Luca Heltai and Wolfgang Bangerth and Martin Kronbichler and Andrea Mola},
+    year={2019},
+    eprint={1910.09824},
+    archivePrefix={arXiv},
+    primaryClass={math.NA}
+}
+ * @endcode
+ * </dd>
+ *
+ *
  * <dt class="glossary">@anchor GlossGhostCell <b>Ghost cells</b></dt>
  * <dd>
  * If a mesh is distributed across multiple MPI processes using the
  * used.
  * </dd>
  *
+ *
  * <dt class="glossary">@anchor hp_paper <b>%hp paper</b></dt>
  * <dd>The "hp paper" is a paper by W. Bangerth and O. Kayser-Herold, titled
  * "Data Structures and Requirements for hp Finite Element Software", that
index e7912b49d65716f1aadbd995f3a06463017e0972..16cf268e28290bd9287ad8d35a2f7ce77e828a2f 100644 (file)
@@ -74,6 +74,9 @@
  *   using high order mappings.
  *
  * </ul>
+ * Many other examples, as well as much theoretical underpinning for the
+ * implementation in deal.II, is provided in the
+ * @ref GlossGeometryPaper "geometry paper".
  *
  * In deal.II, a Manifold is seen as a collection of points, together
  * with a notion of distance between points (on the manifold). New
index fa83781cd6891360989631afc3d2faea2c5d7937..34a1fd3dd8fc166751a2d22d99a9c15dda3784b7 100644 (file)
@@ -163,6 +163,8 @@ namespace Manifolds
                                  const bool with_interpolation = false);
 } // namespace Manifolds
 
+
+
 /**
  * Manifolds are used to describe the geometry of boundaries of domains as
  * well as the geometry of the interior. Manifold objects are therefore
@@ -172,7 +174,9 @@ namespace Manifolds
  *
  * Manifolds are best understood by using the language of differential
  * geometry, but their common uses can be easily described simply through
- * examples.
+ * examples. An exhaustive discussion of how, where, and why this class
+ * is used is provided in the
+ * @ref GlossGeometryPaper "geometry paper".
  *
  *
  * <h3>Common use case: Creating a new vertex</h3>

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.