Merge branch 'master' of github.com:OpenFOAM/OpenFOAM-dev

bin/foamCloneCase

+#!/bin/sh
+#------------------------------------------------------------------------------
+# =========                 |
+# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+#  \\    /   O peration     |
+#   \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+#    \\/     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
+#     foamCloneCase
+#
+# Description
+#     Create a new case directory that includes time, system and constant
+#     directories from a source case.
+#     The time directory is the first time directory by default
+#     - requires foamListTimes v2.3.x and newer
+#
+#------------------------------------------------------------------------------
+usage() {
+    exec 1>&2
+    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
+    cat<<USAGE
+
+Usage: ${0##*/} [OPTION] <sourceCase> <targetCase>
+options:
+  -l | -latestTime    clone the latest time directory
+  -h | -help          print the usage
+
+Create a new <targetCase> case directory that includes time, system and constant
+directories of <sourceCase> directory.
+The time directory is the first time directory by default.
+
+USAGE
+    exit 1
+}
+
+TIME_OPTION="head -1"
+
+# parse options
+while [ "$#" -gt 0 ]
+do
+    case "$1" in
+    -h | -help)
+        usage
+        ;;
+    -l | -latestTime)
+        TIME_OPTION="tail -1"
+        shift 1
+        ;;
+    -*)
+        usage "unknown option: '$*'"
+        ;;
+    *)
+        break
+        ;;
+    esac
+done
+
+[ $# -eq 2 ] || usage "Incorrect arguments specified"
+if [ "$(foamListTimes -case $1 2>&1 >/dev/null | grep 'FOAM FATAL ERROR')" ]
+then
+    usage "$1 is not does not a valid case directory"
+fi
+! [ -e $2 ] || usage "$2 file/directory already exists, delete and re-run"
+
+echo "Making $2 case directory"
+mkdir $2
+
+TIME_DIR="$(foamListTimes -withZero -case $1 | $TIME_OPTION)"
+
+echo "Copying case directories from $1 to $2"
+cp -r $1/system $1/constant $1/${TIME_DIR} $2
+
+#------------------------------------------------------------------------------

bin/foamCreateVideo

+#!/bin/sh
+#------------------------------------------------------------------------------
+# =========                 |
+# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+#  \\    /   O peration     |
+#   \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+#    \\/     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
+#     foamCreateVideo
+#
+# Description
+#     Creates an MPEG-4 compressed (.mp4) video file from PNG images
+#     - requires mencoder
+#
+#------------------------------------------------------------------------------
+
+usage () {
+    exec 1>&2
+    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
+    cat <<USAGE
+
+Usage: ${0##*/} [OPTIONS] ...
+options:
+  -d | -dir <dir>     directory containing png images (default local dir)
+  -f | -fps <fps>     frames per second (default = 10)
+  -h | -help          help
+  -i | -image <name>  name of image sequence (default = image)
+  -o | -out <name>    name of output video file (default = video)
+
+Creates an MPEG-4 compressed (.mp4) video file from a sequence of PNG images
+- A sequence named "image" will expect files image.0000.png, image.0001.png, etc
+- An output video named "video" will produce a file video.mp4
+- By default the video codec is high resolution (x264) but there is an option to
+  select a medium resolution codec (lavc)
+
+Requires mencoder
+
+USAGE
+    exit 1
+}
+
+
+# Default settings
+DIR='.'
+IMAGE='image'
+VIDEO='video'
+FPS=10
+VCODEC=x264
+
+
+while [ "$#" -gt 0 ]
+do
+   case "$1" in
+   -h | -help)
+      usage
+      ;;
+   -d | -directory)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      DIR=$2
+      shift 2
+      ;;
+   -f | -fps)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      FPS=$2
+      shift 2
+      ;;
+   -i | -image)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      IMAGE=$2
+      shift 2
+      ;;
+   -o | -out)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      VIDEO=$2
+      shift 2
+      ;;
+   -*)
+      usage "invalid option '$1'"
+      ;;
+   *)
+      break
+      ;;
+    esac
+done
+
+#
+# MAIN
+#
+
+[ -f "$(ls -1 $DIR/$IMAGE.*.png | head -1)" ] || usage "Cannot find first file in image sequence"
+
+if command -v mencoder >/dev/null 2>&1; then
+    mencoder \
+        "mf://$DIR/$IMAGE.*.png" \
+        -mf fps=$FPS \
+        -o $VIDEO.mp4 \
+        -ovc $VCODEC
+else
+    usage "Please install mencoder"
+fi

bin/foamMonitor

+#!/bin/sh
+#------------------------------------------------------------------------------
+# =========                 |
+# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+#  \\    /   O peration     |
+#   \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+#    \\/     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
+#     foamMonitor
+#
+# Description
+#     Monitor data with Gnuplot from time-value(s) graphs written by OpenFOAM
+#     e.g. by functionObjects
+#     - requires gnuplot, gnuplot_x11
+#
+#------------------------------------------------------------------------------
+usage() {
+    exec 1>&2
+    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
+    cat<<USAGE
+
+Usage: ${0##*/} [OPTION] <file>
+options:
+  -h | -help            print the usage
+  -i | -idle <time>     stops if <file> unchanging for <time> sec (default = 60)
+  -l | -logscale        plots data (y-axis) on log scale, e.g. for residuals
+  -r | -refresh <time>  refreshes display every <time> sec (default = 10)
+  -y | -yrange <range>  sets data (y-axis) <range>, format "[0:1]"
+
+Monitor data with Gnuplot from time-value(s) graphs written by OpenFOAM
+e.g. by functionObjects
+- requires gnuplot, gnuplot_x11
+
+Example:
+  foamMonitor -l postProcessing/residuals/0/residuals.dat
+
+USAGE
+    exit 1
+}
+
+plotFileHeader() {
+    cat<<EOF
+set term x11 1 font "helvetica,17" linewidth 1.5 persist noraise
+$LOGSCALE
+$YRANGE
+set title "Data Monitoring"
+set xlabel "$XLABEL"
+plot \\
+EOF
+}
+
+plotFileFooter() {
+    cat<<EOF
+
+pause $REFRESH
+reread
+EOF
+}
+
+howMany() ( set -f; set -- $1; echo $# )
+
+IDLE=60
+REFRESH=10
+LOGSCALE=""
+YRANGE=""
+GNUPLOT=$(which gnuplot)
+! [ "x$GNUPLOT" = "x" ] || usage "Gnuplot not installed"
+
+# parse options
+while [ "$#" -gt 0 ]
+do
+    case "$1" in
+    -h | -help)
+        usage
+        ;;
+    -i | -idle)
+        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+        [ ! -z "${2##*[!0-9]*}" ] && IDLE=$2 || usage "Argument of '$1' is not an integer: '$2'"
+        shift 2
+        ;;
+    -l | -logscale)
+        LOGSCALE="set logscale y"
+        shift 1
+        ;;
+    -r | -refresh)
+        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+        [ ! -z "${2##*[!0-9]*}" ] && REFRESH=$2 || usage "Argument of '$1' is not an integer: '$2'"
+        shift 2
+        ;;
+    -y | -yrange)
+        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+        YRANGE="set yrange $2"
+        shift 2
+        ;;
+    -*)
+        usage "unknown option: '$*'"
+        ;;
+    *)
+        break
+        ;;
+    esac
+done
+
+[ $# -eq 1 ] || usage "Incorrect arguments specified"
+[ -f $1 ]    || usage "File $1 does not exit"
+FILE=$1
+
+# Get KEYS from header
+KEYS=$(grep -E '^#' $FILE | tail -1)
+
+[ "x$KEYS" = "x" ] && KEYS="# Step"
+NKEYS=$(howMany "$KEYS")
+NCOLS=$(tail -1 $FILE | awk '{ print NF}')
+
+# With full column labels, NKEYS = NCOLS + 1, since it includes "#"
+
+# If NKEYS > NCOLS + 1, REMOVE EXCESS KEYS
+NCOLSPONE=$(expr $NCOLS + 1)
+[ "$NKEYS" -gt "$NCOLSPONE" ] && KEYS=$(echo $KEYS | cut -d" " -f1-$NCOLSPONE)
+NKEYS=$(howMany "$KEYS")
+
+i=0
+while [ "$NKEYS" -le "$NCOLS" ]
+do
+    i=$(expr $i + 1)
+    KEYS="$KEYS data$i"
+    NKEYS=$(howMany "$KEYS")
+done
+
+# Remove # and Time keys
+XLABEL=$(echo $KEYS | cut -d " " -f2)
+KEYS=$(echo $KEYS | cut -d " " -f3-)
+
+GPFILE=$(mktemp)
+plotFileHeader > $GPFILE
+i=1
+for field in $KEYS
+do
+    i=$(expr $i + 1)
+    echo "\"$FILE\" using 1:${i} with lines title \"$field\", \\" >> $GPFILE
+done
+plotFileFooter >> $GPFILE
+
+touch $FILE
+$GNUPLOT $GPFILE &
+PID=$!
+
+while true
+do
+    MODTIME=$(stat --format=%Y $FILE)
+    IDLEAGO=$(expr $(date +%s) - $IDLE)
+    test "$MODTIME" -gt "$IDLEAGO" || break
+    sleep $REFRESH
+done
+
+kill -9 $PID
+rm $GPFILE
+
+#------------------------------------------------------------------------------

bin/foamSequenceVTKFiles

+#!/bin/sh
+#------------------------------------------------------------------------------
+# =========                 |
+# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
+#  \\    /   O peration     |
+#   \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
+#    \\/     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
+#     foamSequenceVTKFiles
+#
+# Description
+#     Creates symbolic links to all VTK files in a post-processing directory
+#     Links form a sequence like name.0000.vtk, name.0001.vtk, etc.
+#     Paraview recognises link names as a sequence which can be animated.
+#     The sequence of links can be used to create a video from the images.
+#     - Default directory name for VTK files is postProcessing
+#
+#------------------------------------------------------------------------------
+usage () {
+    exec 1>&2
+    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
+    cat <<USAGE
+
+Usage: ${0##*/} [OPTIONS] ...
+options:
+  -c | -case <dir>    specify case directory (default = local dir)
+  -d | -dir <dir>     post-processing directory <dir> (default = postProcessing)
+  -h | -help          help
+  -o | -out <dir>     output links directory <dir> (default = sequencedVTK)
+
+Creates symbolic links to all VTK files in a post-processing directory
+Links form a sequence like name.0000.vtk, name.0001.vtk, etc.
+Paraview recognises the link names as a sequence which can be opened and played.
+The sequence of links to images can be used to create a video from the images.
+- Default directory name for VTK files is postProcessing
+
+USAGE
+    exit 1
+}
+
+DIR=postProcessing
+OUT=sequencedVTK
+
+while [ "$#" -gt 0 ]
+do
+   case "$1" in
+   -c | -case)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      cd "$2" 2>/dev/null || usage "directory does not exist:  '$2'"
+      shift 2
+      ;;
+   -d | -dir)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      DIR=$2
+      shift 2
+      ;;
+   -h | -help)
+      printUsage
+      ;;
+   -o | -out)
+      [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
+      OUT=$2
+      shift 2
+      ;;
+   -*)
+      usage "invalid option '$1'"
+      ;;
+   *)
+      break
+      ;;
+    esac
+done
+
+if [ ! -d $DIR ]; then
+    echo "Cannot find postProcessing directory, exiting."
+    exit 0
+fi
+
+FILES=$(find $DIR -type f -name *vtk)
+NAMES=$(basename -s .vtk -a $FILES | sort -u)
+
+if [ -d $OUT ]; then
+    echo "$OUT directory already exists.  Deleting links within it..."
+    rm -rf $OUT/*
+else
+    echo "Creating $OUT directory..."
+    mkdir $OUT
+fi
+
+for N in $NAMES
+do
+    echo "Sequencing all VTK files named $N.vtk"
+
+    # Create list of VTK files, ordered by time step
+    FILE_LIST=$(echo $FILES | \
+        tr " " "\n" | \
+        grep $N.vtk | \
+        awk -F'/' '{print($(NF-1)" "$0)}' | \
+        sort -k 1 -g | \
+        cut -d' ' -f2)
+
+    i=0
+    for F in $FILE_LIST
+    do
+        i=$(expr $i + 1) # Relies on ordered list of $sourceFiles
+        LINK=$(printf "${N}.%04d.vtk" $i)
+        ln -s ../$F $OUT/$LINK
+    done
+done