]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Improve documentation.
authorkronbichler <kronbichler@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 22 Mar 2010 15:32:22 +0000 (15:32 +0000)
committerkronbichler <kronbichler@0785d39b-7218-0410-832d-ea1e28bc413d>
Mon, 22 Mar 2010 15:32:22 +0000 (15:32 +0000)
git-svn-id: https://svn.dealii.org/trunk@20879 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/dofs/dof_renumbering.h

index 7291f1fcda8012ccc77b417f2b399fe3a40ef2c6..4e06d61a6a8c15d13d729933a33d0dff6a4559e4 100644 (file)
@@ -924,14 +924,9 @@ namespace DoFRenumbering
                                    * constant flow direction. If the
                                    * additional argument @p
                                    * dof_wise_renumbering is set to @p false,
-                                   * the numbering is performed cell-wise. If
-                                   * it is set to @p true, the dofs are
-                                   * renumbered for finite elements that are
-                                   * based on support points. Note that in
-                                   * this case, the numbering of points will
-                                   * be unaffected in case two points are
-                                   * located the same with respect to the
-                                   * downstream direction.
+                                   * the numbering is performed cell-wise,
+                                   * otherwise it is performed based on the
+                                   * location of the support points.
                                    *
                                    * The cells are sorted such that
                                    * the centers of higher numbers
@@ -945,15 +940,27 @@ namespace DoFRenumbering
                                    * grids, this might not be
                                    * guaranteed for all meshes.
                                    *
-                                   * This function produces a
-                                   * downstream ordering of the
+                                   * If the @p dof_wise_renumbering argument
+                                   * is set to @p false, this function
+                                   * produces a downstream ordering of the
                                    * mesh cells and calls
-                                   * cell_wise_dg().  Therefore, it
-                                   * only works with Discontinuous
-                                   * Galerkin Finite Elements,
-                                   * i.e. all degrees of freedom
-                                   * have to be associated with the
-                                   * interior of the cell.
+                                   * cell_wise(). Therefore, the output only
+                                   * makes sense for Discontinuous Galerkin
+                                   * Finite Elements (all degrees of freedom
+                                   * have to be associated with the interior
+                                   * of the cell in that case) in that case.
+                                   *
+                                   * If @p dof_wise_renumbering is set to @p
+                                   * true, the degrees of freedom are
+                                   * renumbered based on the support point
+                                   * location of the individual degrees of
+                                   * freedom (obviously, the finite element
+                                   * needs to define support points for this
+                                   * to work). The numbering of points with
+                                   * the same position in downstream location
+                                   * (e.g. those parallel to the flow
+                                   * direction, or several dofs within a
+                                   * FESystem) will be unaffected.
                                    */
   template <class DH, int dim>
   void

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.