From c508e5d7228903db2aab4a134296a9c7a7d17552 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 24 Jul 2023 14:55:06 -0600 Subject: [PATCH] Minor addition to the documentation of a GridTools function. --- include/deal.II/grid/grid_tools.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 550b12b667..c437c55aba 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -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 -- 2.39.5