Merge branch 'upstream/OpenFOAM' into master
[freefoam.git] / data / shellFunctions / jobControlFunctions.in
blobcc63e147ef6e05218edc4d8b411d37154ff36517
1 #---------------------------------*- sh -*-------------------------------------
2 # =========                 |
3 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4 #  \\    /   O peration     |
5 #   \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6 #    \\/     M anipulation  |
7 #------------------------------------------------------------------------------
8 # License
9 #     This file is part of OpenFOAM.
11 #     OpenFOAM is free software; you can redistribute it and/or modify it
12 #     under the terms of the GNU General Public License as published by the
13 #     Free Software Foundation; either version 2 of the License, or (at your
14 #     option) any later version.
16 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19 #     for more details.
21 #     You should have received a copy of the GNU General Public License
22 #     along with OpenFOAM; if not, write to the Free Software Foundation,
23 #     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 # Script
26 #     JobControlFunction
28 # Description
29 #     Functions used by bin/foamJob and tutorials/Alltest.
31 #------------------------------------------------------------------------------
33 # getRawEntry dictionary entry
34 # Prints value of dictionary entry
35 getRawEntry() {
36     grep -v '^//' $1 | grep "^[ \t]*$2 " | sed -e "s/^[ \t]*$2 [ ]*//"
39 # getEntry dictionary entry
40 # Like getRawEntry but strips " and ending ';'
41 getEntry() {
42     getRawEntry $1 $2 | sed -e 's/^"//'  -e 's/;$//' -e 's/"$//'
45 # notEmpty directory
46 # Returns 0 if directory contains files/directories
47 notEmpty() {
48     if [ "`ls $1`" ]; then
49         return 0
50     else
51         return 1
52     fi
55 # findControlDict
56 # Finds the global controlDict file
57 findControlDict() {
58     if [ -n "$FREEFOAM_CONFIG_DIR" -a -f "$FREEFOAM_CONFIG_DIR/controlDict" ]; then
59         controlDict="$FREEFOAM_CONFIG_DIR/controlDict"
60     elif [ -f "$HOME/.FreeFOAM/@FF_VERSION_FULL@/controlDict" ]; then
61         controlDict="$HOME/.FreeFOAM/@FF_VERSION_FULL@/controlDict"
62     elif [ -f "$HOME/.FreeFOAM/controlDict" ]; then
63         controlDict="$HOME/.FreeFOAM/controlDict"
64     elif [ -f "@FF_CONFIG_DIR@/controlDict" ]; then
65         controlDict="@FF_CONFIG_DIR@/controlDict"
66     fi
67     if [ -z "$controlDict" ]; then
68         echo "Error: Failed to find the global controlDict" >&2
69         exit 1
70     fi
71     echo $controlDict
74 # ---------------------- vim: set ft=sh sw=4 sts=4 et: ------------ end-of-file