]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update documentation
authorRene Gassmoeller <rene.gassmoeller@mailbox.org>
Mon, 21 May 2018 18:38:01 +0000 (11:38 -0700)
committerRene Gassmoeller <rene.gassmoeller@mailbox.org>
Mon, 21 May 2018 18:38:01 +0000 (11:38 -0700)
include/deal.II/grid/grid_tools.h

index b5df22b7cb1bb89fd2897cf0dfaa841775b6cbe4..17d0d10237f5056b543ca07c59d9d2e6479529c0 100644 (file)
@@ -770,9 +770,15 @@ namespace GridTools
    * and querying for each cell where its vertices are through the (optional)
    * `mapping` argument.
    *
-   * The size of the returned map equals Triangulation::n_used_vertices(),
-   * (not Triangulation::n_vertices()). If you use the default `mapping`, the
-   * returned map satisfies the following equality:
+   * In serial and parallel::shared triangulations the size of the returned map
+   * equals Triangulation::n_used_vertices(), (not Triangulation::n_vertices()).
+   * Note that in parallel::distributed triangulations only vertices in locally
+   * owned cells and ghost cells are returned, as for all other vertices their
+   * real location might not be known (e.g. for distributed computations using
+   * MappingQEulerian).
+   *
+   * If you use the default `mapping`, the returned map satisfies the following
+   * equality:
    *
    * @code
    * used_vertices = extract_used_vertices(tria);

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.