From: bangerth Date: Tue, 21 Aug 2012 19:35:01 +0000 (+0000) Subject: Add a comment. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=352407e3c3d75f14096278960f36cb736672b8a8;p=dealii-svn.git Add a comment. git-svn-id: https://svn.dealii.org/trunk@26064 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/numerics/vector_tools.h b/deal.II/include/deal.II/numerics/vector_tools.h index 048ad135e9..b4697a585d 100644 --- a/deal.II/include/deal.II/numerics/vector_tools.h +++ b/deal.II/include/deal.II/numerics/vector_tools.h @@ -2182,15 +2182,22 @@ namespace VectorTools * * Apart from the vector @p v to operate * on, this function takes a boolean mask - * that has a true entry for - * every component for which the mean - * value shall be computed and later + * that has a true entry for every element + * of the vector for which the mean value + * shall be computed and later * subtracted. The argument is used to - * denote which components of the - * solution vector correspond to the - * pressure, and avoid touching all other - * components of the vector, such as the - * velocity components. + * denote which components of the solution + * vector correspond to the pressure, and + * avoid touching all other components of + * the vector, such as the velocity + * components. (Note, however, that the + * mask is not a @ref GlossComponentMask + * operating on the vector components of + * the finite element the solution vector + * @p v may be associated with; rather, it + * is a mask on the entire vector, without + * reference to what the vector elements + * mean.) * * @note In the context of using this * function to filter out the kernel of