From a600902a6bed03472df9c592ddd78b74db3abed7 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Tue, 20 Aug 2024 08:42:11 -0600 Subject: [PATCH] Leave a comment in the documentation. --- include/deal.II/dofs/dof_tools.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h index 39442f70b7..08081a8353 100644 --- a/include/deal.II/dofs/dof_tools.h +++ b/include/deal.II/dofs/dof_tools.h @@ -1159,7 +1159,10 @@ namespace DoFTools * are to be filtered by this function. * @param[in] component_mask A mask that states which components you want * to select. The size of this mask must be compatible with the number of - * components in the FiniteElement used by the @p dof_handler. See + * components in the FiniteElement used by the @p dof_handler. A common + * way to create this kind of mask is using extractors for whatever + * vector component you want to extract, and using it with + * FiniteElement::component_mask(). See * @ref GlossComponentMask "the glossary entry on component masks" * for more information. * @return An IndexSet object that will contain exactly those entries that -- 2.39.5