]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update a comment on ComponentMask. 5954/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Sat, 24 Feb 2018 20:46:29 +0000 (13:46 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 24 Feb 2018 20:46:29 +0000 (13:46 -0700)
include/deal.II/fe/component_mask.h

index 7bad6dface8aa86073b9982e3b5a16e4a6f0a409..e07ef660dd0cb1c2288e00959ad27e1c3aa51d90 100644 (file)
@@ -35,10 +35,23 @@ DEAL_II_NAMESPACE_OPEN
  * components, and one can use <code>operator[]</code> to query whether a
  * particular component has been selected.
  *
+ * @note A "mask" represents a data structure with @p true and @p false
+ *   entries that is generally used to enable or disable an operation
+ *   for a particular vector component. By this definition, disabled
+ *   vector components still exist -- they are simply not touched. As
+ *   a consequence, when you apply a component mask for interpolating
+ *   boundary values (to choose just one example) of a problem with
+ *   $C$ vector components, the input argument that describes the
+ *   boundary values will still have to provide $C$ components even
+ *   if the mask says that we only want to interpolate a subset of
+ *   these components onto the finite element space. In other words,
+ *   a component mask does not represent a <i>reduction</i> operation;
+ *   it represents a <i>selection</i>.
+ *
  * Objects of this kind are used in many places where one wants to restrict
  * operations to a certain subset of components, e.g. in
- * DoFTools::make_zero_boundary_values or
- * VectorTools::interpolate_boundary_values. These objects can either be
+ * DoFTools::make_zero_boundary_values() or
+ * VectorTools::interpolate_boundary_values(). These objects can either be
  * created by hand, or, simpler, by asking the finite element to generate a
  * component mask from certain selected components using code such as this
  * where we create a mask that only denotes the velocity components of a

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.