]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add to the documentation.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 13 Jul 2009 03:26:14 +0000 (03:26 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Mon, 13 Jul 2009 03:26:14 +0000 (03:26 +0000)
git-svn-id: https://svn.dealii.org/trunk@19062 0785d39b-7218-0410-832d-ea1e28bc413d

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

index c2ce29771ab31f6d90845a977e7eb08dec2b4827..cc3ce77b17c8c0e1d792f0a0a0a61bd0a63f95a6 100644 (file)
@@ -1767,21 +1767,19 @@ class Triangulation : public Subscriptor
     void set_all_refine_flags ();
 
                                     /**
-                                     *  Refine all cells @p times
-                                     *  times, by alternatingly
-                                     *  calling
-                                     *  <tt>set_all_refine_flags()</tt>
-                                     *  and
-                                     *  <tt>execute_coarsening_and_refinement()</tt>.
-                                     *  This function actually starts
-                                     *  the refinement process, so
-                                     *  you have no way to store the
-                                     *  refinement flags unless you
-                                     *  overload the
-                                     *  @p execute_coarsening_and_refinement
-                                     *  function.
+                                     * Refine all cells @p times times, by
+                                     * alternatingly calling
+                                     * set_all_refine_flags and
+                                     * execute_coarsening_and_refinement.
                                      *
-                                     * 
+                                     * The latter function may throw an
+                                     * exception if it creates cells that are
+                                     * distorted (see its documentation for
+                                     * an explanation). This exception will
+                                     * be propagated through this function if
+                                     * that happens, and you may not get the
+                                     * actual number of refinement steps in
+                                     * that case.
                                      */
     void refine_global (const unsigned int times);
 

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.