]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add a comment to GridTools::transform(). 7449/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 19 Nov 2018 05:14:57 +0000 (22:14 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 19 Nov 2018 05:14:57 +0000 (22:14 -0700)
include/deal.II/grid/grid_tools.h

index a6ff6c7d7cb1c60fdf8845b747ae277037f5b159..2762529c6e3e04a0a107b7bc1b886cf6388646fc 100644 (file)
@@ -331,6 +331,17 @@ namespace GridTools
    * or it is a pointer to the function. In either case, argument and return
    * value have to be of type <tt>Point@<spacedim@></tt>.
    *
+   * @note The transformations that make sense to use with this function
+   *   should have a Jacobian with a positive determinant. For example,
+   *   rotation, shearing, stretching, or scaling all satisfy this (though
+   *   there is no requirement that the transformation used actually is
+   *   linear, as all of these examples are). On the other hand, reflections
+   *   or inversions have a negative determinant of the Jacobian. The
+   *   current function has no way of asserting a positive determinant
+   *   of the Jacobian, but if you happen to use such a transformation,
+   *   the result will be a triangulation in which cells have a negative
+   *   volume.
+   *
    * @note If you are using a parallel::distributed::Triangulation you will
    * have hanging nodes in your local Triangulation even if your "global" mesh
    * has no hanging nodes. This will cause issues with wrong positioning of

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.