]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update comments of two functions. 7354/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Mon, 15 Oct 2018 21:24:20 +0000 (15:24 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 16 Oct 2018 19:47:42 +0000 (13:47 -0600)
These functions were not individually documented. Fix this and make
clear what they do.

include/deal.II/hp/dof_handler.h

index 6560d5646fd897dd23a88eb0ccc9ea63326aeb9a..64f0d5360a5bd7a99ef9b3d6f2586c19807cda06 100644 (file)
@@ -928,14 +928,23 @@ namespace hp
     create_active_fe_table();
 
     /**
-     * Functions that will be triggered through signals whenever the
-     * triangulation is modified.
+     * A function that will be triggered through a triangulation
+     * signal just before the triangulation is modified.
      *
-     * Here they are used to administrate the active_fe_fields during the
-     * spatial refinement.
+     * The function that stores the active_fe_flags of all cells that will
+     * be refined or coarsened before the refinement happens, so that
+     * they can be set again after refinement.
      */
     void
     pre_refinement_action();
+
+    /**
+     * A function that will be triggered through a triangulation
+     * signal just after the triangulation is modified.
+     *
+     * The function that restores the active_fe_flags of all cells that
+     * were refined.
+     */
     void
     post_refinement_action();
 

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.