]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Leave a comment in the documentation. 17577/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Tue, 20 Aug 2024 14:42:11 +0000 (08:42 -0600)
committerWolfgang Bangerth <bangerth@colostate.edu>
Tue, 20 Aug 2024 14:42:11 +0000 (08:42 -0600)
include/deal.II/dofs/dof_tools.h

index 39442f70b76c2ef1ac96a936b24953ad7b6a26e6..08081a83534ac78941d0a798201437a279a9f109 100644 (file)
@@ -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

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.