#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
#    \\/     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 2 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, write to the Free Software Foundation,
#     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# Script
#     paraFoam
#
# Description
#     start paraview with the OpenFOAM libraries
#
# Note
#     combining -block and -region options yields undefined behaviour
#------------------------------------------------------------------------------
usage() {
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    cat<<USAGE

usage: ${0##*/} [OPTION]
options:
  -case   dir    specify alternative case directory
  -region name   specify mesh region name
  -block         use blockMesh reader (and .blockMesh file)
  -touch         only create the .OpenFOAM file

* start paraview $ParaView_VERSION with the OpenFOAM libraries

USAGE
    exit 1
}

unset regionName touchOnly

# reader extension
reader=OpenFOAM

# parse options
while [ "$#" -gt 0 ]
do
    case "$1" in
    -h | -help)
        usage
        ;;
    -block | -blockMesh)
        reader=blockMesh
        shift
        ;;
    -case)
        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
        cd "$2" 2>/dev/null || usage "directory does not exist:  '$2'"
        shift 2
        ;;
    -region)
        [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
        regionName=$2
        shift 2
        ;;
    -touch)
        touchOnly=true
        shift
        ;;
    *)
        usage "unknown option/argument: '$*'"
        ;;
    esac
done

# get a sensible caseName from the directory name
caseName=${PWD##*/}
caseFile="$caseName.$reader"
fvControls="system"

if [ -n "$regionName" ]
then
    caseFile="$caseName{$regionName}.$reader"
    fvControls="$fvControls/$regionName"
fi

if [ -n "$touchOnly" ]
then
    touch "$caseFile"
    echo "created '$caseFile'"
    exit 0
fi

# parent directory for normal or parallel results
case "$caseName" in
    processor*) parentDir=".." ;;
    *)          parentDir="."  ;;
esac


#
# check existence of essential files
#
case $reader in
blockMesh)
    for check in system/controlDict constant/polyMesh/blockMeshDict
    do
        [ -s "$parentDir/$check" ] || usage "file does not exist:  '$parentDir/$check'"
    done
    ;;

OpenFOAM)
    for check in system/controlDict $fvControls/fvSchemes $fvControls/fvSolution
    do
        [ -s "$parentDir/$check" ] || usage "file does not exist:  '$parentDir/$check'"
    done
    ;;
esac

case "$ParaView_VERSION" in
2*)
    trap "rm -f paraFoam.pvs $caseFile 2>/dev/null; exit 0" EXIT TERM INT
    touch "$caseFile"

    # since we are now in the cwd, %CASE% is '$PWD/$caseFile'
    sed -e s@%CASE%@$PWD/$caseFile@g \
        $WM_PROJECT_DIR/bin/tools/paraFoam.pvs > paraFoam.pvs

    paraview paraFoam.pvs
    ;;

*)
    # only create/remove caseFile if it didn't already exist
    [ -e $caseFile ] || {
        trap "rm -f $caseFile 2>/dev/null; exit 0" EXIT TERM INT
        touch "$caseFile"
        echo "created temporary '$caseFile'"
    }

    paraview --data="$caseFile"
    ;;

esac
#------------------------------------------------------------------------------