]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix documentation of Utilities::MPI::MinMaxAvg 6077/head
authorDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Tue, 20 Mar 2018 17:07:16 +0000 (18:07 +0100)
committerDaniel Arndt <daniel.arndt@iwr.uni-heidelberg.de>
Tue, 20 Mar 2018 17:07:16 +0000 (18:07 +0100)
include/deal.II/base/mpi.h

index 2dd20725c30898cace4da45a3f92e0f7e0b3adc3..fa06d976569f12aa79120d44a459d77392e68fd5 100644 (file)
@@ -314,19 +314,34 @@ namespace Utilities
     {
       /**
        * The sum over all values contributed by the processors that
-       * participate in the call to min_max_avg(), as well as the
-       * minimum and maximum value.
+       * participate in the call to min_max_avg().
        */
       double sum;
+
+      /**
+       * The minimum value over all values contributed by the processors that
+       * participate in the call to min_max_avg().
+       */
       double min;
+
+      /**
+       * The maximum value over all values contributed by the processors that
+       * participate in the call to min_max_avg().
+       */
       double max;
 
       /**
-       * The indices (i.e., @ref GlossMPIRank "MPI rank" within an
+       * One of the ranks (i.e., @ref GlossMPIRank "MPI rank" within an
        * @ref GlossMPICommunicator "MPI communicator") of the
-       * processors that hold the minimal and maximal values.
+       * processors that hold the minimal value.
        */
       unsigned int min_index;
+
+      /**
+       * One of the ranks (i.e., @ref GlossMPIRank "MPI rank" within an
+       * @ref GlossMPICommunicator "MPI communicator") of the
+       * processors that hold the maximal value.
+       */
       unsigned int max_index;
 
       /**

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.