From 717fc29c7b09ccb73ddf203afd2053c16131f718 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Sat, 17 Jun 2017 19:05:27 -0600 Subject: [PATCH] Add documentation. --- include/deal.II/dofs/dof_handler.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h index 6ca43aec0f..af38d34293 100644 --- a/include/deal.II/dofs/dof_handler.h +++ b/include/deal.II/dofs/dof_handler.h @@ -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 + * indices_offset[level-coarsest_level]. */ types::global_dof_index *indices; @@ -1029,6 +1032,10 @@ private: * This array stores, for each level starting with coarsest_level, the * offset in the indices 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; }; -- 2.39.5