]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add note to Triangulation::create_triangulation 10937/head
authorPeter Munch <peterrmuench@gmail.com>
Sun, 20 Sep 2020 08:15:13 +0000 (10:15 +0200)
committerPeter Munch <peterrmuench@gmail.com>
Sun, 20 Sep 2020 08:25:58 +0000 (10:25 +0200)
include/deal.II/grid/tria.h

index e8233a89da0439658224685342b20ccf914ea5c3..24920d3032b1da3b2f49c3df1f6afd90a2b0e479 100644 (file)
@@ -1697,7 +1697,9 @@ public:
 
   /**
    * Return a constant reference to a Manifold object used for this
-   * triangulation.  Number is the same as in @p set_manifold
+   * triangulation. @p number is the same as in set_manifold().
+   *
+   * @note If no manifold could be found, the default flat manifold is returned.
    *
    * @ingroup manifold
    *
@@ -1820,8 +1822,11 @@ public:
    * Create a triangulation from the provided
    * TriangulationDescription::Description.
    *
+   * @note Don't forget to attach the manifolds with set_manifold() before
+   *   calling this function if manifolds are needed.
+   *
    * @note The namespace TriangulationDescription::Utilities contains functions
-   *       to create TriangulationDescription::Description.
+   *   to create TriangulationDescription::Description.
    *
    * @param construction_data The data needed for this process.
    */

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.