foamNewBC 5.89 KB
Newer Older
1
2
3
4
5
#!/bin/sh
#------------------------------------------------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
6
#   \\  /    A nd           | Copyright (C) 2015-2016 OpenFOAM Foundation
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#    \\/     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
#     foamNewBC
#
# Description
#     Create directory of source and compilation files for a new BC
#
#------------------------------------------------------------------------------
Script=${0##*/}
DIR="$FOAM_ETC/codeTemplates/BC"

usage() {
    while [ "$#" -ge 1 ]; do echo "$1"; shift; done
    cat<<USAGE
Usage: $Script [-h | -help] <base> <type> <boundaryConditionName>

* Create directory of source and compilation files for a new boundary condition
  <boundaryConditionName> (dir)
  - .C and .H source files
  - Make (dir)
    - files
    - options
  Compiles a library named lib<boundaryConditionName>.so in \$FOAM_USER_LIBBIN:
  $FOAM_USER_LIBBIN

<base> conditions:
-f | -fixedValue    | fixedValue
-m | -mixed         | mixed

<type> options:
-a | -all    | all  | template (creates a template class)
-s | -scalar | scalar
-v | -vector | vector
-t | -tensor | tensor
-symmTensor  | symmTensor
-sphericalTensor | sphericalTensor

USAGE
    exit 1
}

cap() {
    echo $1 | sed -e 's/^./\U&/'
}

# Implicitly covers a lone -help
[ "$#" -gt 1 ] || usage

case "$1" in
(-h | -help)
    usage
    ;;
(-f | -fixedValue | fixedValue)
    BASE=fixedValue
    ;;
(-m | -mixed | mixed )
    BASE=mixed
    ;;
(*)
    usage "Unknown <base> condition '$1'"
    ;;
esac
shift

case "$1" in
(-a | -all | all | template)
    TYPE=Type
    UNIT='VALUE-or-(VALUE 0 0)'
    ;;
(-s | -scalar | scalar)
    TYPE=scalar
    UNIT=VALUE
    ;;
(-v | -vector | vector)
    TYPE=vector
    UNIT='(VALUE 0 0)'
    ;;
(-t | -tensor | tensor)
    TYPE=tensor
    UNIT='(VALUE 0 0 0 0 0 0 0 0)'
    ;;
(-symmTensor | symmTensor)
    TYPE=symmTensor
    UNIT='(VALUE 0 0 0 0 0)'
    ;;
(-sphericalTensor | sphericalTensor)
    TYPE=sphericalTensor
    UNIT=VALUE
    ;;
(*)
    usage "Unknown <type> option '$1'"
    ;;
esac
shift
[ "$#" -eq 1 ] || usage "Wrong number of arguments"
NAME=$1

# Prevents over-writing of existing directory
[ -d $NAME ] && usage "$NAME directory already exists, aborting..."
echo "Creating $NAME directory" && mkdir $NAME

# Establish meta template files to copy
FILES=$(cd ${DIR} && ls *.*)
[ "$TYPE" = "Type" ] || FILES=$(cd ${DIR} && ls BC.[CH])

# Substitutions for meta-template files
FIELD="Field<${TYPE}>"
[ "$TYPE" = "Type" ] || FIELD=${TYPE}Field

FVPATCHF=fvPatch$(cap $FIELD)
CLASS=$NAME$(cap $FVPATCHF)
PARENT=$BASE$(cap $FVPATCHF)
CONSTRUCT=$(echo $CLASS | sed 's/<Type>//g')

# Create some example values for the Description
n=0
for N in $(echo "ZERO ONE TWO THREE FOUR")
do
   eval $(expr $N='$(echo $UNIT | sed "s#VALUE#$n#g")')
   n=$(( $n + 1 ))
done

# Make substitutions to meta-template files
for F in $FILES
do
    EXT=$(echo $F | sed "s#BC##")
    NEWFILE=${CONSTRUCT}${EXT}
    echo "   Adding file ${NEWFILE}..."

    # Adds readScalar function when TYPE = scalar
    sed -e "s#TYPE#${TYPE}#g" \
        -e "s#NAME#${NAME}#g" \
        -e "s#BASE#${BASE}#g" \
        -e "s#CONSTRUCT#${CONSTRUCT}#g" \
        -e "s#CLASS#${CLASS}#g" \
        -e "s#FIELD#${FIELD}#g" \
        -e "s#FVPATCHF#${FVPATCHF}#g" \
        -e "s#PARENT#${PARENT}#g" \
        -e "s#ZERO#${ZERO}#g" \
        -e "s#ONE#${ONE}#g" \
        -e "s#TWO#${TWO}#g" \
        -e "s#THREE#${THREE}#g" \
        -e "s#FOUR#${FOUR}#g" \
167
        -e 's/>>/>>/g' \
168
169
170
171
172
173
174
175
176
177
        ${DIR}/${F} > ${NAME}/${NEWFILE}

    case $BASE in
        fixedValue)
            # refValue(), refGrad(), valueFraction() removed
            # phip removed
            sed -i \
                -e '/refValue/d' \
                -e '/refGrad/d' \
                -e '/valueFraction/d' \
178
                -e '/const scalarField\& phip/,/);/d' \
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
                ${NAME}/${NEWFILE}
            ;;
        mixed)
            # evaluate() removed
            # operator== becomes refValue() =
            sed -i \
                -e '/evaluate/d' \
                -e 's/operator==/refValue() =/g' \
                ${NAME}/${NEWFILE}
            ;;
    esac

    case $TYPE in
        Type)
            # Build Macro removed (in ..Fields.C)
            sed -i -e '/Build Macro/,/^}/d' \
                ${NAME}/${NEWFILE}
            ;;
        *)
            # template<class Type> removed
            # this-> removed
            # .template functionTemplate<...> becomes functionTemplate<...>
            # template instantiation repository removed
            sed -i \
                -e '/^template<class Type>$/d' \
                -e 's/this->//g' \
                -e 's/\.template[\t ]*\([a-Z]\)/\.\1/g' \
                -e '/#ifdef NoRepository/,/\/\/ */d' \
                ${NAME}/${NEWFILE}
            ;;
    esac
done

echo "Creating Make subdirectory" && cp -r ${DIR}/Make ${NAME}
COMPILED=$(cd ${NAME} && ls -r1 *C | head -1) # ...Fields.C for template class
sed -i -e "s#NAME#${NAME}#g" -e "s#COMPILED.*#${COMPILED}#g" ${NAME}/Make/files

#------------------------------------------------------------------------------