Skip to content

Commit 7de101b

Browse files
authored
Improve ParReduce doxygen documentation (#4707)
Make it clear that ParReduce is local to MPI.
1 parent e446dc1 commit 7de101b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

Src/Base/AMReX_ParReduce.H

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
namespace amrex {
88

99
/**
10-
* \brief Parallel reduce for MultiFab/FabArray.
10+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
11+
* and it's the user's responsibility if MPI communication is needed.
1112
*
1213
* This performs reduction over a MultiFab's valid and specified ghost regions. For
1314
* example, the code below computes the minimum of the first MultiFab and the maximum of
@@ -55,7 +56,8 @@ ParReduce (TypeList<Ops...> operation_list, TypeList<Ts...> type_list,
5556
}
5657

5758
/**
58-
* \brief Parallel reduce for MultiFab/FabArray.
59+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
60+
* and it's the user's responsibility if MPI communication is needed.
5961
*
6062
* This performs reduction over a MultiFab's valid and specified ghost regions. For
6163
* example, the code below computes the sum of the processed data in a MultiFab.
@@ -106,7 +108,8 @@ ParReduce (TypeList<Op> operation_list, TypeList<T> type_list,
106108
}
107109

108110
/**
109-
* \brief Parallel reduce for MultiFab/FabArray.
111+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
112+
* and it's the user's responsibility if MPI communication is needed.
110113
*
111114
* This performs reduction over a MultiFab's valid and specified ghost regions and
112115
* components. For example, the code below computes the minimum of the first MultiFab
@@ -156,7 +159,8 @@ ParReduce (TypeList<Ops...> operation_list, TypeList<Ts...> type_list,
156159
}
157160

158161
/**
159-
* \brief Parallel reduce for MultiFab/FabArray.
162+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
163+
* and it's the user's responsibility if MPI communication is needed.
160164
*
161165
* This performs reduction over a MultiFab's valid and specified ghost regions. For
162166
* example, the code below computes the sum of the data in a MultiFab.
@@ -203,7 +207,8 @@ ParReduce (TypeList<Op> operation_list, TypeList<T> type_list,
203207
}
204208

205209
/**
206-
* \brief Parallel reduce for MultiFab/FabArray.
210+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
211+
* and it's the user's responsibility if MPI communication is needed.
207212
*
208213
* This performs reduction over a MultiFab's valid region. For
209214
* example, the code below computes the minimum of the first MultiFab and the maximum of
@@ -245,7 +250,8 @@ ParReduce (TypeList<Ops...> operation_list, TypeList<Ts...> type_list,
245250
}
246251

247252
/**
248-
* \brief Parallel reduce for MultiFab/FabArray.
253+
* \brief Parallel reduce for MultiFab/FabArray. The reduce result is local
254+
* and it's the user's responsibility if MPI communication is needed.
249255
*
250256
* This performs reduction over a MultiFab's valid region. For
251257
* example, the code below computes the sum of the processed data in a MultiFab.

0 commit comments

Comments
 (0)