Merge pull request #16382 from jh66637/dont_zero_out_whole_buffer

Enhance documentation for sum_into_values
dealii · Jan 15, 2024 · ded657d · ded657d
2 parents ac82d80 + dee004c
commit ded657d
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/include/deal.II/matrix_free/fe_point_evaluation.h b/include/deal.II/matrix_free/fe_point_evaluation.h
@@ -881,7 +881,8 @@ class FEPointEvaluation
    * integrated at the points.
    *
    * @param[in] sum_into_values Flag specifying if the integrated values
-   * should be summed into the solution values. Defaults to false.
+   * should be summed into the solution values. For the default value
+   * `sum_into_values=false` every value of @p solution_values is zeroed out.
    *
    */
   template <std::size_t stride_view>
@@ -908,7 +909,8 @@ class FEPointEvaluation
    * integrated at the points.
    *
    * @param[in] sum_into_values Flag specifying if the integrated values
-   * should be summed into the solution values. Defaults to false.
+   * should be summed into the solution values. For the default value
+   * `sum_into_values=false` every value of @p solution_values is zeroed out.
    *
    */
   void
@@ -938,7 +940,8 @@ class FEPointEvaluation
    * integrated at the points.
    *
    * @param[in] sum_into_values Flag specifying if the integrated values
-   * should be summed into the solution values. Defaults to false.
+   * should be summed into the solution values. For the default value
+   * `sum_into_values=false` every value of @p solution_values is zeroed out.
    *
    */
   template <std::size_t stride_view>
@@ -970,7 +973,8 @@ class FEPointEvaluation
    * integrated at the points.
    *
    * @param[in] sum_into_values Flag specifying if the integrated values
-   * should be summed into the solution values. Defaults to false.
+   * should be summed into the solution values. For the default value
+   * `sum_into_values=false` every value of @p solution_values is zeroed out.
    *
    */
   void