]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update the documentation of GridTools::cell_measure(). 13582/head
authorDavid Wells <drwells@email.unc.edu>
Tue, 29 Mar 2022 22:11:58 +0000 (18:11 -0400)
committerDavid Wells <drwells@email.unc.edu>
Tue, 29 Mar 2022 22:12:26 +0000 (18:12 -0400)
We support non-hypercube cells in this function now.

include/deal.II/grid/grid_tools.h

index e86eafa82885a6dd3465fe576e851b9a8956be7a..c2973faacbaf7a66f63af8e22e83c95e13ecaedf 100644 (file)
@@ -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<dim>::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.
    */

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.