Enhance documentation for sum_into_values

dealii · Jan 8, 2024 · 98646f1 · 98646f1
1 parent 2184cb4
commit 98646f1
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
@@ -886,7 +886,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>
@@ -913,7 +914,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
@@ -943,7 +945,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>
@@ -975,7 +978,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