From 0448a592dc4ca8601420cf42d4768e933d2090e8 Mon Sep 17 00:00:00 2001 From: bangerth Date: Tue, 3 Sep 2013 21:08:48 +0000 Subject: [PATCH] Update documentation in a couple of places. git-svn-id: https://svn.dealii.org/trunk@30578 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/hp/dof_levels.h | 39 +++++++++++++------------ 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/deal.II/include/deal.II/hp/dof_levels.h b/deal.II/include/deal.II/hp/dof_levels.h index f307cc7172..0f34ab2d45 100644 --- a/deal.II/include/deal.II/hp/dof_levels.h +++ b/deal.II/include/deal.II/hp/dof_levels.h @@ -23,6 +23,7 @@ #include + DEAL_II_NAMESPACE_OPEN namespace hp @@ -61,25 +62,26 @@ namespace internal { private: /** - * Indices specifying the finite - * element of hp::FECollection to use - * for the different cells on the current level. The - * meaning what a cell is, is - * dimension specific, therefore also - * the length of this vector depends - * on the dimension: in one dimension, - * the length of this vector equals - * the length of the @p lines vector, - * in two dimensions that of the @p - * quads vector, etc. The vector stores one element per cell - * since the actiev_fe_index is unique for cells. + * Indices specifying the finite element of hp::FECollection to + * use for the different cells on the current level. The vector + * stores one element per cell since the active_fe_index is + * unique for cells. + * + * If a cell is not active on the level corresponding to the + * current object (i.e., it has children on higher levels) then + * it does not have an associated fe index and we store + * an invalid fe index marker instead. */ std::vector active_fe_indices; /** - * Store the start index for - * the degrees of freedom of each - * object in the @p dofs array. + * Store the start index for the degrees of freedom of each + * object in the @p dofs array. If the cell corresponding to + * a particular index in this array is not active on this level, + * then we do not store any DoFs for it. In that case, the offset + * we store here must be an invalid number and indeed we store + * (std::vector::size_type)(-1) + * for it. * * The type we store is then obviously the type the @p dofs array * uses for indexing. @@ -87,10 +89,9 @@ namespace internal std::vector::size_type> dof_offsets; /** - * Store the global indices of - * the degrees of freedom. See - * DoFLevel() for detailed - * information. + * Store the global indices of the degrees of freedom. + * information. The dof_offsets field determines where each + * (active) cell's data is stored. */ std::vector dofs; -- 2.39.5