Skip navigation links
(Wind-US Documentation Home Page) (Wind-US User's Guide) (GMAN User's Guide) (MADCAP User's Guide) (CFPOST User's Guide) (Wind-US Utilities) (Common File User's Guide) (Wind-US Installation Guide) (Wind-US Developer's Reference) (Guidelines Documents)

(adf_revert) (cfaverage) (cfbeta) (cfcnvt) (cfcombine) (cflistnum) (cfpart) (cfreorder) (cfreset_iter) (cfspart) (cfsplit) (decompose) (fpro) (gpro) (jormak) (mpigetnzone) (recombine) (resplt.pl) (thplt) (tmptrn) (USintrpltQ) (windpar) ... (all utilities)

resplt.pl

resplt.pl is a Perl script that replaces the older Fortran version of resplt. Except for the "average mode" capability, resplt.pl has the same or greater capability as the older version. It is invoked automatically by the "resplt" command. The older Fortran version can be executed with the "resplt -exe" command.

resplt.pl may be used to extract residuals and/or integrated quantities from the list output (.lis) file created during a Wind-US run. A GENPLOT file is created for post-processing using CFPOST, containing the coordinates for curves of the selected quantities vs. iteration number, cycle, or time level, depending on the quantity selected. This is extremely useful in monitoring convergence of the solution during a Wind-US run.

To run resplt.pl, simply issue the command resplt.pl. Command-line options may be used to specify some or all of the necessary input. If the -batch option is specified, all input must be specified via command-line options; otherwise, the user is prompted interactively. It should be noted that some features of resplt.pl are only available using command-line options, while others are only available in interactive mode.

Interactive Mode

After issuing the resplt.pl command, the user is prompted for the full name of the .lis file, unless it was specified on the command line. The following menu will then appear:

   Exit                 0
   Select Plane(s)     90
   Select Zone(s)      91
   Select Frequency    92
   Select Summing mode 97
   Select Direction    98
   Select Average mode 99
   Confined Outflow             Bleed        Region
     Mass Flow Ratio   15         Plenum p      71
     Back Pressure     16         Plenum mdot   72
     Average p0        93       Angle of Attack 73
   Residuals     Big   L2       Integ. Planes Zone Grand Sum
     NS            1    2         Force    11    5    8   28
     k-e           3    4         Lift     17   18   19   29
     B-B          20   21         Moment   12    6    9
     S-A          22   23         Aer Mmnt 63   64   65
     SST          24   25         Momentum 13    7   10
     P-W          35   36         Mass     14   26
   NEWTON NS      51   52         Heat Flx 54   55
   Convergence   Zone Global    Adjoint  Zone Grand
     Force        61   62         ADM      67   68
   Optional Var  Zone Global      TLM      69   70
     Value        56   57

To choose a specific option, enter the corresponding number at the "Enter Selection" prompt. Note that the data being requested must be consistent with the data that was written into the .lis file during the Wind-US run, as controlled by the keywords LOADS, MASS FLOW, etc.

The various options from the resplt.pl menu are described below.

    Exit   Create the GENPLOT file based on the specified options, and exit resplt.pl.
 
Select Plane(s) Extract integrated data only for selected "planes". The "planes" are actually the surfaces and/or subsets specified using the SURFACE and SUBSET keywords in the LOADS keyword block. When used, this option must be specified before choosing the particular integrated data to be extracted (i.e., from the Planes column of the Integ. section). You'll be prompted for the desired plane numbers. Multiple planes and/or a range of planes may be specified using syntax like "2,3,6-8". The default is all planes.

Planes are numbered in the order specified in the Wind-US input data (.dat) file, and are "global", not "zonal". Thus, the Select Zone(s) menu option does not apply.

For example, imagine a five-zone grid with two SURFACE keywords specified in the LOADS block for each zone, in order. In resplt.pl, specifying zone 3 with Select Zone(s), then planes 1-2 with Select Plane(s), will result in the integrated values for the two surfaces in zone 1 being written into the GENPLOT file, not the two surfaces in zone 3. To write the values for the two surfaces in zone 3 into the GENPLOT file, specify planes 5-6 using Select Plane(s).

 
Select Zone(s) Extract data only for selected zones. When used, this option must be specified before choosing the particular data to be extracted. You'll be prompted for the desired zone numbers. Multiple zones and/or a range of zones may be specified using syntax like "2,3,6-8". The default is all zones.
 
Select Frequency Frequency for extracting data. When used, this option must be specified before choosing the particular data to be extracted. You'll be prompted for the desired frequency. For a frequency value of n, every n'th value found in the .lis file, starting with the first value, will be extracted. I.e., if n = 10, values 1, 11, 21, etc., will be extracted. The default is 1 (i.e., all values are extracted).
 
Select Summing mode Toggle switch for turning summing mode on and off. When used, this option must be specified before choosing the particular data to be summed or not summed. Values of an extracted residual or quantity for the selected planes, zones, or bleed regions will be summed, and a single curve will be written into the GENPLOT file, rather than separate curves for each plane, zone, or bleed region. The default is off.
 
Select Direction Direction of forces, moments, or momentum fluxes to be extracted. When used, this option must be specified before choosing the particular data to be extracted. You'll be prompted for the desired direction. The valid responses, all of which are case-insensitive, are described below. Note that not all of these are applicable to all the quantities that may be extracted. The default is to extract values for all applicable directions.

    X, Y, Z   Forces, moments, or momentum fluxes in the Cartesian x, y, or z direction (applicable to Force, Moment, and Momentum in the Integ. section of the resplt.pl menu)
Drag, Lift, Side Drag, lift, or side forces (applicable to Lift in the Integ. section)
Roll, Yaw, Pitch Roll, yaw, or pitch moments (applicable to Aer Mmnt in the Integ. section). When Roll, Yaw, or Pitch is specified as a direction, resplt.pl actually extracts the x, y, or z moment, respectively, and takes the negative.
2d, symm Only extract 2-D (i.e., symmetric) loads. For Force and Momentum, only the x and y components are extracted; for Moment, only the z component is extracted.

If the specified direction is inconsistent with the integrated quantities to be extracted (e.g., if Drag is specified as the direction, but Force is specified from the Integ. section instead of Lift), resplt.pl will try to recover by automatically redefining the direction as indicated in the following table.

    Specified Direction   Integ. Choice   Direction Redefinition
X, Y, or Z Lift X -> Drag, Y -> Lift, Z -> Side
X, Y, or Z Aer Mmnt X -> Roll, Y -> Yaw, Z -> Pitch
Drag, Lift, or Side Force or Aer Mmnt Drag -> X, Lift -> Y, Side -> Z
Roll, Yaw, or Pitch Force or Lift Roll -> X, Yaw -> Y, Pitch -> Z
 
Select Average mode Not yet implemented.
 
Confined Outflow The options in this section of the resplt.pl menu allow extraction of various quantities related to boundary conditions at an outflow boundary (formerly called "confined outflow").

If the MASS FLOW keyword was used in the Wind-US run to specify the mass flow at an outflow boundary, the ratio of the computed mass flow to the desired mass flow (Mass Flow Ratio), and the resulting back pressure (Back Pressure), may be extracted. Note that when the DIRECT option is used with the MASS FLOW keyword, the pressure at the boundary isn't spatially-constant; in this case the pressure that's extracted will be the pressure at the first boundary point.

For any of the outflow boundary conditions (i.e., COMPRESSOR FACE, DOWNSTREAM MACH, DOWNSTREAM PRESSURE, MASS FLOW, and OUTFLOW NON-REFLECTING), if TEST option 123 was specified, the ratio of the average total pressure at the boundary to the freestream value (Average p0) may be extracted.

For these quantities, the abscissa written into the GENPLOT file is simply an integer, starting at zero, that corresponds to the order of the data in the .lis file, not the iteration or cycle number. The -start and -stop command-line options don't apply.

 
Residuals The options in this section allow extraction of the log of the residuals for the various equation sets as a function of iteration number. The maximum residual (the column labeled Big) and the maximum L2 norm of the residual (L2) may be extracted for the mean flow Navier-Stokes and chemistry equations (NS), and for the equations in the k-ε (k-e), Baldwin-Barth (B-B), Spalart-Allmaras (S-A), SST (SST), and pointwise (P-W) turbulence models.
 
NEWTON NS For cases run using Newton iteration, with the same time step size in all zones, NEWTON NS may be used to extract the log of the maximum residual, and the log of the maximum L2 norm of the residual, as a function of time level for any equation group in all zones.
 
Convergence If CONVERGE LOAD was used in the Wind-US run, the change in the zonal and global forces and moments over a cycle, in the Cartesian x, y, and z directions, may be extracted as a function of cycle number. Pressure and viscous forces and moments are summed, not extracted separately. The values are expressed as a percentage of the maximum force or moment value in all the zones.
 
Optional Var Not yet implemented.
 
Bleed Not applicable to Wind-US.
 
Angle of Attack Extract the angle of attack history as a function of cycle number, written to the .lis file when the FIXED_CL keyword is used in a Wind-US run.
 
Integ. The options in this section allow extraction of integrated data specified using the LOADS keyword block in a Wind-US run, as follows:

    Force   Pressure and viscous forces in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include FORCE, plus VISCOUS if viscous forces are desired. Pressure and viscous forces are extracted separately, not summed.
Lift Pressure and viscous drag, lift, and side forces. In the LOADS block, the surface/subset specification must include FORCE, plus VISCOUS if viscous forces are desired, and LIFT or DRAG must be specified with the PRINT keyword. Pressure and viscous forces are extracted separately, not summed.
Moment Pressure and viscous moments in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MOMENT, plus VISCOUS if viscous moments are desired. Pressure and viscous moments are extracted separately, not summed.
Aer Mmnt Aerodynamic pressure and viscous moments (i.e., roll, yaw, and pitch). In the LOADS block, the surface/subset specification must include MOMENT, plus VISCOUS if viscous moments are desired. (For roll, yaw, and pitch, resplt.pl actually extracts the x, y, and z moment, respectively, and takes the negative.)
Momentum Momentum in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MOMENTUM.
Mass Mass flux in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MASS.
Heat Flx Heat flux. In the LOADS block, the surface/subset specification must include HEAT.

The extracted values may be the integrated values over the selected surfaces or subsets (the column labeled Planes), the totals for the selected zones (Zone), or the global totals over all the zones (Grand). The menu choices in the Planes, Zone, and Grand columns correspond to the data written into the .lis file when the PLANES, ZONES, and TOTALS options, respectively, are used with the PRINT keyword in the LOADS block.

The choices in the Sum column apply only to integrated loads computed when CONVERGE LOAD is used in a Wind-US run. For Force, the Sum value corresponds to the global sum (i.e., over all the zones) of both forces and moments in the Cartesian x, y, and z directions. For Lift, it corresponds to the global sum of the drag, lift, and side forces. Pressure and viscous forces and moments are summed, not extracted separately.

For Lift, the Sum choice (unlike Planes, Zone, and Grand), does not require that LIFT or DRAG be specified with the PRINT keyword in the LOADS block. In fact, the opposite is true; LIFT and DRAG must not be specified with the PRINT keyword. The directions for the drag, lift, and side forces are determined by the angles of attack and yaw specified with the FREESTREAM keyword.

For the menu choices in the Planes and Zone columns, the values are written into the GENPLOT file as a function of iteration number. For the Grand and Sum columns, the values are written as a function of cycle number.

 
Adjoint Not applicable to Wind-US.

Command-Line Options

The command-line options for resplt.pl are listed in the following subsections. Multiple names for the same option are separated by a vertical bar (|). Optional arguments are enclosed in brackets, with a vertical bar used to separate choices (e.g., [arg1|arg2]). There are additional options to resplt.pl that are either not yet fully implemented, or don't apply to Wind-US, and thus are not listed here.

General

The following options apply to the use of resplt.pl as a whole.

    -help|h|?   Display usage information and quit, ignoring any other options.
 
-batch|b Run in batch mode, with all input specified via command-line options. The default is to run in interactive mode.
 
-list file Name of the list output (.lis) file, including the .lis extension.
 
-gen file Name of the GENPLOT file to be created (or extended; see -reuse), including the .gen extension.
 
-multiy|multi When there are multiple curves on a plot (e.g., L2 residuals in multiple zones), create a GENPLOT file with multiple sets of y values vs. a single set of x values (i.e., Format 2). The default is to create a GENPLOT file with multiple sets of y vs. x values (Format 1).
 
-reuse|r Append to an existing GENPLOT file, specified using the -gen option, when extracting data from a .lis file that has grown after a restarted Wind-US calculation. When using this option, you must either: (1) use the same options, in the same order, that were used with resplt.pl to create the existing GENPLOT file; or (2) not use any options defining what's to be extracted, and let resplt.pl attempt to determine it automatically from the contents of the existing GENPLOT file. This option is ignored if the specified GENPLOT file doesn't exist.
 
-statistics|stat Write statistical summary to standard output.

Selections

These options may be used to limit the amount of data to be extracted by selecting specific surfaces/subsets, zones, directions, etc.

    -plane list   Extract integrated data only for the listed "planes". The "planes" are actually the surfaces and/or subsets specified using the SURFACE and SUBSET keywords in the LOADS keyword block. Multiple planes and/or a range of planes may be specified using syntax like "2,3,6-8". The default is all planes.

Planes are numbered in the order specified in the Wind-US input data (.dat) file, and are "global", not "zonal". Thus, the -zone option does not apply. See Select Plane(s) in the "Interactive Mode" section for an example.

 
-zone list Extract integrated data only for the listed zones. Multiple zones and/or a range of zones may be specified using syntax like "2,3,6-8". The default is all zones.
 
-start n Iteration or cycle number to begin extracting data. For the loads (i.e., the integrated quantities in the Integ. section of the resplt.pl menu, or in the Loads section below), the value n corresponds to the variable used for the abscissa in the GENPLOT file. I.e., n is an iteration number for plane and zone, and a cycle number for grand and sum. However, for the residuals n is a cycle number, even though the abscissa in the GENPLOT file is iterations. The default for n is the first value in the .lis file.
 
-stop n Iteration or cycle number to stop extracting data. See the -start option for details. The default is the last value in the .lis file.
 
-skip n Frequency for extracting data. Every n'th value found in the .lis file, starting with the first value (assuming -start isn't used), will be extracted. I.e., if n = 10, values 1, 11, 21, etc., will be extracted. The default is 1 (i.e., all values are extracted).
 
-sum Turn summing mode on. Values of an extracted residual or quantity for the selected planes, zones, or bleed regions will be summed, and a single curve will be written into the GENPLOT file, rather than separate curves for each plane, zone, or bleed region. The default is off.
 
-direction|dir direction Direction of forces, moments, or momentum fluxes to be extracted. The valid values for direction, all of which are case-insensitive, are described below. Note that not all of these are applicable to all the quantities that may be extracted. Note also that to extract 2-D (i.e., symmetric) loads, the command-line option -symm is used; thus, unlike in interactive mode, 2d and symm are not valid values for direction. The default is to extract values for all applicable directions.

    X, Y, Z   Forces, moments, or momentum fluxes in the Cartesian x, y, or z direction (applicable to the -force, -moment, and -momentum options)
Drag, Lift, Side Drag, lift, or side forces (applicable to the -lift option)
Roll, Yaw, Pitch Roll, yaw, or pitch moments (applicable to the -aeromom option). When Roll, Yaw, or Pitch is specified as a direction, resplt.pl actually extracts the x, y, or z moment, respectively, and takes the negative.

If the specified direction is inconsistent with the integrated quantities to be extracted (e.g., if Drag is specified as the direction, but the -force option is used instead of -lift to specify the integrated quantity), resplt.pl will try to recover by automatically redefining the direction. See Select Direction in the "Interactive Mode" section for details.

 
-symm|symmetric Only extract 2-D (i.e., symmetric) loads. For -force and -momentum, only the x and y components are extracted; for -moment, only the z component is extracted. The -direction option does not apply.

Confined Outflow

The following options allow extraction of various quantities related to boundary conditions at an outflow boundary.

    -mfr   For outflow boundaries where the MASS FLOW keyword was used in the Wind-US run, extract the ratio of the computed mass flow to the desired mass flow.
 
-backp For outflow boundaries where the MASS FLOW keyword was used in the Wind-US run, extract the back pressure. Note that when the DIRECT option is used with the MASS FLOW keyword, the pressure at the boundary isn't spatially-constant; in this case the pressure that's extracted will be the pressure at the first boundary point.
 
-avgp0 For boundaries with any outflow boundary conditions (i.e., COMPRESSOR FACE, DOWNSTREAM MACH, DOWNSTREAM PRESSURE, MASS FLOW, and OUTFLOW NON-REFLECTING), extract the ratio of the average total pressure at the boundary to the freestream value. This option requires that TEST option 123 be specified in the Wind-US run.

For these quantities, the abscissa written into the GENPLOT file is simply an integer, starting at zero, that corresponds to the order of the data in the .lis file, not the iteration or cycle number. The -start and -stop command-line options don't apply.

Residuals

The following options allow extraction of the log of the residuals for the various equation sets.

    -ns [big|l2]   Extract the maximum residual (big) or the maximum L2 norm of the residual (l2) for the mean flow Navier-Stokes and chemistry equations. The default is big.
 
-ke [big|l2] Extract the maximum residual (big) or the maximum L2 norm of the residual (l2) for the k-ε turbulence model equations. The default is big.
 
-bb [big|l2] Extract the maximum residual (big) or the L2 norm of the residual (l2) for the Baldwin-Barth turbulence model equation. The default is big.
 
-sa [big|l2] Extract the maximum residual (big) or the L2 norm of the residual (l2) for the Spalart-Allmaras turbulence model equation. The default is big.
 
-sst [big|l2] Extract the maximum residual (big) or the maximum L2 norm of the residual (l2) for the SST turbulence model equations. The default is big.
 
-pw [big|l2] Extract the maximum residual (big) or the L2 norm of the residual (l2) for the pointwise turbulence model equation. The default is big.
 
-newton [big|l2] For cases run using Newton iteration, with the same time step size in all zones, extract the maximum residual (big) or the maximum L2 norm of the residual (l2) for any equation group in all zones. The default is big.

With the -newton option, the residuals are written into the GENPLOT file as a function of time level. With the others, they're a function of iteration number.

Angle of Attack

This option only applies when the FIXED_CL keyword is used in a Wind-US run.

    -alpha   Extract the angle of attack history as a function of cycle number.

Loads

The options in this section allow extraction of integrated data specified using the LOADS keyword block in a Wind-US run.

    -force [plane|zone|grand|sum]   Extract forces in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include FORCE, plus VISCOUS if viscous forces are desired. Pressure and viscous forces are extracted separately, not summed. The default argument is grand.
 
-lift [plane|zone|grand|sum] Extract drag, lift, and side forces. In the LOADS block, the surface/subset specification must include FORCE, plus VISCOUS if viscous forces are desired, and LIFT or DRAG must be specified with the PRINT keyword. Pressure and viscous forces are extracted separately, not summed. The default argument is grand.
 
-moment [plane|zone|grand] Extract moments in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MOMENT, plus VISCOUS if viscous moments are desired. Pressure and viscous moments are extracted separately, not summed. The default argument is grand.
 
-aeromom|pitch [plane|zone|grand] Extract aerodynamic pressure and viscous moments (i.e., roll, yaw, and pitch). In the LOADS block, the surface/subset specification must include MOMENT, plus VISCOUS if viscous moments are desired. (For roll, yaw, and pitch, resplt.pl actually extracts the x, y, and z moment, respectively, and takes the negative.) The default argument is grand.
 
-momentum [plane|zone|grand] Extract momentum in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MOMENTUM. The default argument is grand.
 
-mass [plane|zone] Extract mass flux in the Cartesian x, y, and z directions. In the LOADS block, the surface/subset specification must include MASS. The default argument is plane.
 
-heatflux|hflux [plane|zone] Extract heat flux. In the LOADS block, the surface/subset specification must include HEAT. The default argument is plane.
 
-noflip When -lift is specified, extract the side force values from the .lis file without changing the sign. The default is to extract the negative of the values in the file.
 
-nopressure|nopress For forces and moments, only extract the viscous values. The default is to extract both pressure and viscous values.
 
-noviscous|novisc For forces and moments, only extract the pressure values. The default is to extract both pressure and viscous values.

When specifying the integrated values to be extracted, the argument plane, zone, grand, or sum determines the region, or scope, of the integration, as described below.

    plane   Extract values for the surfaces or subsets specified using the -plane option. This corresponds to the data written into the .lis file when the PLANES option is used with the PRINT keyword in the LOADS block.
 
zone Extract total values for the zones specified using the -zone option. This corresponds to the data written into the .lis file when the ZONES option is used with the PRINT keyword in the LOADS block.
 
grand Extract global total values over all the zones. This corresponds to the data written into the .lis file when the TOTALS option is used with the PRINT keyword in the LOADS block.
 
sum This applies only to integrated loads computed when CONVERGE LOAD is used in a Wind-US run. For the -force option, the global sum (i.e., over all the zones) of both forces and moments in the Cartesian x, y, and z directions will be extracted. For the -lift option, the global sum of the drag, lift, and side forces will be extracted. Pressure and viscous forces and moments are summed, not extracted separately.

For the -lift option, using sum (unlike using plane, zone, or grand), does not require that LIFT or DRAG be specified with the PRINT keyword in the LOADS block. In fact, the opposite is true; LIFT and DRAG must not be specified with the PRINT keyword. The directions for the drag, lift, and side forces are determined by the angles of attack and yaw specified with the FREESTREAM keyword.

For plane and zone, the values are written into the GENPLOT file as a function of iteration number. For grand and sum, the values are written as a function of cycle number.


Last updated 26 Aug 2015