This thorn implement processor-local reduction operations.
A reduction operation can be defined as an operation on arrays (tuples) of variables resulting in a single number. Typical reduction operations are sum, minimum/maximum value, and boolean operations. A typical application is, for example, finding the minimum value in an \(n\)-dimensional array.
This thorn provides processor-local reduction operations only. Global reduction operations can make use of these local reduction operations by providing the necessary inter-processor communication.
The new local reduce thorn has several new features including index strides and offsets for array indexing and full complex number support. Pending request, weight support can be enabled (there are some issues that a mask is essentially a weight with 1 or 0 value).
Modifying or extending this thorn is quite a simple matter. The heart of all the reduction operations is the large iterator macro in local_reductions.h. This iterator supports n-dimensional arrays with offsets and strides. The iterator is used in all local reduction operators in this thorn. To add a reduction operator, or change an existing one, all that needs to be done is to change the actual reduction operation definition which is called from within the iterator to perform the reduction.
To use a custom local reduction operator from the new global reduction implementation, some values must be returned to the global reduction implementation, such as the type of MPI reduction operation that needs to be performed (MPI_SUM, MPI_MIN, MPI_MAX) and if the final result should include a division by the total number of points used in the reduction. These are set in the parameter table with keys: mpi_operation and perform_division.
Please refer to the TestLocalReduce thorn in the CactusTest arrangement.
The following reduction operations are imlemented. \(a_i\) are the values that are reduced, \(i \in [1 \ldots n]\).
count:
The number of values
sum:
The sum of the values
product:
The product of the values
sum2:
The sum of the squares of the values
sumabs:
The sum of the absolute values
sumabs2:
The sum of the squares of the absolute values
min:
The minimum of the values
max:
The maximum of the values
maxabs:
The maximum of the absolute values
Note that the above definitions are for both real and complex values. For \(n=0\), the result of the reduction operation is \(0\), except for \(\mathrm {product}\), which is \(1\), \(\mathrm {min}\), which is \(+\infty \), and \(\mathrm {max}\), which is \(-\infty \). We define the minimum of complex values by
and define the maximum equivalently.
The following high-level reduction operations are also implemented. They can be defined in terms of the basic reduction operations above.
average:
The algebraic mean of the values
norm1:
The \(L_1\) norm, i.e., the sum of the absolute values
norm2:
The \(L_2\) norm, i.e., the Pythagorean norm
norm_inf:
The \(L_\infty \) norm
It is often convenient to assign a weight \(w_i\) to each value \(a_i\). In this case, the basic reduction operations are redefined as follows.
count:
The number of values
sum:
The sum of the values
product:
The product of the values
sum2:
The sum of the squares of the values
sumabs:
The sum of the absolute values
sumabs2:
The sum of the squares of the absolute values
min:
The minimum of the values
max:
The maximum of the values
maxabs:
The maximum of the absolute values
The notation \(\min _i w_i \ne 0: a_i\) means: “The minimum of \(a_i\) where \(i\) runs over all values where \(w_i \ne 0\)”. The definition of the high-level reduction operations does not change when weights are present.
Implements:
localreduce
This section lists all the variables which are assigned storage by thorn CactusNumerical/LocalReduce. Storage can either last for the duration of the run (Always means that if this thorn is activated storage will be assigned, Conditional means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.
NONE
CCTK_STARTUP
localreduce_startup
startup routine
Language: | c | |
Type: | function | |