bin/paraFoam

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 1991-2009 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 the
  14 #     Free Software Foundation; either version 2 of the License, or (at your
  15 #     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, write to the Free Software Foundation,
  24 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  25 #
  26 # Script
  27 #     paraFoam
  28 #
  29 # Description
  30 #     start paraview with the OpenFOAM libraries
  31 #
  32 #------------------------------------------------------------------------------
  33 usage() {
  34     while [ "$#" -ge 1 ]; do echo "$1"; shift; done
  35     cat<<USAGE
  36
  37 usage: ${0##*/} [OPTION]
  38 options:
  39   -case   dir    specify alternative case directory
  40   -region name   specify mesh region name
  41   -touch         only create the .OpenFOAM file
  42
  43 * start paraview $ParaView_VERSION with the OpenFOAM libraries
  44
  45 USAGE
  46     exit 1
  47 }
  48
  49 unset regionName touchOnly
  50
  51 # We want to do nice exit when running paraview to give paraview opportunity
  52 # to clean up
  53 unset FOAM_ABORT
  54
  55 # parse options
  56 while [ "$#" -gt 0 ]
  57 do
  58     case "$1" in
  59     -h | -help)
  60         usage
  61         ;;
  62     -case)
  63         [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
  64         cd "$2" 2>/dev/null || usage "directory does not exist:  '$2'"
  65         shift 2
  66         ;;
  67     -region)
  68         [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
  69         regionName=$2
  70         shift 2
  71         ;;
  72     -touch)
  73         touchOnly=true
  74         shift
  75         ;;
  76     *)
  77         usage "unknown option/argument: '$*'"
  78         ;;
  79     esac
  80 done
  81
  82 # get a sensible caseName
  83 caseName=${PWD##*/}
  84 caseFile="$caseName.OpenFOAM"
  85 fvControls="system"
  86
  87 if [ -n "$regionName" ]
  88 then
  89     caseFile="$caseName{$regionName}.OpenFOAM"
  90     fvControls="$fvControls/$regionName"
  91 fi
  92
  93 if [ -n "$touchOnly" ]
  94 then
  95     touch "$caseFile"
  96     echo "created '$caseFile'"
  97     exit 0
  98 fi
  99
 100 # parent directory for normal or parallel results
 101 case "$caseName" in
 102     processor*) parentDir=".." ;;
 103     *)          parentDir="."  ;;
 104 esac
 105
 106 # check existence of essential files
 107 for check in system/controlDict $fvControls/fvSchemes $fvControls/fvSolution
 108 do
 109     [ -s "$parentDir/$check" ] || usage "file does not exist:  '$parentDir/$check'"
 110 done
 111
 112
 113 case "$ParaView_VERSION" in
 114 2*)
 115     trap "rm -f paraFoam.pvs $caseFile 2>/dev/null; exit 0" EXIT TERM INT
 116     touch "$caseFile"
 117
 118     # since we are now in the cwd, %CASE% is '$PWD/$caseFile'
 119     sed -e s@%CASE%@$PWD/$caseFile@g \
 120         $WM_PROJECT_DIR/bin/tools/paraFoam.pvs > paraFoam.pvs
 121
 122     paraview paraFoam.pvs
 123     ;;
 124
 125 *)
 126     # only create/remove caseFile if it didn't already exist
 127     [ -e $caseFile ] || {
 128         trap "rm -f $caseFile 2>/dev/null; exit 0" EXIT TERM INT
 129         touch "$caseFile"
 130         echo "created temporary '$caseFile'"
 131     }
 132
 133     paraview --data="$caseFile"
 134     ;;
 135
 136 esac
 137 #------------------------------------------------------------------------------