366 lines
8.6 KiB
Bash
366 lines
8.6 KiB
Bash
#---------------------------------*- sh -*-------------------------------------
|
|
# ========= |
|
|
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
# \\ / O peration |
|
|
# \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
# \\/ M anipulation | Copyright (C) 2015-2017 OpenCFD Ltd.
|
|
#------------------------------------------------------------------------------
|
|
# 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
|
|
# RunFunctions
|
|
#
|
|
# Description
|
|
# Miscellaneous functions for running tutorial cases
|
|
#------------------------------------------------------------------------------
|
|
|
|
# The normal locations
|
|
[ -n "$FOAM_TUTORIALS" ] || export FOAM_TUTORIALS=$WM_PROJECT_DIR/tutorials
|
|
|
|
|
|
#------------------------------------------------------------------------------
|
|
|
|
#
|
|
# Look for '-parallel' in the argument list.
|
|
#
|
|
isParallel()
|
|
{
|
|
for i; do [ "$i" = "-parallel" ] && return 0; done
|
|
return 1
|
|
}
|
|
|
|
|
|
#
|
|
# Look for '-test' in the argument list.
|
|
#
|
|
isTest()
|
|
{
|
|
for i; do [ "$i" = "-test" ] && return 0; done
|
|
return 1
|
|
}
|
|
|
|
|
|
#
|
|
# Extract 'numberOfSubdomains' from system/decomposeParDict
|
|
# (or alternative location).
|
|
#
|
|
# On failure:
|
|
# return '1'
|
|
# exit status 1
|
|
#
|
|
getNumberOfProcessors()
|
|
{
|
|
local dict="${1:-system/decomposeParDict}"
|
|
|
|
# Re-use positional parameters for automatic whitespace elimination
|
|
set -- $(foamDictionary -entry numberOfSubdomains -value "$dict" 2>/dev/null)
|
|
|
|
if [ "$#" -eq 1 ]
|
|
then
|
|
echo "$1"
|
|
else
|
|
echo "Warning no 'numberOfSubdomains' in '$dict'" 1>&2
|
|
echo 1 # serial as fallback
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
|
|
#
|
|
# Extract 'application' from system/controlDict
|
|
#
|
|
# On failure:
|
|
# return 'false' which is also a command (ie, shell builtin or /bin/false)
|
|
# exit status 1
|
|
#
|
|
getApplication()
|
|
{
|
|
# Re-use positional parameters for automatic whitespace elimination
|
|
set -- $(foamDictionary -entry application -value system/controlDict)
|
|
|
|
if [ "$#" -eq 1 ]
|
|
then
|
|
echo "$1"
|
|
else
|
|
echo "Error retrieving 'application' from controlDict" 1>&2
|
|
echo false
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
|
|
#
|
|
# Run given application in serial with logfile output.
|
|
# The preexistence of the log file prevents rerunning.
|
|
#
|
|
runApplication()
|
|
{
|
|
local appRun logFile logMode
|
|
|
|
# Any additional parsed arguments (eg, decomposeParDict)
|
|
local appArgs
|
|
|
|
# Parse options until executable is encountered
|
|
while [ $# -gt 0 -a -z "$appRun" ]
|
|
do
|
|
case "$1" in
|
|
-a | -append)
|
|
logMode=append
|
|
;;
|
|
-o | -overwrite)
|
|
logMode=overwrite
|
|
;;
|
|
-s | -suffix)
|
|
logFile=".$2"
|
|
shift
|
|
;;
|
|
-decomposeParDict)
|
|
appArgs="$appArgs $1 $2"
|
|
shift
|
|
;;
|
|
'')
|
|
;;
|
|
*)
|
|
appRun="$1"
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
local appName="${appRun##*/}"
|
|
logFile="log.$appName$logFile"
|
|
|
|
if [ -f "$logFile" -a -z "$logMode" ]
|
|
then
|
|
echo "$appName already run on $PWD:" \
|
|
"remove log file '$logFile' to re-run"
|
|
else
|
|
echo "Running $appRun on $PWD"
|
|
if [ "$logMode" = append ]
|
|
then
|
|
$appRun $appArgs "$@" >> $logFile 2>&1
|
|
else
|
|
$appRun $appArgs "$@" > $logFile 2>&1
|
|
fi
|
|
fi
|
|
}
|
|
|
|
|
|
#
|
|
# Run given application in parallel with logfile output.
|
|
# The preexistence of the log file prevents rerunning.
|
|
#
|
|
runParallel()
|
|
{
|
|
local appRun logFile logMode nProcs
|
|
|
|
# Any additional parsed arguments (eg, decomposeParDict)
|
|
local appArgs="-parallel"
|
|
|
|
# Parse options until executable is encountered
|
|
while [ $# -gt 0 -a -z "$appRun" ]
|
|
do
|
|
case "$1" in
|
|
-a | -append)
|
|
logMode=append
|
|
;;
|
|
-o | -overwrite)
|
|
logMode=overwrite
|
|
;;
|
|
-s | -suffix)
|
|
logFile=".$2"
|
|
shift
|
|
;;
|
|
-n | -np)
|
|
nProcs="$2"
|
|
shift
|
|
;;
|
|
-decomposeParDict)
|
|
appArgs="$appArgs $1 $2"
|
|
nProcs=$(getNumberOfProcessors "$2")
|
|
shift
|
|
;;
|
|
'')
|
|
;;
|
|
*)
|
|
appRun="$1"
|
|
;;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
[ -n "$nProcs" ] || nProcs=$(getNumberOfProcessors system/decomposeParDict)
|
|
|
|
local appName="${appRun##*/}"
|
|
logFile="log.$appName$logFile"
|
|
|
|
if [ -f "$logFile" -a -z "$logMode" ]
|
|
then
|
|
echo "$appName already run on $PWD:" \
|
|
"remove log file '$logFile' to re-run"
|
|
else
|
|
echo "Running $appRun ($nProcs processes) on $PWD "
|
|
if [ "$logMode" = append ]
|
|
then
|
|
(
|
|
mpirun -np $nProcs $appRun $appArgs "$@" </dev/null >> $logFile 2>&1
|
|
)
|
|
else
|
|
(
|
|
mpirun -np $nProcs $appRun $appArgs "$@" </dev/null > $logFile 2>&1
|
|
)
|
|
fi
|
|
fi
|
|
}
|
|
|
|
|
|
compileApplication()
|
|
{
|
|
echo "Compiling $1 application"
|
|
wmake $1
|
|
}
|
|
|
|
|
|
#
|
|
# cloneCase srcDir dstDir
|
|
#
|
|
cloneCase()
|
|
{
|
|
local src=$1
|
|
local dst=$2
|
|
shift 2
|
|
|
|
if [ -e "$dst" ]
|
|
then
|
|
echo "Case already cloned: remove case directory $dst prior to cloning"
|
|
return 1
|
|
elif [ ! -d "$src" ]
|
|
then
|
|
echo "Error: no directory to clone: $src"
|
|
return 1
|
|
fi
|
|
|
|
echo "Cloning $dst case from $src"
|
|
mkdir $dst
|
|
# These must exist, so do not hide error messages
|
|
for f in constant system
|
|
do
|
|
\cp -r $src/$f $dst
|
|
done
|
|
|
|
# Either (or both) may exist, so error messages may be spurious
|
|
for f in 0 0.orig
|
|
do
|
|
\cp -r $src/$f $dst 2>/dev/null
|
|
done
|
|
return 0
|
|
}
|
|
|
|
|
|
#
|
|
# cloneParallelCase srcDir dstDir [...times]
|
|
#
|
|
# If any times are specified, they will be used for the cloning.
|
|
# Otherwise the entire processor* directories are cloned
|
|
cloneParallelCase()
|
|
{
|
|
local src=$1
|
|
local dst=$2
|
|
shift 2
|
|
|
|
if [ -e "$dst" ]
|
|
then
|
|
echo "Case already cloned: remove case directory $dst prior to cloning"
|
|
return 1
|
|
fi
|
|
|
|
[ -d "$src" ] || {
|
|
echo "Error: no directory to clone: $src"
|
|
return 1
|
|
}
|
|
|
|
echo "Cloning $dst parallel case from $src"
|
|
mkdir $dst
|
|
# These must exist, so do not hide error messages
|
|
for f in constant system
|
|
do
|
|
\cp -r $src/$f $dst
|
|
done
|
|
|
|
[ -d $src/processor0 ] || {
|
|
echo "Does not appear to be a parallel case"
|
|
return 1
|
|
}
|
|
|
|
if [ "$#" -eq 0 ]
|
|
then
|
|
# Copy all processor directories
|
|
echo " clone processor* directories"
|
|
\cp -r $src/processor* $dst
|
|
else
|
|
# Only copy some time directories
|
|
echo " clone processor directories with $# times: $@"
|
|
|
|
for proc in $(cd $src && \ls -d processor*)
|
|
do
|
|
srcProc=$src/$proc
|
|
dstProc=$dst/$proc
|
|
|
|
mkdir $dstProc
|
|
cp -r $srcProc/constant $dstProc/
|
|
|
|
for time
|
|
do
|
|
[ -d $srcProc/$time ] && cp -r $srcProc/$time $dstProc/
|
|
done
|
|
|
|
done
|
|
fi
|
|
|
|
return 0
|
|
}
|
|
|
|
|
|
# Overwrite 0/ with the contents of 0.orig/ if it exists.
|
|
# The -processor option to do the processor directories instead
|
|
#
|
|
restore0Dir()
|
|
{
|
|
if [ "$1" = "-processor" ]
|
|
then
|
|
echo "Restore 0/ from 0.orig/ for processor directories"
|
|
[ -d 0.orig ] || echo " Warning: no 0.orig/ found"
|
|
|
|
# do nonetheless
|
|
\ls -d processor* | xargs -I {} \rm -rf ./{}/0
|
|
\ls -d processor* | xargs -I {} \cp -r 0.orig ./{}/0 > /dev/null 2>&1
|
|
|
|
else
|
|
echo "Restore 0/ from 0.orig/"
|
|
if [ -d 0.orig ]
|
|
then
|
|
\rm -rf 0
|
|
\cp -r 0.orig 0 2>/dev/null
|
|
else
|
|
echo " Warning: no 0.orig/ found"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
|
|
#------------------------------------------------------------------------------
|