OVERHIST and OVERPLOT USER'S GUIDE

Authors: William M. Chan, Steven M. Nash, Stuart E. Rogers and Shishir Pandya

Date: July, 2006.

OVERHIST is a program that offers the user a convenient way to extract desired flow coefficient, residual, minimum density/pressure data and animate/dynamics data from the OVERFLOW history files. The extracted data is written to a file to be used by a 2-D plotting package such as XMGRACE, GNUPLOT or others.

OVERPLOT is a graphical user's interface for plotting flow coefficients, residuals, minimum density/pressure data and animate/dynamics data from the OVERFLOW history files, and sectional Cp cuts from OVERFLOW grid and solution files. A convergence analysis table provides convergence information for a single curve plot. The user can select the following display options by clicking on buttons.


Force and Moment coefficients:
    X-axis : time step number or elapsed CPU time
    Y-axis : flow coefficients for components which include
             pressure, viscous, momentum flux and total force for
             X, Y, Z, lift, drag, side components; roll, pitch, yaw
             moments with separate contributions from pressure, viscous
             and momentum force; and mass flow rate.

Residuals:
    X-axis : time step number
    Y-axis : L-2 norm of the RHS
             L-infinity norm of the RHS
             L-2 norm of delta Q
             L-infinity norm of delta Q
             drop in log of L-2 norm of RHS for sub-iterations
             drop in log of L-infinity norm of RHS for sub-iterations
             drop in log of L-2 norm of delta Q for sub-iterations
             drop in log of L-infinity norm of delta Q for sub-iterations
             Log L-2 norm of RHS for subiterations
             Log Linf norm of RHS for subiterations
             Log L-2 norm of deltaQ for subiterations
             Log Linf norm of deltaQ for subiterations

Minimum density/pressure:
    X-axis : time step number
    Y-axis : minimum density
             minimum pressure
             minimum gamma
             number of reverse flow points
             number of supersonic points

Animate/dynamics:
    X-axis : time step number or physical time scaled by freestream speed
    Y-axis : component center of mass coordinates and velocity, Euler parameters,
             component angular velocity, force and moment acting on component
             (total, pressure, viscous, momentum)
     
    Three animate file formats are accepted:
     Format 1 : string in 1st line with 1 field; 1 int,  8 reals for all t
     Format 2 : string in 1st line with 1 field; 1 int, 27 reals for lines with t>=0.0
     Format 3 : string in 1st line with 4 fields (extensible format)

Sectional Cp:

Currently, GNUPLOT, XMGRACE/XMGR and XYPLOT are the only plotting packages
supported by OVERPLOT for 2-D plots. Options for other plotting packages
may be considered in the future.

The plot output can be directed to the screen, a PostScript file, or to
a 2-column ascii file.

OVERHIST and OVERPLOT are compatible with version 1.7g or later of OVERFLOW
and version 2.0y and later of OVERFLOW-2.

Convergence Analysis:

The convergence analysis table is currently applicable for data in a single
curve plot only. It provides information for the user to determine the
convergence characteristics of the variable plotted, e.g. min, max, average,
standard deviation and average slope over a range of time steps.

Installation
------------
  1. Compile overhist.F (Fortran 90) and put executable in path.
  2. Put overplot and 2-D plotting package (gnuplot/xmgrace) in path
  3. Make sure 'wish' is within your path. Type 'which wish' at the unix command prompt to verify this.
  4. Sectional Cp plots also requires `bltwish' within your path. See below for download and installation instructions.
Availability of Tcl/Tk and bltwish
-----------------------------------
Tcl/Tk is available on most workstations and on Cray machines. If you do not have it on your system, Tcl/Tk can be obtained from the following site:
http://dev.scriptics.com/software/tcltk/downloadnow84.html

BLT is available from

   http://www.sourceforge.net/projects/blt/files
Availability of xmgrace/xmgr
--------------------------
xmgrace and xmgr can be downloaded from
   http://plasma-gate.weizmann.ac.il/Grace/
   http://plasma-gate.weizmann.ac.il/Xmgr/
Usage
-----
overplot

or

overplot < flow_coef_history_filename >

or

overplot < resid_history_filename >

or

overplot < rpmin_history_filename >

or

overplot < animate_history_filename >

or

overplot < job_name >

Where job_name will be used to determine the fomoco, residual, rpmin, animate and OVERFLOW input files per the OVERFLOW file naming convention:

overplot test

will look for test.resid, test.fomoco, test.rpmin, test.animate, and test.*.inp for the residual, fomoco, rpmin, animate, and OVERFLOW input files respectively. Similarly, a job name of "bomb" will cause it to look for resid.bomb, fomoco.bomb, rpmin.bomb, and animate.bomb.

If the command line argument agrees with an existing filename, that file will be parsed to determine whether it is a fomoco, residual, rpmin, or animate history file (this assumes that the fomoco file starts with an ASCII string defining a component). If an OVERFLOW input file seems appropriate, it will be parsed for the grid names.

For the residual history plots, it should be noted that there are several ways to select the grids with the mouse:

OVERHIST is called automatically from within OVERPLOT. However, OVERHIST can also be run in stand-alone mode to extract the desired data. Input is prompted from the user interactively.


Input parameters for OVERHIST
-----------------------------

    NTYPE   = 1  fomoco history file (before OVERFLOW version 2.0y)
              2  residual history file
              3  minimum density/pressure history file
              4  animate/dynamics history file (format 1)
              5  animate/dynamics history file (format 2)
              6  animate/dynamics history file (format 3)
             11  extended fomoco history file (OVERFLOW version 2.0y and later)
    DAFILE  = filename of history file
    PLFILE  = filename of data file for plotting package
   
For NTYPE = 1:

       IPCK    = 1  use xyplot output format
               = 2  use gnuplot/xmgrace output format
       IXOP    = 1  use time step number on X-axis
               = 2  use elapsed CPU time on X-axis
       IYOP    = coefficient number to plot on Y-axis (1 - 28)
                 (see table below)
       ICMP    = component number to plot (1 - number of components)


   IYOP options
   ------------
   
    Number          Coefficients
   -----------------------------------------------
    1,2,3      X,Y,Z pressure force
    4,5,6      X,Y,Z viscous force
    7,8,9      X,Y,Z momentum force
   10,11,12    X,Y,Z total force
   13,14,15    lift,drag,side pressure force
   16,17,18    lift,drag,side viscous force
   19,20,21    lift,drag,side momentum force
   22,23,24    lift,drag,side total force
   25,26,27    roll (X),pitch (Y),yaw (Z) moment
   28          mass flow rate
   
  Additional options for NTYPE = 11:

   29,30,31    pressure contribution to X,Y,Z moment
   32,33,34    viscous contribution to X,Y,Z moment
   35,36,37    momentum contribution to X,Y,Z moment

For NTYPE = 2:

    IYOP    = type of residual to plot
              1 = L-2 norm of RHS
              2 = L-infinity norm of RHS
              3 = L-2 norm of delta Q
              4 = L-infinity norm of delta Q
              5 = drop in log of L-2 norm of RHS for sub-iterations
              6 = drop in log of L-infinity norm of RHS for sub-iterations
              7 = drop in log of L-2 norm of delta Q for sub-iterations
              8 = drop in log of L-infinity norm of delta Q for sub-iterations
              9 = Log L-2 norm of RHS for subiterations
             10 = Log Linf norm of RHS for subiterations
             11 = Log L-2 norm of deltaQ for subiterations
             12 = Log Linf norm of deltaQ for subiterations
    NCURVS  = number of grids to plot
    ICMP    = the NCURVS grid numbers 

For NTYPE = 3:

    IYOP    = data from minimum density/pressure file to plot
              1 = minimum density
              2 = minimum pressure
              3 = minimum gamma
              4 = number of reverse flow points
              5 = number of supersonic points

For NTYPE = 4/5/6:

       IXOP    = 1  use time step number on X-axis (not available for NTYPE=4/5)
               = 2  use physical time scaled by freestream speed on X-axis
       IYOP    = coefficient number to plot on Y-axis (see table below)
                 (depending on NTYPE, only some of the options are available;
                  IYOP=1,2,3,4,5,6,7 are always available)
       ICMP    = component number to plot (1 - number of components)


   IYOP options
   ------------
   
    Number          Variables
   -----------------------------------------------

    1/2/3      x/y/z-coordinate of center of mass
    4/5/6/7    Euler parameters 1/2/3/4
    8/9/10     u/v/w velocity components of center of mass
    11/12/13   angular velocity components (inertial frame)
    14/15/16   angular velocity components (body frame)
    21/22/23   total force components (inertial frame)
    24/25/26   total moment components (inertial frame)
    31/32/33   pressure force components (inertial frame)
    34/35/36   pressure moment components (inertial frame)
    41/42/43   viscous force components (inertial frame)
    44/45/46   viscous moment components (inertial frame)
    51/52/53   momentum force components (inertial frame)
    54/55/56   momentum moment components (inertial frame)
    61/62/63   applied force components (inertial frame)
    64/65/66   applied moment components (inertial frame)

Troubleshooting
---------------
If you get a 'wish: Not found' upon execution of overplot, it means that 'wish' is not within your path. Either modify your path, or change line 3 of the script to reflect this difference: exec /newpath/wish -f "$0" "$@"

If bltwish is in the user's path, the following environment variable may have to be set for overplot to show up properly:

setenv DISPLAY name_of_local_machine:0

Last modified: Tue July 04 15:45:00 2006