]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Update some docs.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 11 Jul 2007 20:52:14 +0000 (20:52 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 11 Jul 2007 20:52:14 +0000 (20:52 +0000)
git-svn-id: https://svn.dealii.org/trunk@14852 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria.h

index 564f0394fff8642f2dcff43ad5ee90886dc2d067..cb95f8cc64ee21cfca48dcfacd1ef08e6ebfd4b5 100644 (file)
@@ -975,8 +975,8 @@ namespace internal
  *
  *   It is recommended that a functions using the flags states so in
  *   its documentation. For example, the
- *   execute_coarsening_and_refinement() function uses the face user
- *   flags.
+ *   execute_coarsening_and_refinement() function uses some of the user
+ *   flags and will therefore destroy any content stored in them.
  *
  *   There is another set of user data, which can be either an
  *   <tt>unsigned int</tt> or a <tt>void *</tt>, for
@@ -1618,13 +1618,11 @@ class Triangulation : public Subscriptor
                                      * coarsening of the
                                      * triangulation.
                                      *
-                                     * The function resets all
-                                     * refinement and coarsening
-                                     * flags to false. It uses the
-                                     * <tt>line->user_flags</tt> for
-                                     * <tt>dim=2,3</tt> and the
-                                     * <tt>quad->user_flags</tt> for
-                                     * <tt>dim=3</tt>.
+                                     * The function resets all refinement and
+                                     * coarsening flags to false. It uses the
+                                     * user flags for internal purposes. They
+                                     * will therefore be overwritten by
+                                     * undefined content.
                                      *
                                       * See the general docs for more
                                       * information.

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.