From: Martin Kronbichler <martin.kronbichler@uni-a.de>
Date: Thu, 16 Mar 2023 10:21:05 +0000 (+0100)
Subject: Merge pull request #14900 from peterrum/feeval_docu
X-Git-Tag: v9.5.0-rc1~470
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a642c71c7e9d786f4fe6cb6e157e82fdc9312076;p=dealii.git

Merge pull request #14900 from peterrum/feeval_docu

Different documentation updates in `matrix_free`
---

a642c71c7e9d786f4fe6cb6e157e82fdc9312076
diff --cc include/deal.II/matrix_free/fe_evaluation.h
index 70a5e20955,3a9245ce56..e08b6b7b08
--- a/include/deal.II/matrix_free/fe_evaluation.h
+++ b/include/deal.II/matrix_free/fe_evaluation.h
@@@ -474,9 -474,9 +474,9 @@@ public
  
    /**
     * Return the divergence of a vector-valued finite element at quadrature
 -   * point number @p q_point after a call to @p evaluate(...,true,...).
 +   * point number @p q_point after a call to @p evaluate(EvaluationFlags::gradients).
     *
-    * @note Only available for n_components_==dim.
+    * @note Only available for the vector-valued case (n_components == dim).
     */
    VectorizedArrayType
    get_divergence(const unsigned int q_point) const;
@@@ -484,19 -484,19 +484,19 @@@
    /**
     * Return the symmetric gradient of a vector-valued finite element at
     * quadrature point number @p q_point after a call to @p
 -   * evaluate(...,true,...). It corresponds to <tt>0.5
 +   * evaluate(EvaluationFlags::gradients). It corresponds to <tt>0.5
     * (grad+grad<sup>T</sup>)</tt>.
     *
-    * @note Only available for n_components_==dim.
+    * @note Only available for the vector-valued case (n_components == dim).
     */
    SymmetricTensor<2, dim, VectorizedArrayType>
    get_symmetric_gradient(const unsigned int q_point) const;
  
    /**
     * Return the curl of the vector field, $\nabla \times v$ after a call to @p
 -   * evaluate(...,true,...).
 +   * evaluate(EvaluationFlags::gradients).
     *
-    * @note Only available for n_components_==dim.
+    * @note Only available for the vector-valued case (n_components == dim).
     */
    Tensor<1, (dim == 2 ? 1 : dim), VectorizedArrayType>
    get_curl(const unsigned int q_point) const;