]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Add documentation.
authorWolfgang Bangerth <bangerth@colostate.edu>
Sun, 18 Jun 2017 01:05:27 +0000 (19:05 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Mon, 19 Jun 2017 03:48:47 +0000 (21:48 -0600)
include/deal.II/dofs/dof_handler.h

index 6ca43aec0f754d38f432cdb5efece5b4f9f6dcbd..af38d3429345863a692ffab7964e0e17d18999b2 100644 (file)
@@ -1022,6 +1022,9 @@ private:
     /**
      * A pointer to an array where we store the indices of the DoFs that live
      * on the various levels this vertex exists on.
+     *
+     * The starting offset of the DoFs that belong to a @p level are given by
+     * <code>indices_offset[level-coarsest_level]</code>.
      */
     types::global_dof_index *indices;
 
@@ -1029,6 +1032,10 @@ private:
      * This array stores, for each level starting with coarsest_level, the
      * offset in the <code>indices</code> array where the DoF indices for each
      * level are stored.
+     *
+     * We need to explicitly store this offset because this class does not
+     * store how many degrees of freedom the finite element has per vertex,
+     * and consequently cannot compute the offset on the fly.
      */
     types::global_dof_index *indices_offset;
   };

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.