bin/foamLog

   1 #!/bin/sh
   2 #---------------------------------*- sh -*-------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 1991-2010 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 #     foamLog
  27 #
  28 # Description
  29 #     extracts info from log file
  30 #
  31 # Bugs
  32 #     -solution singularity not handled
  33 #------------------------------------------------------------------------------
  34
  35 PROGDIR=`dirname $0`
  36 PROGNAME=`basename $0`
  37
  38 if [ -r $HOME/.${PROGNAME}.db ]; then
  39     DBFILE=$HOME/.${PROGNAME}.db
  40 else
  41     DBFILE=$PROGDIR/$PROGNAME.db
  42 fi
  43
  44
  45 printUsage() {
  46 cat <<LABUSAGE
  47 $PROGNAME - extracts xy files from Foam logs.
  48
  49 Usage: $PROGNAME [-n][-s] <log>
  50            extracts xy files from log
  51        $PROGNAME -l <log>
  52            lists but does not extract
  53        $PROGNAME -h
  54            for a help message
  55
  56 LABUSAGE
  57 }
  58
  59
  60 printHelp() {
  61 printUsage
  62 cat <<LABHELP
  63 The default is to extract for all the 'Solved for' variables the
  64 initial residual, the final residual and the number of iterations. On
  65 top of this a (user editable) database of standard non-solved for
  66 variables is used to extract data like Courant number, execution time.
  67
  68 $PROGNAME -l shows all the possible variables but does not extract them.
  69
  70 The program will generate and run an awk script which writes a set of
  71 files, logs/<var>_<subIter>, for every <var> specified, for every
  72 occurrence inside a time step.
  73
  74 For variables that are 'Solved for' the initial residual name will
  75 be <var>, the final residual will get name <var>FinalRes,
  76
  77 The files are a simple xy format with the first column Time (default)
  78 and the second the extracted values. Option -n creates single column
  79 files with the extracted data only.
  80
  81
  82 The query database is a simple text format with three entries per line,
  83 separated with '/'. Column 1 is the name of the variable (cannot contain
  84 spaces), column 2 is the extended regular expression (egrep) to select
  85 the line and column 3 is the string (fgrep) to select the column inside the
  86 line. The value taken will be the first (non-space)word after this
  87 column. The database will either be \$HOME/.${PROGNAME}.db or if not
  88 found  $PROGDIR/${PROGNAME}.db.
  89
  90 Option -s suppresses the default information and only prints the extracted
  91 variables.
  92
  93 LABHELP
  94 }
  95
  96
  97
  98 myEcho() {
  99   if [ "$VERBOSE" ]; then
 100       echo "$*"
 101   fi
 102 }
 103
 104 # getSolvedVars logFile
 105 # Prints names of all 'solved for' variables in the log file.
 106 getSolvedVars() {
 107     fgrep ' Solving for ' $1 | fgrep ',' | sed -e 's/.* Solving for \([^,]*\)[,:].*/\1/' | sort -u
 108 }
 109
 110
 111 # getQueries dbFile queryName
 112 # Gets regular expressions for a certain queryName from the database
 113 getQueries() {
 114     if [ ! -f "$1" ]; then
 115         echo "Cannot find dbFile $1"
 116         exit 1
 117     fi
 118
 119     queryName=$2
 120
 121     LINEQ=`grep -v '^#' $1 | awk -F '/' "/$queryName/ {if (\"$queryName\" "'!= $1) next; print $2}'`
 122     NUMQ=`grep -v '^#' $1 | awk -F '/' "/$queryName/ {if (\"$queryName\" "'!= $1) next; print $3}'`
 123
 124     #echo "For $queryName found line selection /$LINEQ/ , column selection /$NUMQ/" 1>&2
 125     #if [ ! "$LINEQ" -o ! "$NUMQ" ]; then
 126     #    echo "Did not find query for $2 in database $1" 1>&2
 127     #fi
 128 }
 129
 130
 131 # getDbQueryList dbFile
 132 # Echoes list of possible queries
 133 getDbQueryList() {
 134     grep -v '^#' $1 | grep '[^ \t]' | awk -F '/' '{print $1}'
 135 }
 136
 137
 138 # getSolveQueryList logFile
 139 # Echoes list of queries from "solved for" variables in log file
 140 getSolveQueryList() {
 141     solvedVars=`getSolvedVars $1`
 142
 143     for var in $solvedVars
 144     do
 145         echo "${var}"
 146         echo "${var}FinalRes"
 147         echo "${var}Iters"
 148     done
 149 }
 150
 151 # getAllQueries dbFile logFile
 152 # Gets all queries from database and from logfile
 153 getAllQueries() {
 154     #-- All solved for queries from log file
 155     queries=`getSolveQueryList $2`
 156
 157     #-- Add ones from database, present in log file
 158     # Note: just like awk, line selected with regular expression,
 159     #       column with string.
 160     dbQueries=`getDbQueryList $1`
 161
 162     for var in $dbQueries
 163     do
 164         getQueries $1 "$var"
 165         line=`egrep "$LINEQ" $2`
 166         if [ "$line" ]; then
 167             column=`echo "$line" | fgrep "$NUMQ"`
 168             if [ "$column" ]; then
 169                 queries="$queries $var"
 170             fi
 171         fi
 172     done
 173
 174     for q in $queries
 175     do
 176         echo "$q"
 177     done | sort -u
 178 }
 179
 180 #-----------------------------
 181 # Main
 182 #-----------------------------
 183
 184 # sort arguments
 185 TIMENAME='Time'
 186 VERBOSE='yes'
 187 LISTONLY=''
 188
 189 while getopts nslh flags
 190 do
 191     case $flags in
 192         n)  TIMENAME=""
 193             ;;
 194         h)  printHelp
 195             exit 0
 196             ;;
 197         s)  VERBOSE=""
 198             ;;
 199         l)  LISTONLY='yes'
 200             ;;
 201             \?) printUsage
 202             exit 1
 203             ;;
 204     esac
 205 done
 206
 207
 208 # Shift options
 209 shift `expr $OPTIND - 1`
 210
 211 if [ ! -f $DBFILE ]; then
 212     echo "$PROGNAME: Cannot read database $DBFILE"
 213     exit 1
 214 fi
 215
 216 if [ "$LISTONLY" ]; then
 217     if [ $# -ne 1 ]; then
 218         printUsage
 219         exit 1
 220     fi
 221     LOG=$1;
 222     if [ ! -r $LOG ]; then
 223         echo "$PROGNAME: Cannot read log $LOG"
 224         exit 1
 225     fi
 226     getAllQueries $DBFILE $LOG
 227     exit 0
 228 fi
 229
 230 if [ $# -ne 1 ]; then
 231     printUsage
 232     exit 1
 233 fi
 234
 235 CASEDIR=.
 236 LOG=$1
 237 if [ ! -r $LOG ]; then
 238     echo "$PROGNAME: Cannot read log $LOG"
 239     exit 1
 240 fi
 241
 242 QUERYNAMES=`getAllQueries $DBFILE $LOG`
 243
 244
 245 if [ ! "$CASEDIR" ]; then
 246     printUsage
 247     exit 1
 248 fi
 249
 250 if [ ! -d "$CASEDIR" ]; then
 251     echo "$PROGNAME: Cannot read $CASEDIR"
 252     exit 1
 253 fi
 254
 255 if [ ! -f "$LOG" ]; then
 256     echo "$PROGNAME: Cannot read log file $LOG"
 257     exit 1
 258 fi
 259
 260
 261 #-- Make logs dir in case directory and put awk file there.
 262
 263 mkdir -p $CASEDIR/logs
 264 AWKFILE=$CASEDIR/logs/$PROGNAME.awk
 265
 266 myEcho "Using:"
 267 myEcho "  log      : $LOG"
 268 myEcho "  database : $DBFILE"
 269 myEcho "  awk file : $AWKFILE"
 270 myEcho "  files to : $CASEDIR/logs"
 271 myEcho ""
 272
 273
 274 #-----------------------------
 275 # Generate Awk program
 276 #-----------------------------
 277
 278
 279
 280 #-- header
 281
 282 rm -f $AWKFILE; touch $AWKFILE
 283 echo "BEGIN {" >> $AWKFILE
 284 echo "    Iteration=0" >> $AWKFILE
 285 echo "    resetCounters()" >> $AWKFILE
 286 echo "}" >> $AWKFILE
 287
 288 echo "" >> $AWKFILE
 289 echo "# reset counters used for variable postfix" >> $AWKFILE
 290 echo "function resetCounters() {" >> $AWKFILE
 291 for queryName in $QUERYNAMES
 292 do
 293     varName=${queryName}Cnt
 294     echo "    ${varName}=0" >> $AWKFILE
 295 done
 296 echo "    # Reset counters for general Solving for extraction" >> $AWKFILE
 297 echo "    for (varName in subIter)" >> $AWKFILE
 298 echo "    {" >> $AWKFILE
 299 echo "        subIter[varName]=0" >> $AWKFILE
 300 echo "    }" >> $AWKFILE
 301 echo "}" >> $AWKFILE
 302 echo "" >> $AWKFILE
 303
 304
 305 cat <<LABEL >> $AWKFILE
 306 # Extract value after columnSel
 307 function extract(inLine,columnSel,outVar,
 308                  a,b)
 309 {
 310     a=index(inLine, columnSel)
 311     b=length(columnSel)
 312     split(substr(inLine, a+b),outVar)
 313     gsub("[,:]","",outVar[1])
 314 }
 315
 316 LABEL
 317
 318
 319
 320
 321
 322 #-- Generate code for iteration separator (increments 'Iteration')
 323 getQueries $DBFILE 'Separator'
 324 cat <<LABSEP >> $AWKFILE
 325 #-- Iteration separator (increments 'Iteration')
 326 /$LINEQ/ {
 327     Iteration++
 328     resetCounters()
 329 }
 330
 331 LABSEP
 332
 333
 334 #-- Generate code for extracting Time
 335 getQueries $DBFILE 'Time'
 336 cat <<LABTIME >> $AWKFILE
 337 #-- Time extraction (sets 'Time')
 338 /$LINEQ/ {
 339     extract(\$0, "$NUMQ", val)
 340     Time=val[1]
 341 }
 342
 343 LABTIME
 344
 345
 346 #-- Generate code for singularity handling.
 347 cat <<LABSING >> $AWKFILE
 348 #-- Skip whole line with singularity variable
 349 /solution singularity/ {
 350     next;
 351 }
 352 LABSING
 353
 354
 355 #-- Generate code for extracting solved for quantities
 356 cat <<LABSOLVE >> $AWKFILE
 357 #-- Extraction of any solved for variable
 358 /Solving for/ {
 359     extract(\$0, "Solving for ", varNameVal)
 360
 361     varName=varNameVal[1]
 362     file=varName "_" subIter[varName]++
 363     file="$CASEDIR/logs/" file
 364     extract(\$0, "Initial residual = ", val)
 365     print $TIMENAME "\t" val[1] > file
 366
 367     varName=varNameVal[1] "FinalRes"
 368     file=varName "_" subIter[varName]++
 369     file="$CASEDIR/logs/" file
 370     extract(\$0, "Final residual = ", val)
 371     print $TIMENAME "\t" val[1] > file
 372
 373     varName=varNameVal[1] "Iters"
 374     file=varName "_" subIter[varName]++
 375     file="$CASEDIR/logs/" file
 376     extract(\$0, "No Iterations ", val)
 377     print $TIMENAME "\t" val[1] > file
 378 }
 379
 380 LABSOLVE
 381
 382 #-- generate code to process queries
 383 for queryName in $QUERYNAMES
 384 do
 385     getQueries $DBFILE $queryName
 386     if [ "$LINEQ" -a "$NUMQ" ]; then
 387         counter=${queryName}Cnt
 388
 389         echo "#-- Extraction of $queryName" >> $AWKFILE
 390         echo "/$LINEQ/ {" >> $AWKFILE
 391         echo "    extract(\$0, \"$NUMQ\", val)" >> $AWKFILE
 392         echo "    file=\"$CASEDIR/logs/${queryName}_\" ${counter}" >> $AWKFILE
 393         echo "    print $TIMENAME \"\\t\" val[1] > file" >> $AWKFILE
 394         echo "    ${counter}++" >> $AWKFILE
 395         echo "}" >> $AWKFILE
 396         echo "" >> $AWKFILE
 397     fi
 398 done
 399
 400
 401
 402 #-----------------------------
 403 # Run awk program on log
 404 #-----------------------------
 405 (
 406     cmd="awk -f $AWKFILE $LOG"
 407     myEcho "Executing: $cmd"
 408     $cmd
 409     myEcho ""
 410 )
 411
 412 #-----------------------------
 413 # Print found
 414 #-----------------------------
 415 myEcho "Generated XY files for:"
 416 getAllQueries $DBFILE $LOG
 417
 418 #------------------------------------------------------------------------------