bin/freefoam-graphResKE.py.in

   1 #!@PYTHON_EXECUTABLE@
   2 #-------------------------------------------------------------------------------
   3 #               ______                _     ____          __  __
   4 #              |  ____|             _| |_  / __ \   /\   |  \/  |
   5 #              | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
   6 #              |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
   7 #              | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
   8 #              |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
   9 #
  10 #                   FreeFOAM: The Cross-Platform CFD Toolkit
  11 #
  12 # Copyright (C) 2008-2011 Michael Wild <themiwi@users.sf.net>
  13 #                         Gerber van der Graaf <gerber_graaf@users.sf.net>
  14 #-------------------------------------------------------------------------------
  15 # License
  16 #   This file is part of FreeFOAM.
  17 #
  18 #   FreeFOAM is free software; you can redistribute it and/or modify it
  19 #   under the terms of the GNU General Public License as published by the
  20 #   Free Software Foundation; either version 2 of the License, or (at your
  21 #   option) any later version.
  22 #
  23 #   FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
  24 #   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  25 #   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  26 #   for more details.
  27 #
  28 #   You should have received a copy of the GNU General Public License
  29 #   along with FreeFOAM; if not, write to the Free Software Foundation,
  30 #   Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  31 #
  32 # Script
  33 #     freefoam-graphResKE
  34 #
  35 # Description
  36 #     The utility extracts the residuals of the k and epsilon equations at each
  37 #     time step and writes them to 'residualKE.dat' in TecPlot format.
  38 #------------------------------------------------------------------------------
  39
  40 """Usage: freefoam@PY_SCRIPT_SUFFIX@ graphResKE [-h, -help] <logFile>
  41
  42 The utility extracts the residuals of the k and epsilon equations at each time
  43 step and writes them to 'residualKE.dat' in TecPlot format.
  44
  45 Options
  46 -------
  47 <logFile> The log file from which to extract the data.
  48 -h, -help Display this help message.
  49
  50 """
  51
  52 # want to be future proof
  53 from FreeFOAM.compat import *
  54
  55 import sys
  56 import os.path
  57 import re
  58
  59 if len(sys.argv[1:]) != 1:
  60    sys.stderr.write('Error: Require a log file as argument\n')
  61    sys.stderr.write(__doc__+'\n')
  62    sys.exit(1)
  63
  64 if sys.argv[1] == '-h' or sys.argv[1] == '-help':
  65    print(__doc__)
  66    sys.exit(0)
  67
  68 logFile = sys.argv[1]
  69 if not os.path.isfile(logFile):
  70    sys.stderr.write('Error: no such file')
  71    sys.exit(1)
  72
  73 # parse the residuals for k and epsilon from the log file
  74 regex = re.compile(r'Solving for (?P<var>k|epsilon),\s+.*Initial residual\s+=\s+(?P<res>\S+),')
  75 res = {'k':[], 'epsilon':[]}
  76 for l in open(logFile, 'rt'):
  77    m = regex.search(l)
  78    if m:
  79       res[m.group('var')].append(float(m.group('res')))
  80
  81 # write file header
  82 ngraphs = 0
  83 for v in res.itervalues():
  84    if len(v) > 0:
  85       ngraphs += 1
  86 outFile = open('residualKE.dat', 'wt')
  87 outFile.write("""Solver Performance
  88 number of iterations
  89 residual
  90 0 0
  91 0 0
  92 %d
  93 """%ngraphs)
  94
  95 # write data
  96 for n, r in res.iteritems():
  97    if len(r) > 0:
  98       outFile.write("""%s
  99 0
 100 %d
 101 """%(n, len(r)))
 102       for i, v in enumerate(r):
 103          outFile.write('%d  %g\n'%(i+1, v))
 104
 105 outFile.close()
 106
 107 # ------------------- vim: set sw=3 sts=3 ft=python et: ------------ end-of-file