]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update the documentation of DoFHandler::n_dofs(). 4107/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 23 Mar 2017 23:20:12 +0000 (17:20 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Thu, 23 Mar 2017 23:20:12 +0000 (17:20 -0600)
include/deal.II/dofs/dof_handler.h
include/deal.II/hp/dof_handler.h

index cbb426bce5065fbd1dda835d81ffffae23166602..cb251e96e49db66dc12a039768ab387ed8536384 100644 (file)
@@ -685,6 +685,13 @@ public:
    * In either case, included in the returned number are those DoFs which are
    * constrained by hanging nodes, see
    * @ref constraints.
+   *
+   * Mathematically speaking, the number returned by this function equals the
+   * dimension of the finite element space (without taking into account
+   * constraints) that corresponds to (i) the mesh on which it is defined,
+   * and (ii) the finite element that is used by the current object. It
+   * also, of course, equals the number of shape functions that span this
+   * space.
    */
   types::global_dof_index n_dofs () const;
 
index f0fff6b0a5cd4de518fb5a1a6c29a6cc7daffcd6..aa9c8d32bd1b6bfff9f22b3ccced6f357b575686 100644 (file)
@@ -506,6 +506,13 @@ namespace hp
      * In either case, included in the returned number are those DoFs which
      * are constrained by hanging nodes, see
      * @ref constraints.
+     *
+     * Mathematically speaking, the number returned by this function equals the
+     * dimension of the finite element space (without taking into account
+     * constraints) that corresponds to (i) the mesh on which it is defined,
+     * and (ii) the finite element that is used by the current object. It
+     * also, of course, equals the number of shape functions that span this
+     * space.
      */
     types::global_dof_index n_dofs () 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.