]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Fix outdated docs
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 28 Jul 2006 16:04:43 +0000 (16:04 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 28 Jul 2006 16:04:43 +0000 (16:04 +0000)
git-svn-id: https://svn.dealii.org/trunk@13471 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/dofs/dof_handler.h

index d5f3c99f990722d981981a4d5d991db8e2845f68..07bc3d53af84a327138b42f2ff754c3abaed6724 100644 (file)
@@ -231,25 +231,37 @@ class DoFHandler  :  public Subscriptor
                                      */
     virtual void clear ();
     
-                                    /**
-                                     * Actually do the renumbering based on
-                                     * a list of new dof numbers for all the
-                                     * dofs.
-                                     *
-                                     * @p new_numbers is an array of integers
-                                     * with size equal to the number of dofs
-                                     * on the present grid. It stores the new
-                                     * indices after renumbering in the
-                                     * order of the old indices.
-                                     *
-                                     * This function is called by the
-                                     * @p renumber_dofs function after computing
-                                     * the ordering of the degrees of freedom.
-                                     * However, you can call this function
-                                     * yourself, which is necessary if a user
-                                     * wants to implement an ordering scheme
-                                     * herself, for example downwind numbering.
-                                     */
+                                       /**
+                                        * Renumber degrees of freedom based on
+                                        * a list of new dof numbers for all the
+                                        * dofs.
+                                        *
+                                        * @p new_numbers is an array of integers
+                                        * with size equal to the number of dofs
+                                        * on the present grid. It stores the new
+                                        * indices after renumbering in the
+                                        * order of the old indices.
+                                        *
+                                        * This function is called by
+                                        * the functions in
+                                        * DoFRenumbering function
+                                        * after computing the ordering
+                                        * of the degrees of freedom.
+                                        * However, you can call this
+                                        * function yourself, which is
+                                        * necessary if a user wants to
+                                        * implement an ordering scheme
+                                        * herself, for example
+                                        * downwind numbering.
+                                       *
+                                       * The @p new_number array must
+                                       * have a size equal to the
+                                       * number of degrees of
+                                       * freedom. Each entry must
+                                       * state the new global DoF
+                                       * number of the degree of
+                                       * freedom referenced.
+                                        */
     void renumber_dofs (const std::vector<unsigned int> &new_numbers);
 
                                     /**

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.