]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Minor addition to the documentation of a GridTools function. 15795/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 24 Jul 2023 20:55:06 +0000 (14:55 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 26 Jul 2023 00:36:56 +0000 (18:36 -0600)
include/deal.II/grid/grid_tools.h

index 550b12b6676f5e278bdc274186e1dcbbb743ae27..c437c55aba8d60d7b697b29bd36045345f14a70e 100644 (file)
@@ -392,11 +392,15 @@ namespace GridTools
 
   /**
    * Return the arrays that define the coarse mesh of a Triangulation. This
-   * function is the inverse of Triangulation::create_triangulation().
+   * function is the inverse of Triangulation::create_triangulation() in the
+   * sense that if one called this function on a triangulation, then that
+   * triangulation could be recreated by some kind of refinement from the
+   * results of this function.
    *
    * The return value is a tuple with the vector of vertices, the vector of
    * cells, and a SubCellData structure. The latter contains additional
-   * information about faces and lines.
+   * information about faces and lines. These three objects are exactly
+   * the arguments to Triangulation::create_triangulation().
    *
    * This function is useful in cases where one needs to deconstruct a
    * Triangulation or manipulate the numbering of the vertices in some way: an

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.