From 8201aa30bd4f60ae90fe7192b2b2d2c5114e421c Mon Sep 17 00:00:00 2001
From: Martin Beaudoin <beaudoin.martin@gmail.com>
Date: Tue, 26 Jun 2018 22:21:14 -0400
Subject: [PATCH] Add a MPIRUN_OPTIONS environment variable when using the
 runParallel shell function. When using OpenMPI 3.1.0, one could specify the
 runtime parameter '-oversubscribe' to mpirun

---
 ThirdParty/rpmBuild/SPECS/openmpi-3.1.0.spec | 2 ++
 bin/tools/RunFunctions                       | 2 +-
 etc/prefs.csh-EXAMPLE                        | 4 ++++
 etc/prefs.sh-EXAMPLE                         | 4 ++++
 4 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/ThirdParty/rpmBuild/SPECS/openmpi-3.1.0.spec b/ThirdParty/rpmBuild/SPECS/openmpi-3.1.0.spec
index 266d64c1c..be52853b3 100644
--- a/ThirdParty/rpmBuild/SPECS/openmpi-3.1.0.spec
+++ b/ThirdParty/rpmBuild/SPECS/openmpi-3.1.0.spec
@@ -194,6 +194,7 @@ then
     echo ""
     echo "    MPI_HOME              : \$MPI_HOME"
     echo "    MPI_ARCH_PATH         : \$MPI_ARCH_PATH"
+    echo "    MPIRUN_OPTIONS        : \$MPIRUN_OPTIONS"
     echo "    OPAL_PREFIX           : \$OPAL_PREFIX"
     echo "    PINC                  : \$PINC"
     echo "    PLIBS                 : \$PLIBS"
@@ -243,6 +244,7 @@ if (\$?FOAM_VERBOSE && \$?prompt) then
     echo ""
     echo "    MPI_HOME              : \$MPI_HOME"
     echo "    MPI_ARCH_PATH         : \$MPI_ARCH_PATH"
+    echo "    MPIRUN_OPTIONS        : \$MPIRUN_OPTIONS"
     echo "    OPAL_PREFIX           : \$OPAL_PREFIX"
     echo "    PINC                  : \$PINC"
     echo "    PLIBS                 : \$PLIBS"
diff --git a/bin/tools/RunFunctions b/bin/tools/RunFunctions
index 2ecdeca1a..4799a993e 100644
--- a/bin/tools/RunFunctions
+++ b/bin/tools/RunFunctions
@@ -91,7 +91,7 @@ runParallel ()
     fi
         cat system/fvSchemes > $LOG_NAME
         cat system/fvSolution >> $LOG_NAME
-        ( $mpirunProg -np $1 $APP_RUN -parallel < /dev/null > $LOG_NAME 2>&1 )
+        ( $mpirunProg $MPIRUN_OPTIONS -np $1 $APP_RUN -parallel < /dev/null > $LOG_NAME 2>&1 )
     fi
 }
 
diff --git a/etc/prefs.csh-EXAMPLE b/etc/prefs.csh-EXAMPLE
index db29e24a2..e8b838bd5 100644
--- a/etc/prefs.csh-EXAMPLE
+++ b/etc/prefs.csh-EXAMPLE
@@ -53,6 +53,10 @@
 #setenv OPENMPI_COMPILE_FLAGS "`$OPENMPI_BIN_DIR/mpicc --showme:compile`"
 #setenv OPENMPI_LINK_FLAGS "`$OPENMPI_BIN_DIR/mpicc --showme:link`"
 
+# MPI runtime options
+#setenv MPI_BUFFER_SIZE 100000000
+#setenv MPIRUN_OPTIONS -oversubscribe  # OpenMPI version 3.1
+
 # Specify system installed ThirdParty packages/libraries
 # NB: The packages installed under $WM_THIRD_PARTY_DIR
 #     will always override these values.
diff --git a/etc/prefs.sh-EXAMPLE b/etc/prefs.sh-EXAMPLE
index d60fcd4ee..bd4c04fd9 100644
--- a/etc/prefs.sh-EXAMPLE
+++ b/etc/prefs.sh-EXAMPLE
@@ -55,6 +55,10 @@ export FOAM_VERBOSE=1
 #export OPENMPI_COMPILE_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:compile`"
 #export OPENMPI_LINK_FLAGS="`$OPENMPI_BIN_DIR/mpicc --showme:link`"
 
+# MPI runtime options
+#export MPI_BUFFER_SIZE=100000000
+#export MPIRUN_OPTIONS=-oversubscribe  # OpenMPI version 3.1
+
 # Specify system installed ThirdParty packages/libraries
 # NB: The packages installed under $WM_THIRD_PARTY_DIR
 #     will always override these values.