From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Thu, 23 Mar 2017 23:20:12 +0000 (-0600)
Subject: Update the documentation of DoFHandler::n_dofs().
X-Git-Tag: v9.0.0-rc1~1780^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3c148a3c230bd31e1115dad9df7653c18cb9c242;p=dealii.git

Update the documentation of DoFHandler::n_dofs().
---

diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h
index cbb426bce5..cb251e96e4 100644
--- a/include/deal.II/dofs/dof_handler.h
+++ b/include/deal.II/dofs/dof_handler.h
@@ -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;
 
diff --git a/include/deal.II/hp/dof_handler.h b/include/deal.II/hp/dof_handler.h
index f0fff6b0a5..aa9c8d32bd 100644
--- a/include/deal.II/hp/dof_handler.h
+++ b/include/deal.II/hp/dof_handler.h
@@ -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;