From bea4346acd1f08423de2df995a09f192fa54af3c Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Thu, 20 Sep 2012 14:08:13 +0000 Subject: [PATCH] Augment documentation. git-svn-id: https://svn.dealii.org/trunk@26568 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/dofs/dof_renumbering.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/deal.II/include/deal.II/dofs/dof_renumbering.h b/deal.II/include/deal.II/dofs/dof_renumbering.h index 6b7d838b1f..341d1da45e 100644 --- a/deal.II/include/deal.II/dofs/dof_renumbering.h +++ b/deal.II/include/deal.II/dofs/dof_renumbering.h @@ -849,6 +849,24 @@ namespace DoFRenumbering * Sort the degrees of freedom by * block. It does the same * thing as the above function. + * + * This function only succeeds if each of + * the elements in the hp::FECollection + * attached to the hp::DoFHandler argument + * has exactly the same number of blocks + * (see @ref GlossBlock "the glossary" for + * more information). Note that this is not + * always given: while the hp::FECollection + * class ensures that all of its elements + * have the same number of vector + * components, they need not have the same + * number of blocks. At the same time, this + * function here needs to match individual + * blocks across elements and therefore + * requires that elements have the same + * number of blocks and that subsequent + * blocks in one element have the same + * meaning as in another element. */ template void -- 2.39.5