From: David Wells Date: Tue, 29 Mar 2022 22:11:58 +0000 (-0400) Subject: Update the documentation of GridTools::cell_measure(). X-Git-Tag: v9.4.0-rc1~339^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F13582%2Fhead;p=dealii.git Update the documentation of GridTools::cell_measure(). We support non-hypercube cells in this function now. --- diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index e86eafa828..c2973faacb 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -240,10 +240,13 @@ namespace GridTools * function also works for cells that do not exist except that you make it * up by naming its vertices from the list. * - * The parameter @p vertex_indices is expected to have - * GeometryInfo::vertices_per_cell entries. A std::vector is implicitly - * convertible to an ArrayView, so it can be passed directly. See the - * ArrayView class for more information. + * The size of @p vertex_indices, combined with `dim`, implicitly encodes + * the ReferenceCell type of the provided cell. For example, if `dim == 2` and + * `vertex_indices.size() == 3` then the cell is a triangle, but if + * `dim == 2` and `vertex_indices.size() == 4` then the cell is a + * quadrilateral. A std::vector is implicitly convertible to an ArrayView, so + * it can be passed directly to this function. See the ArrayView class for + * more information. * * @note This function is only implemented for codimension zero objects. */