paraFoam

#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | Copyright (C) 1991-2010 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 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
#     paraFoam
#
# Description
#     start paraview with the OpenFOAM libraries
#
# Note
#     combining -block or -builtin options with the -region option yields
#     undefined behaviour
#------------------------------------------------------------------------------
usage() {
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    cat<<USAGE

Usage: ${0##*/} [OPTION]
options:
  -block            use blockMesh reader  (uses .blockMesh extension)
  -builtin          use VTK builtin OpenFOAM reader  (uses .foam extension)
  -case <dir>       specify alternative case directory, default is the cwd
  -region <name>    specify alternative mesh region
  -touch            only create the file  (eg, .blockMesh, .OpenFOAM, etc)
  -touchAll         create .blockMesh, .OpenFOAM files (and for all regions)
  -help             print the usage

* start paraview $ParaView_VERSION with the OpenFOAM libraries

USAGE
    exit 1
}

# We want to do nice exit when running paraview to give paraview opportunity
# to clean up
unset FOAM_ABORT

unset regionName touchOpt

# reader extension
extension=OpenFOAM

# parse options
while [ "$#" -gt 0 ]
do
    case "$1" in
    -h | -help)
        usage
        ;;
    -block | -blockMesh)
        extension=blockMesh
        shift
        ;;
    -builtin)
        extension=foam
        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)
        touchOpt=true
        shift
        ;;
    -touchAll)
        touchOpt=all
        shift
        ;;
    *)
        usage "unknown option/argument: '$*'"
        ;;
    esac
done

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

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

case "${touchOpt:-false}" in
all)
    extension=OpenFOAM
    if [ -f constant/polyMesh/blockMeshDict ]
    then
        touch "$caseName.blockMesh"
        echo "created '$caseName.blockMesh'"
    fi
    touch "$caseName.$extension"
    echo "created '$caseName.$extension'"
    # discover probable regions
    for region in constant/*
    do
        if [ -d $region -a -d $region/polyMesh ]
        then
            regionName=${region##*/}
            touch "$caseName{$regionName}.$extension"
            echo "created '$caseName{$regionName}.$extension'"
        fi
    done
    exit 0
    ;;
true)
    touch "$caseFile"
    echo "created '$caseFile'"
    exit 0
    ;;
esac


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


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

builtin | 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
3* | git)
    # 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
#------------------------------------------------------------------------------