bin/paraFoam

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
   7 #    \\/     M anipulation  |
   8 #-------------------------------------------------------------------------------
   9 # License
  10 #     This file is part of OpenFOAM.
  11 #
  12 #     OpenFOAM is free software: you can redistribute it and/or modify it
  13 #     under the terms of the GNU General Public License as published by
  14 #     the Free Software Foundation, either version 3 of the License, or
  15 #     (at your option) any later version.
  16 #
  17 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  18 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 #     for more details.
  21 #
  22 #     You should have received a copy of the GNU General Public License
  23 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25 # Script
  26 #     paraFoam
  27 #
  28 # Description
  29 #     start paraview with the OpenFOAM libraries
  30 #
  31 # Note
  32 #     combining -block or -builtin options with the -region option yields
  33 #     undefined behaviour
  34 #------------------------------------------------------------------------------
  35 usage() {
  36     exec 1>&2
  37     while [ "$#" -ge 1 ]; do echo "$1"; shift; done
  38     cat<<USAGE
  39
  40 Usage: ${0##*/} [OPTION] [PARAVIEW_OPTION]
  41 options:
  42   -block            use blockMesh reader  (uses .blockMesh extension)
  43   -builtin          use VTK builtin OpenFOAM reader  (uses .foam extension)
  44   -case <dir>       specify alternative case directory, default is the cwd
  45   -region <name>    specify alternative mesh region
  46   -touch            only create the file  (eg, .blockMesh, .OpenFOAM, etc)
  47   -touchAll         create .blockMesh, .OpenFOAM files (and for all regions)
  48   -help             print the usage
  49
  50
  51 paraview options start with a double dashes
  52
  53 * start paraview $ParaView_VERSION with the OpenFOAM libraries
  54
  55 USAGE
  56     exit 1
  57 }
  58
  59 # We want to do nice exit when running paraview to give paraview opportunity
  60 # to clean up
  61 unset FOAM_ABORT
  62
  63 unset regionName optTouch
  64
  65 # reader extension
  66 extension=OpenFOAM
  67
  68 # parse options
  69 while [ "$#" -gt 0 ]
  70 do
  71     case "$1" in
  72     -h | -help)
  73         usage
  74         ;;
  75     -block | -blockMesh)
  76         extension=blockMesh
  77         shift
  78         ;;
  79     -builtin)
  80         extension=foam
  81         shift
  82         ;;
  83     -case)
  84         [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
  85         cd "$2" 2>/dev/null || usage "directory does not exist:  '$2'"
  86         shift 2
  87         ;;
  88     -region)
  89         [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
  90         regionName=$2
  91         shift 2
  92         ;;
  93     -touch)
  94         optTouch=true
  95         shift
  96         ;;
  97     -touchAll)
  98         optTouch=all
  99         shift
 100         ;;
 101     --)
 102         shift
 103         break    # stop here, treat balance as paraview options
 104         ;;
 105     --*)
 106         break    # stop here, treat this and balance as paraview options
 107         ;;
 108     *)
 109         usage "unknown option/argument: '$*'"
 110         ;;
 111     esac
 112 done
 113
 114
 115 #
 116 # check for --data=... argument
 117 #
 118 hasDataArg()
 119 {
 120     hasData=false
 121     while [ "$#" -gt 0 ]
 122     do
 123         case "$1" in
 124         (--data=*)
 125             hasData=true
 126             break
 127             ;;
 128         esac
 129         shift
 130     done
 131 }
 132
 133 hasDataArg $@
 134
 135
 136 # get a sensible caseName from the directory name
 137 caseName=${PWD##*/}
 138 caseFile="$caseName.$extension"
 139 fvControls="system"
 140
 141 if [ -n "$regionName" ]
 142 then
 143     caseFile="$caseName{$regionName}.$extension"
 144     fvControls="$fvControls/$regionName"
 145 fi
 146
 147 case "${optTouch:-false}" in
 148 all)
 149     extension=OpenFOAM
 150     if [ -f constant/polyMesh/blockMeshDict ]
 151     then
 152         touch "$caseName.blockMesh"
 153         echo "created '$caseName.blockMesh'"
 154     fi
 155     touch "$caseName.$extension"
 156     echo "created '$caseName.$extension'"
 157     # discover probable regions
 158     for region in constant/*
 159     do
 160         if [ -d $region -a -d $region/polyMesh ]
 161         then
 162             regionName=${region##*/}
 163             touch "$caseName{$regionName}.$extension"
 164             echo "created '$caseName{$regionName}.$extension'"
 165         fi
 166     done
 167     exit 0
 168     ;;
 169 true)
 170     touch "$caseFile"
 171     echo "created '$caseFile'"
 172     exit 0
 173     ;;
 174 esac
 175
 176
 177 # parent directory for normal or parallel results
 178 case "$caseName" in
 179     processor*) parentDir=".." ;;
 180     *)          parentDir="."  ;;
 181 esac
 182
 183
 184 if [ "${hasData:-false}" = true ]
 185 then
 186
 187     # has --data=.., send directly to paraview
 188     exec paraview "$@"
 189
 190 else
 191
 192     # check existence of essential files
 193     warn="WARN file does not exist:"
 194     case $extension in
 195     blockMesh)
 196         for check in \
 197             system/controlDict \
 198             constant/polyMesh/blockMeshDict \
 199             ;
 200         do
 201             [ -s "$parentDir/$check" ] || {
 202                 [ -n "$warn" ] && echo "$warn" 1>&2
 203                 echo "    $parentDir/$check" 1>&2
 204                 unset warn
 205             }
 206         done
 207         ;;
 208
 209     builtin | OpenFOAM)
 210         for check in \
 211             system/controlDict \
 212             $fvControls/fvSchemes \
 213             $fvControls/fvSolution \
 214             ;
 215         do
 216             [ -s "$parentDir/$check" ] || {
 217                 [ -n "$warn" ] && echo "$warn" 1>&2
 218                 echo "    $parentDir/$check" 1>&2
 219                 unset warn
 220             }
 221         done
 222         ;;
 223     esac
 224
 225     # only create/remove caseFile if it didn't already exist
 226     [ -e $caseFile ] || {
 227         trap "rm -f $caseFile 2>/dev/null; exit 0" EXIT TERM INT
 228         touch "$caseFile"
 229         echo "created temporary '$caseFile'"
 230     }
 231
 232     # For now filter out any ld.so errors. Caused by non-system compiler?
 233     paraview --data="$caseFile" "$@" 2>&1 | fgrep -v 'Inconsistency detected by ld.so'
 234 fi
 235
 236
 237 #------------------------------------------------------------------------------