]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Enhance documentation for sum_into_values 16382/head
authorJohannes Heinz <johannes.heinz@tuwien.ac.at>
Mon, 8 Jan 2024 17:44:01 +0000 (18:44 +0100)
committerJohannes Heinz <johannes.heinz@tuwien.ac.at>
Mon, 8 Jan 2024 17:51:36 +0000 (18:51 +0100)
include/deal.II/matrix_free/fe_point_evaluation.h

index 9b77d6ab046f49744d3e012ace8337fc278d3247..ab15daa4d116c59ff0b9aad14e2c24a0e044acbf 100644 (file)
@@ -886,7 +886,8 @@ public:
    * 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 @@ public:
    * 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 @@ public:
    * 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 @@ public:
    * 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

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.