Newer
Older
#!/bin/sh
#------------------------------------------------------------------------------
# ========= |
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
# \\ / O peration |
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# \\/ M anipulation |
#-------------------------------------------------------------------------------
# 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.
#
#------------------------------------------------------------------------------
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 parallel run of processors
-screen also sends output to screen
-append append to log file instead of overwriting it
-wait wait for execution to complete (when not using -screen)
-version <ver> specify an alternative OpenFOAM version
-help print the usage
* run an OpenFOAM job in background.
Redirects the output to 'log' in the case directory
USAGE
exit 1
}
# Echo strings that have single quotes
echoArgs() {
addSpace=""
for stringItem in "$@"; do
echo -n "${addSpace}"
if [ "${stringItem##* }" = "$stringItem" ]
then
echo -n "$stringItem"
addSpace=" "
else
echo -n "'$stringItem'"
addSpace=" "
fi
done
unset stringItem addSpace
}
unset version
# Replacement for possibly buggy 'which'
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
findExec() {
case "$1" in
*/*)
if [ -x "$1" ]
then
echo "$1"
return 0
fi
;;
esac
oldIFS=$IFS
IFS=':'
for d in $PATH
do
# echo "testing: $d/$1" 1>&2
if [ -x "$d/$1" -a ! -d "$d/$1" ]
then
# echo "Found exec: $d/$1" 1>&2
IFS=$oldIFS
echo "$d/$1"
return 0
fi
done
IFS=$oldIFS
echo ""
return 1
}
# Main script
# Parse options
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 2
;;
-p | -parallel)
parallelOpt=true
shift
;;
-s | -screen)
screenOpt=true
shift
;;
-a | -append)
appendOpt=true
shift
;;
-v | -version)
[ "$#" -ge 2 ] || usage "'$1' option requires an argument"
version="$2"
shift 2
;;
--)
shift
break
;;
-*)
usage "invalid option '$1'"
;;
*)
break
;;
esac
done
[ "$#" -ge 1 ] || usage "No application specified"
# Use foamExec for a specified version
# Also need foamExec for remote (parallel) runs
if [ -n "$version" -o "$parallelOpt" = true ]
then
# When possible, determine if application even exists
if [ -z "$version" ]
then
findExec $1 >/dev/null || usage "Application '$1' not found"
fi
# Use foamExec for dispatching
APPLICATION=`findExec foamExec` || usage "'foamExec' not found"
[ -n "$version" ] && APPLICATION="$APPLICATION -version $version"
# Attempt to preserve the installation directory 'FOAM_INST_DIR'
if [ -d "$FOAM_INST_DIR" ]
then
APPLICATION="$APPLICATION -prefix $FOAM_INST_DIR"
fi
else
APPLICATION=`findExec $1` || usage "Application '$1' not found"
echo "Application : $1"
shift
fi
if [ "$parallelOpt" = true ]
then
# parallel
# ~~~~~~~~
#
# Check if the case decomposed
#
if [ -r "processor0" ]
then
NPROCS="`/bin/ls -1d processor* | wc -l`"
else
echo "Case is not currently decomposed"
if [ -r system/decomposeParDict ]
then
echo "system/decomposeParDict exists"
echo "Try decomposing with \"foamJob decomposePar\""
exit 1
else
echo "Cannot find system/decomposeParDict file required to decompose the case for parallel running."
echo "Please consult the User Guide for details of parallel running"
exit 1
fi
fi
#
# Find mpirun
#
mpirun=`findExec mpirun` || usage "'mpirun' not found"
mpiopts="-np $NPROCS"
#
# Check if the machine ready to run parallel
#
echo "Parallel processing using $WM_MPLIB with $NPROCS processors"
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.
#
mpiopts="$mpiopts -x FOAM_SETTINGS"
# Run (in parallel)
[ "$appendOpt" = true ] && teeOpts=" -a"
echo "Executing: $mpirun $mpiopts $APPLICATION $(echoArgs "$@") -parallel | tee $teeOpts log"
$mpirun $mpiopts $APPLICATION "$@" -parallel | tee $teeOpts log
if [ "$appendOpt" = true ]
then
echo "Executing: $mpirun $mpiopts $APPLICATION $(echoArgs "$@") -parallel >> log 2>&1"
$mpirun $mpiopts $APPLICATION "$@" -parallel >> log 2>&1 &
else
echo "Executing: $mpirun $mpiopts $APPLICATION $(echoArgs "$@") -parallel > log 2>&1"
$mpirun $mpiopts $APPLICATION "$@" -parallel > log 2>&1 &
fi
pid=$!
if [ "$waitOpt" = true ]
then
wait $pid
fi
# Run (on single processor)
[ "$appendOpt" = true ] && teeOpts=" -a"
echo "Executing: $APPLICATION $(echoArgs "$@") | tee $teeOpts log &"
$APPLICATION "$@" | tee $teeOpts log &
if [ "$appendOpt" = true ]
then
echo "Executing: $APPLICATION $(echoArgs "$@") >> log 2>&1 &"
$APPLICATION "$@" >> log 2>&1 &
else
echo "Executing: $APPLICATION $(echoArgs "$@") > log 2>&1 &"
$APPLICATION "$@" > log 2>&1 &
fi
pid=$!
if [ "$waitOpt" = true ]
then
wait $pid
fi
#------------------------------------------------------------------------------