From: Timo Heister <timo.heister@gmail.com>
Date: Sat, 21 Sep 2019 20:11:32 +0000 (-0400)
Subject: add to documentation of get_coarse_mesh_description()
X-Git-Tag: v9.2.0-rc1~1056^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4e12140a10289944b919c9143a1a417ae3e25d61;p=dealii.git

add to documentation of get_coarse_mesh_description()
---

diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h
index 9a6e085ddd..321ea99a63 100644
--- a/include/deal.II/grid/grid_tools.h
+++ b/include/deal.II/grid/grid_tools.h
@@ -276,6 +276,10 @@ namespace GridTools
    * Return the arrays that define the coarse mesh of a Triangulation. This
    * function is the inverse of Triangulation::create_triangulation().
    *
+   * 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.
+   *
    * This function is useful in cases where one needs to deconstruct a
    * Triangulation or manipulate the numbering of the vertices in some way: an
    * example is GridGenerator::merge_triangulations().