b6eeaf5155
- foamExec was removed as part of commit 6c68c34e1a but
overlooked the fact that it is partly still needed by foamJob.
When running in parallel, it is used to source the etc/bashrc env.
Reinstated a stripped down form, which has been relocated to
bin/tools directory (it should not be directly called by the user).
The previous version switching functionality has nonetheless be
dropped since it only worked only when a rigid naming convention for
OpenFOAM installations was followed.
ENH: add foamJob log=, -log-app, -no-log options, improved coding quality
328 lines
8.4 KiB
Bash
Executable File
328 lines
8.4 KiB
Bash
Executable File
#!/bin/sh
|
|
#------------------------------------------------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | Copyright (C) 2019 OpenCFD Ltd.
|
|
# \\/ M anipulation |
|
|
#-------------------------------------------------------------------------------
|
|
# | Copyright (C) 2011-2015 OpenFOAM Foundation
|
|
#------------------------------------------------------------------------------
|
|
# License
|
|
# This file is part of OpenFOAM.
|
|
#
|
|
# OpenFOAM is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
# for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# Script
|
|
# foamJob
|
|
#
|
|
# Description
|
|
# Run an OpenFOAM job in background.
|
|
# Redirects the output to 'log' in the case directory.
|
|
#
|
|
#------------------------------------------------------------------------------
|
|
# If dispatching via foamExec
|
|
foamExec="$WM_PROJECT_DIR/bin/tools/foamExec"
|
|
|
|
usage() {
|
|
exec 1>&2
|
|
while [ "$#" -ge 1 ]; do echo "$1"; shift; done
|
|
cat<<USAGE
|
|
|
|
Usage: ${0##*/} [OPTION] <application> ...
|
|
options:
|
|
-case <dir> specify alternative case directory, default is the cwd
|
|
-parallel run in parallel (with mpirun)
|
|
-screen also send output to screen
|
|
-append append to existing log file instead of overwriting it
|
|
-log=FILE specify the log file
|
|
-log-app Use log.{appName} for the log file
|
|
-no-check run without fewer checks (eg, processor dirs etc)
|
|
-no-log run without log file
|
|
-wait wait for execution to complete (when not using -screen)
|
|
-help print the usage
|
|
|
|
Run an OpenFOAM job in background, redirecting output to a 'log' file
|
|
in the case directory
|
|
|
|
USAGE
|
|
exit 1
|
|
}
|
|
|
|
#------------------------------------------------------------------------------
|
|
# Parse options
|
|
|
|
logFile="log"
|
|
optCheck=true
|
|
unset optParallel optScreen optWait logMode
|
|
|
|
while [ "$#" -gt 0 ]
|
|
do
|
|
case "$1" in
|
|
-h | -help*)
|
|
usage
|
|
;;
|
|
-case)
|
|
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
|
cd "$2" 2>/dev/null || usage "directory does not exist: '$2'"
|
|
shift
|
|
;;
|
|
-p | -parallel)
|
|
optParallel=true
|
|
;;
|
|
-s | -screen)
|
|
optScreen=true
|
|
;;
|
|
-a | -append)
|
|
logMode=append
|
|
;;
|
|
-w | -wait)
|
|
optWait=true
|
|
;;
|
|
-no-check*)
|
|
unset optCheck
|
|
;;
|
|
-no-log)
|
|
logMode=none
|
|
logFile=log # Consistency if -append toggles it back on
|
|
;;
|
|
-log=*)
|
|
logFile="${1##*=}"
|
|
[ -n "$logFile" ] || logFile="log"
|
|
;;
|
|
-log-app)
|
|
logFile="{LOG_APPNAME}" # Tag for log.appName output
|
|
;;
|
|
-version=*)
|
|
echo "Ignoring version option" 1>&2
|
|
;;
|
|
-v | -version)
|
|
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
|
|
echo "Ignoring version option" 1>&2
|
|
shift
|
|
;;
|
|
--)
|
|
shift
|
|
break
|
|
;;
|
|
-*)
|
|
usage "invalid option '$1'"
|
|
;;
|
|
*)
|
|
break
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
# ------------------------------------------------------------------------------
|
|
|
|
[ "$#" -ge 1 ] || usage "No application specified"
|
|
|
|
# The requested application
|
|
appName="$1"
|
|
|
|
# Does application even exist?
|
|
APPLICATION="$(command -v "$appName")" || \
|
|
usage "Application '$appName' not found"
|
|
|
|
if [ "$logFile" = "{LOG_APPNAME}" ]
|
|
then
|
|
logFile="log.${appName##*/}"
|
|
fi
|
|
|
|
|
|
# Need foamExec for remote (parallel) runs
|
|
if [ "$optParallel" = true ]
|
|
then
|
|
# Use foamExec for dispatching
|
|
[ -x "$foamExec" ] || usage "File not found: $foamExec"
|
|
|
|
APPLICATION="$foamExec"
|
|
else
|
|
# Drop first argument in favour of fully qualified APPLICATION
|
|
shift
|
|
fi
|
|
|
|
|
|
# Stringify args, adding single quotes for args with spaces
|
|
echoArgs()
|
|
{
|
|
unset stringifiedArgs
|
|
|
|
for stringItem in "$@"
|
|
do
|
|
case "$stringItem" in (*' '*) stringItem="'$stringItem'" ;; esac
|
|
stringifiedArgs="${stringifiedArgs}${stringifiedArgs:+ }${stringItem}"
|
|
done
|
|
echo "$stringifiedArgs"
|
|
}
|
|
|
|
|
|
if [ "$optParallel" = true ]
|
|
then
|
|
#
|
|
# Parallel
|
|
#
|
|
dict="system/decomposeParDict"
|
|
|
|
[ -r "$dict" ] || {
|
|
echo "No $dict found, which is required for parallel running."
|
|
exit 1
|
|
}
|
|
|
|
nProcs="$(foamDictionary -entry numberOfSubdomains -value $dict 2>/dev/null)"
|
|
|
|
# Check if case is decomposed
|
|
if [ "$optCheck" = true ]
|
|
then
|
|
[ -r "processor0" ] || [ -r "processors" ] || {
|
|
echo "Case is not currently decomposed"
|
|
echo "Try decomposing first with \"foamJob decomposePar\""
|
|
exit 1
|
|
}
|
|
fi
|
|
|
|
# Locate mpirun
|
|
mpirun=$(command -v mpirun) || usage "'mpirun' not found"
|
|
mpiopts="-n $nProcs"
|
|
|
|
# Check if the machine ready to run parallel
|
|
case "$WM_MPLIB" in
|
|
*OPENMPI*)
|
|
# Add hostfile info
|
|
for hostfile in \
|
|
hostfile \
|
|
machines \
|
|
system/hostfile \
|
|
system/machines \
|
|
;
|
|
do
|
|
if [ -r "$hostfile" ]
|
|
then
|
|
mpiopts="$mpiopts -hostfile $hostfile"
|
|
break
|
|
fi
|
|
done
|
|
|
|
# Send FOAM_SETTINGS to parallel processes, so that the proper
|
|
# definitions are sent as well.
|
|
if [ -n "$FOAM_SETTINGS" ]
|
|
then
|
|
mpiopts="$mpiopts -x FOAM_SETTINGS"
|
|
fi
|
|
;;
|
|
esac
|
|
|
|
#
|
|
# Run (in parallel)
|
|
#
|
|
echo "Application : $appName ($nProcs processes)"
|
|
if [ "$logMode" != "none" ]
|
|
then
|
|
echo "Output : $logFile"
|
|
fi
|
|
echo "Executing : $mpirun $mpiopts $APPLICATION $(echoArgs "$@") -parallel"
|
|
if [ "$optScreen" = true ]
|
|
then
|
|
case "$logMode" in
|
|
none)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel
|
|
;;
|
|
append)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel | tee -a "$logFile"
|
|
;;
|
|
*)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel | tee "$logFile"
|
|
;;
|
|
esac
|
|
else
|
|
case "$logMode" in
|
|
none)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel > /dev/null 2>&1 &
|
|
;;
|
|
append)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel >> "$logFile" 2>&1 &
|
|
;;
|
|
*)
|
|
"$mpirun" $mpiopts "$APPLICATION" "$@" -parallel > "$logFile" 2>&1 &
|
|
;;
|
|
esac
|
|
|
|
pid=$!
|
|
if [ "$optWait" = true ]
|
|
then
|
|
echo "Waiting for process $pid to finish"
|
|
wait "$pid"
|
|
echo "Process $pid finished"
|
|
else
|
|
echo "Process id : $pid"
|
|
fi
|
|
fi
|
|
|
|
else
|
|
#
|
|
# Serial
|
|
#
|
|
echo "Application : $appName ($nProcs processes)"
|
|
if [ "$logMode" != "none" ]
|
|
then
|
|
echo "Output : $logFile"
|
|
fi
|
|
echo "Executing : $APPLICATION $(echoArgs "$@")"
|
|
if [ "$optScreen" = true ]
|
|
then
|
|
case "$logMode" in
|
|
none)
|
|
"$APPLICATION" "$@" &
|
|
;;
|
|
append)
|
|
"$APPLICATION" "$@" | tee -a "$logFile" &
|
|
;;
|
|
*)
|
|
"$APPLICATION" "$@" | tee "$logFile" &
|
|
;;
|
|
esac
|
|
|
|
pid=$!
|
|
echo "Process id : $pid"
|
|
wait "$pid"
|
|
else
|
|
case "$logMode" in
|
|
none)
|
|
"$APPLICATION" "$@" > /dev/null 2>&1 &
|
|
;;
|
|
append)
|
|
"$APPLICATION" "$@" >> "$logFile" 2>&1 &
|
|
;;
|
|
*)
|
|
"$APPLICATION" "$@" > "$logFile" 2>&1 &
|
|
;;
|
|
esac
|
|
|
|
pid=$!
|
|
if [ "$optWait" = true ]
|
|
then
|
|
echo "Waiting for process $pid to finish"
|
|
wait "$pid"
|
|
echo "Process $pid finished"
|
|
else
|
|
echo "Process id : $pid"
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
|
|
#------------------------------------------------------------------------------
|