Added new reduction operator "average" provided by Erik Schnetter.

This closes PR CactusPUGH/1476.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGH/PUGHReduce/trunk@37 d60812e6-3970-4df4-986e-c251b06effeb

4 files changed, 356 insertions, 1 deletions

diff --git a/src/ReductionAvg.c b/src/ReductionAvg.c
new file mode 100644
index 0000000..3909b89
--- /dev/null
+++ b/src/ReductionAvg.c
@@ -0,0 +1,351 @@
+ /*@@
+   @file      ReductionAvg.c
+   @date      Thu Apr  3 11:54:53 1997
+   @author    Thomas Radke, Paul Walker, Erik Schnetter
+   @desc
+              Defines the PUGH reduction operator to get the average
+              of an arbitrary array.
+   @enddesc
+   @version   $Id$
+ @@*/
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "pugh_reductions.h"
+
+static const char *rcsid = "$Id$";
+
+CCTK_FILEVERSION(CactusPUGH_PUGHReduce_ReductionAvg_c)
+
+/* local function prototypes */
+static int ReductionAvg (const cGH *GH,
+                         int proc,
+                         int num_dims,
+                         const int from[/* dim */],
+                         const int to[/* dim */],
+                         int iterator[/* dim */],
+                         const int points_per_dim[/* dim */],
+                         int num_points,
+                         int num_inarrays,
+                         const int intypes[/* num_inarrays */],
+                         const void *const inarrays[/* num_inarrays */],
+                         int num_outvals,
+                         CCTK_REAL outvals[/*num_inarrays*num_outvals*/]);
+
+
+/*@@
+  @routine PUGH_ReductionAvgArrays
+  @author  Thomas Radke
+  @date    19 Aug 1999
+  @desc
+           Registered PUGH reduction routine for computing the averages
+           of a set of arrays.
+           The arrays are described by their dimensions and variable type.
+           For the number of output values only 1 is accepted.
+           Type casting of the result is provided by specifying the
+           requested output datatype. The intermediate reduction value
+           is always computed as a CCTK_REAL value internally.
+  @enddesc
+  @history
+  @endhistory
+  @var     GH
+  @vdesc   Pointer to CCTK grid hierarchy
+  @vtype   const cGH *
+  @vio     in
+  @endvar
+  @var     proc
+  @vdesc   processor that should receive the result of operation
+           (negative value means all processors receive the result)
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     nDims
+  @vdesc   number of dimensions of input arrays
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     dims
+  @vdesc   dimensions of input arrays
+  @vtype   const int *
+  @vio     in
+  @endvar
+  @var     nArrays
+  @vdesc   number of input arrays
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     inarrays
+  @vdesc   field of input arrays
+  @vtype   const void *const
+  @vio     in
+  @endvar
+  @var     inType
+  @vdesc   (common) variable type of input arrays
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     num_outvals
+  @vdesc   number of values per output array
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     outvals
+  @vdesc   pointer to buffer holding the output values
+  @vtype   void *
+  @vio     in
+  @endvar
+  @var     outtype
+  @vdesc   (common) variable type of output arrays
+  @vtype   int
+  @vio     in
+  @endvar
+@@*/
+int PUGH_ReductionAvgArrays (const cGH *GH,
+                             int proc,
+                             int num_dims,
+                             const int dims[/* num_dims */],
+                             int num_inarrays,
+                             const void *const inarrays[/* num_inarrays */],
+                             int intype,
+                             int num_outvals,
+                             void *outvals /* [num_outvals] */,
+                             int outtype)
+{
+  return (PUGH_ReductionArrays (GH, proc, num_dims, dims,
+                                intype, num_inarrays, inarrays,
+                                outtype, num_outvals, outvals,
+                                ReductionAvg));
+}
+
+
+/*@@
+  @routine PUGH_ReductionAvgGVs
+  @author  Thomas Radke
+  @date    23 Apr 1999
+  @desc
+           PUGH reduction routine to be registered for calculating the average.
+           It just goes through the list of variables and calls the appropriate
+           grouptype reduction routine.
+           If the number of requested output values equals the size of the
+           variable, global reduction is done element-wise.
+           Otherwise num_outvals must be 1, and global reduction is done on the
+           results of the local reductions.
+  @enddesc
+  @history
+  @endhistory
+  @var     GH
+  @vdesc   Pointer to CCTK grid hierarchy
+  @vtype   const cGH *
+  @vio     in
+  @endvar
+  @var     proc
+  @vdesc   processor that should receive the result of operation
+           (negative value means all processors receive the result)
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     num_outvals
+  @vdesc   number of requested output elements
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     outtype
+  @vdesc   type of return value
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     outvals
+  @vdesc   array for the result values to be stored
+  @vtype   void *
+  @vio     in
+  @endvar
+  @var     num_invars
+  @vdesc   number of variables in the list
+  @vtype   int
+  @vio     in
+  @endvar
+  @var     invars
+  @vdesc   list of variables (given as their global indices)
+  @vtype   const int *
+  @vio     in
+  @endvar
+@@*/
+int PUGH_ReductionAvgGVs (const cGH *GH,
+                          int proc,
+                          int num_outvals,
+                          int outtype,
+                          void *outvals /* [num_outvals] */,
+                          int num_invars,
+                          const int invars[/* num_invars */])
+{
+  return (PUGH_ReductionGVs (GH, proc, num_invars, invars,
+                             outtype, num_outvals, outvals,
+                             ReductionAvg));
+}
+
+
+/*****************************************************************************/
+/*                             local functions                               */
+/*****************************************************************************/
+/*@@
+   @routine    ReductionAvg
+   @date       Aug 19 1999
+   @author     Thomas Radke
+   @desc       Returns the average of a distributed array with
+               'num_points' elements. Global reduction is done element-wise
+               (num_outvals == 1) or on the results of the local reductions.
+   @enddesc
+@@*/
+static int ReductionAvg (const cGH *GH,
+                         int proc,
+                         int num_dims,
+                         const int from[/* dim */],
+                         const int to[/* dim */],
+                         int iterator[/* dim */],
+                         const int points_per_dim[/* dim */],
+                         int num_points,
+                         int num_inarrays,
+                         const int intypes[/* num_inarrays */],
+                         const void *const inarrays[/* num_inarrays */],
+                         int num_outvals,
+                         CCTK_REAL outvals[/*num_inarrays*num_outvals*/])
+{
+  int i, total_outvals;
+  const char *vtypename;
+#ifdef CCTK_MPI
+  const pGH *pughGH;
+  CCTK_REAL *local_outvals;
+#endif
+
+
+  /* avoid compiler warnings about unused parameters */
+  (void) (GH + 0);
+  (void) (proc + 0);
+  (void) (num_points + 0);
+
+/* macros to complete the ITERATE_ARRAY macro */
+#define INITIAL_REDUCTION_VALUE(array)     0
+#define REDUCTION_OPERATION(avg, scalar)   avg += scalar
+
+  for (i = total_outvals = 0; i < num_inarrays; i++)
+  {
+    switch (intypes[i])
+    {
+      case CCTK_VARIABLE_CHAR:
+        ITERATE_ARRAY (CCTK_BYTE, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_BYTE, outvals, num_outvals, total_outvals);
+        break;
+
+      case CCTK_VARIABLE_INT:
+        ITERATE_ARRAY (CCTK_INT, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_INT, outvals, num_outvals, total_outvals);
+        break;
+
+#ifdef CCTK_INT2
+      case CCTK_VARIABLE_INT2:
+        ITERATE_ARRAY (CCTK_INT2, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_INT2, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+#ifdef CCTK_INT4
+      case CCTK_VARIABLE_INT4:
+        ITERATE_ARRAY (CCTK_INT4, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_INT4, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+#ifdef CCTK_INT8
+      case CCTK_VARIABLE_INT8:
+        ITERATE_ARRAY (CCTK_INT8, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_INT8, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+      case CCTK_VARIABLE_REAL:
+        ITERATE_ARRAY (CCTK_REAL, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_REAL, outvals, num_outvals, total_outvals);
+        break;
+
+#ifdef CCTK_REAL4
+      case CCTK_VARIABLE_REAL4:
+        ITERATE_ARRAY (CCTK_REAL4, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_REAL4, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+#ifdef CCTK_REAL8
+      case CCTK_VARIABLE_REAL8:
+        ITERATE_ARRAY (CCTK_REAL8, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_REAL8, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+#ifdef CCTK_REAL16
+      case CCTK_VARIABLE_REAL16:
+        ITERATE_ARRAY (CCTK_REAL16, num_dims, inarrays[i],
+                       from, to, iterator, points_per_dim,
+                       CCTK_REAL16, outvals, num_outvals, total_outvals);
+        break;
+#endif
+
+      default:
+        vtypename = CCTK_VarTypeName (intypes[i]);
+        if (vtypename && strncmp (vtypename, "CCTK_VARIABLE_COMPLEX", 21) == 0)
+        {
+          CCTK_WARN (1, "PUGH_ReductionAvg: Don't know how to compute "
+                        "the average of complex variables !!!");
+        }
+        else
+        {
+          CCTK_WARN (1, "PUGH_ReductionAvg: Unknown variable type");
+        }
+        return (-1);
+    }
+  }
+
+#ifdef CCTK_MPI
+  pughGH = PUGH_pGH (GH);
+
+  /* do the global reduction from the processors' local reduction results */
+  if (pughGH->nprocs > 1)
+  {
+    local_outvals = malloc (total_outvals * sizeof (CCTK_REAL));
+
+    /* outvals[] contains now the local average */
+    memcpy (local_outvals, outvals, total_outvals * sizeof (CCTK_REAL));
+    if (proc < 0)
+    {
+      CACTUS_MPI_ERROR (MPI_Allreduce (local_outvals, outvals, total_outvals,
+                        PUGH_MPI_REAL, MPI_SUM, pughGH->PUGH_COMM_WORLD));
+    }
+    else
+    {
+      CACTUS_MPI_ERROR (MPI_Reduce (local_outvals, outvals, total_outvals,
+                        PUGH_MPI_REAL, MPI_SUM, proc, pughGH->PUGH_COMM_WORLD));
+    }
+    free (local_outvals);
+  }
+
+#endif
+
+  /* finally assign the return value */
+  if (proc < 0 || proc == pughGH->myproc)
+  {
+    for (i = 0; i < total_outvals; i++)
+    {
+      outvals[i] /= num_points;
+    }
+  }
+
+  return (0);
+}
diff --git a/src/Startup.c b/src/Startup.c
index b069e3f..2422b58 100644
--- a/src/Startup.c
+++ b/src/Startup.c
@@ -41,6 +41,7 @@ int PUGHReduce_Startup (void)
   CCTK_RegisterReductionOperator (PUGH_ReductionMinValGVs,  "minimum");
   CCTK_RegisterReductionOperator (PUGH_ReductionMaxValGVs,  "maximum");
   CCTK_RegisterReductionOperator (PUGH_ReductionSumGVs,     "sum");
+  CCTK_RegisterReductionOperator (PUGH_ReductionAvgGVs,     "average");
   CCTK_RegisterReductionOperator (PUGH_ReductionNorm1GVs,   "norm1");
   CCTK_RegisterReductionOperator (PUGH_ReductionNorm2GVs,   "norm2");
   CCTK_RegisterReductionOperator (PUGH_ReductionNormInfGVs, "norm_inf");
@@ -48,6 +49,7 @@ int PUGHReduce_Startup (void)
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionMinValArrays,  "minimum");
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionMaxValArrays,  "maximum");
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionSumArrays,     "sum");
+  CCTK_RegisterReductionArrayOperator (PUGH_ReductionAvgArrays,     "average");
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionNorm1Arrays,   "norm1");
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionNorm2Arrays,   "norm2");
   CCTK_RegisterReductionArrayOperator (PUGH_ReductionNormInfArrays, "norm_inf");
diff --git a/src/make.code.defn b/src/make.code.defn
index 6094737..b53a2d3 100644
--- a/src/make.code.defn
+++ b/src/make.code.defn
@@ -2,4 +2,4 @@
 # $Header$
 
 # Source files in this directory
-SRCS = ReductionMax.c ReductionMin.c ReductionNorm1.c ReductionNorm2.c ReductionNormInf.c ReductionSum.c Startup.c Reduction.c
+SRCS = ReductionAvg.c ReductionMax.c ReductionMin.c ReductionNorm1.c ReductionNorm2.c ReductionNormInf.c ReductionSum.c Startup.c Reduction.c
diff --git a/src/pugh_reductions.h b/src/pugh_reductions.h
index 88a52a4..6bb56c1 100644
--- a/src/pugh_reductions.h
+++ b/src/pugh_reductions.h
@@ -136,6 +136,7 @@ extern "C" {
 int PUGH_ReductionMinValGVs  (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionMaxValGVs  (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionSumGVs     (REDUCTION_OPERATOR_REGISTER_ARGLIST);
+int PUGH_ReductionAvgGVs     (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNorm1GVs   (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNorm2GVs   (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNormInfGVs (REDUCTION_OPERATOR_REGISTER_ARGLIST);
@@ -143,6 +144,7 @@ int PUGH_ReductionNormInfGVs (REDUCTION_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionMinValArrays  (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionMaxValArrays  (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionSumArrays     (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
+int PUGH_ReductionAvgArrays     (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNorm1Arrays   (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNorm2Arrays   (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);
 int PUGH_ReductionNormInfArrays (REDUCTION_ARRAY_OPERATOR_REGISTER_ARGLIST);