]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Improve documentation.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 29 Dec 2008 03:16:04 +0000 (03:16 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 29 Dec 2008 03:16:04 +0000 (03:16 +0000)
git-svn-id: https://svn.dealii.org/trunk@18037 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/tria_accessor.h

index df4bd31579e54799dccf6d82f95c388918f52ded..6abc8207327d638e544c0ed12d9ef1a67eaf90f4 100644 (file)
@@ -1110,16 +1110,23 @@ class TriaAccessor : public TriaAccessorBase<structdim, dim, spacedim>
                                      * set_all_boundary_indicators()
                                      * function.
                                      *
-                                     * Caution: Never set the
-                                     * boundary indicator to 255,
-                                     * unless you exactly know what
-                                     * you are doing!  This value is
-                                     * reserved for another purpose
-                                     * and algorithms may not work if
-                                     * boundary cells have this
-                                     * boundary indicator or if
-                                     * interior cells have boundary
-                                     * indicators other than 255.
+                                     * Caution: You should never set the
+                                     * boundary indicator of an interior face
+                                     * (a face not at the boundary of the
+                                     * domain), or set set the boundary
+                                     * indicator of an exterior face to 255
+                                     * (this value is reserved for another
+                                     * purpose). Algorithms may not work or
+                                     * produce very confusing results if
+                                     * boundary cells have this boundary
+                                     * indicator or if interior cells have
+                                     * boundary indicators other than
+                                     * 255. Unfortunately, the current object
+                                     * has no means of finding out whether it
+                                     * really is at the boundary of the
+                                     * domain and so cannot determine whether
+                                     * the value you are trying to set makes
+                                     * sense under the current circumstances.
                                      */
     void set_boundary_indicator (const unsigned char) const;
 

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.