next up previous index
Next: Write or plot intermediate Up: Output Previous: Output locations   Index

Write or plot computed quantities


\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

          | ..........|
QUANTity <             > 'short' 'long' [lexp] [hexp]  [excv]                &
          | ..........|

     [ref]                 (for output quantity TSEC)                        &

     [dur] SEC|MIN|HR|DAY  (for output quantities SETUP, HSIG, HRMS,
                            MVEL, MTKE and MSAL)                             &

     [depth]               (for output quantity HRUN)                        &

      |-> PROBLEMcoord |
     <                  >  (for directions and vectors, e.g. VDIR and VEL)
      |   FRAME        |

\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

With this command the user can influence


|...|    
< > the output parameters are the same as given in command BLOCK.  
|...|    
`short' user preferred short name of the output quantity (e.g. the name appearing in  
  the heading of a table written by SWASH). If this option is not used, SWASH  
  will use a realistic name.  
`long' long name of the output quantity (e.g. the name appearing in the heading of a  
  block output written by SWASH). If this option is not used, SWASH will use a  
  realistic name.  
[lexp] lowest expected value of the output quantity.  
[hexp] highest expected value of the output quantity; the highest expected value is  
  used by SWASH to determine the number of decimals in a table with heading.  
  So the QUANTITY command can be used in case the default number of decimals  
  in a table is unsatisfactory.  
[excv] in case there is no valid value (e.g. wave height in a dry point) this  
  exception value of the output quantity is written in a table or block output.  

The following data are accepted only in combination with some specific output quantities.

[ref] reference time used for the quantity TSEC.  
  Default value: starting time of the first computation, except in cases where  
  this is later than the time of the earliest input. In these cases, the time of  
  the earliest input is used.  
[dur] the time duration over which the wave parameters (e.g. wave height and  
  setup), mean current or mean turbulence quantities are computed. This  
  corresponds to the final stage of the simulation period, which should be  
  long enough to establish steady-state conditions. The corresponding unit  
  is indicated in the next option:  
  SEC unit seconds  
  MIN unit minutes  
  HR unit hours  
  DAY unit days  
[depth] the total depth (in m) where inundation takes place. This can be used to  
  compute the maximum runup height; see output quantity HRUN.  
PROBLEMCOORD - vector components are relative to the x - and y -axes of the problem  
  coordinate system:  
  $ \bullet$ directions are counterclockwise relative to the positive x -axis of the  
  problem coordinate system if Cartesian direction convention is used  
  (see command SET)  
  $ \bullet$ directions are relative to North (clockwise) if Nautical direction  
  convention is used (see command SET)  
FRAME If output is requested on sets created by command FRAME or automatically  
  (COMPGRID or BOTTGRID):  
  $ \bullet$ vector components are relative to the x - and y -axes of the frame  
  coordinate system  
  $ \bullet$ directions are counterclockwise relative to the positive x -axis of the  
  frame coordinate system if Cartesian direction convention is used  
  (see command SET)  
  $ \bullet$ directions are relative to North (clockwise) if Nautical direction  
  convention is used (see command SET)  

Examples:

QUANTITY Xp hexp=100. for simulations of lab. experiments  
QUANTITY WLEV VX excv=-9. to change the exception value for  
  water level and u -component  
QUANTITY HSIG SETUP dur 30 min to compute wave height and setup  
  by averaging surface elevation over  
  the last 30 minutes of the simulation.  
QUANTITY MVEL MSALK dur 1 hr to compute depth-averaged mean velocity  
  and mean salinity per layer by averaging  
  these quantities over the last 1 hour of  
  the simulation.  
QUANTITY HRUN depth 0.05 the inundation depth is set to 5 cm.  
QUANTITY VEL VDIR frame to obtain vector components and  
  direction with respect to the frame.  


\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

OUTPut OPTIons 'comment' (TABle [field]) (BLOck [ndec] [len])

\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

This command enables the user to influence the format of block and table output.


comment a comment character; is used in comment lines in the output  
  Default: comment = %  
field length of one data field in a table. Minimum is 8 and maximum is 16.  
  Default: field = 12  
ndec number of decimals in block (if appearing after keyword BLOCK).  
  Maximum is 9.  
  Default: ndec = 4  
len number of data on one line of block output. Maximum is 9999.  
  Default: len = 6  


\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

                 | -> HEADer   |
BLOck  'sname'  <               > 'fname' (LAYout [idla])
                 |    NOHEADer |

           | DEP       |
           |           |
           | BOTL      |
           |           |
           | WATL      |
           |           |
           | VMAG      |
           |           |
           | VDIR      |
           |           |
           | VEL       |
           |           |
           | VKSI      |
           |           |
           | VETA      |
           |           |
           | PRESS     |
           |           |
           | NHPRES    |
           |           |
           | QMAG      |
           |           |
           | QDIR      |
           |           |
           | DISCH     |
           |           |
           | QKSI      |
           |           |
           | QETA      |
           |           |
           | VORT      |
           |           |
           | WMAG      |
           |           |
           | WDIR      |
           |           |
           | WIND      |
           |           |
           | FRC       |
           |           |
           | USTAR     |
           |           |
           | UFRIC     |
           |           |
           | SAL       |
           |           |
           | TEMP      |
           |           |
           | SED       |
           |           |
           | HRUN      |
           |           |
           | BRKP      |
           |           |
           | SETUP     |
           |           |
           | HS        |
           |           |
           | HRMS      |
           |           |
           | MVMAG     |
           |           |
           | MVDIR     |
           |           |
           | MVEL      |
           |           |
           | MVKSI     |
           |           |
           | MVETA     |
           |           |
           | MSAL      |
           |           |
           | MTEMP     |
           |           |
           | MSED      |
           |           |                                          | -> Sec  |
     <    <  ZK         >  [unit] > (OUTput [tbegblk] [deltblk]) <     MIn   >
           |           |                                          |    HR   |
           | HK        |                                          |    DAy  |
           |           |
           | VMAGK     |
           |           |
           | VDIRK     |
           |           |
           | VELK      |
           |           |
           | VKSIK     |
           |           |
           | VETAK     |
           |           |
           | VZ        |
           |           |
           | VOMEGA    |
           |           |
           | SALK      |
           |           |
           | TEMPK     |
           |           |
           | SEDK      |
           |           |
           | TKE       |
           |           |
           | EPS       |
           |           |
           | VISC      |
           |           |
           | QMAGK     |
           |           |
           | QDIRK     |
           |           |
           | DISCHK    |
           |           |
           | QKSIK     |
           |           |
           | QETAK     |
           |           |
           | PRESSK    |
           |           |
           | NHPRSK    |
           |           |
           | MVMAGK    |
           |           |
           | MVDIRK    |
           |           |
           | MVELK     |
           |           |
           | MVKSIK    |
           |           |
           | MVETAK    |
           |           |
           | MSALK     |
           |           |
           | MTEMPK    |
           |           |
           | MSEDK     |
           |           |
           | MTKE      |
           |           |
           | MEPS      |
           |           |
           | MVISC     |
           |           |
           | TIME      |
           |           |
           | TSEC      |
           |           |
           | XP        |
           |           |
           | YP        |
           |           |
           | DIST      |

\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

With this optional command the user indicates that one or more spatial distributions should be written to a file.


'sname' name of frame or group (see commands FRAME or GROUP)  
HEADER with this option the user indicates that the output should be written to a file  
  with header lines. The text of the header indicates run identification (see  
  command PROJECT), time, frame name or group name ('sname'), variable and  
  unit. The number of header lines is 8.  
  Note: the numerical values in the file are in the units indicated in the header.  
NOHEADER with this option the user indicates that the output should be written to a file  
  without header lines.  
'fname' name of the data file where the output is to be written to. Default for option  
  HEADER is the PRINT file. In case of NOHEADER the filename is required. Note  
  that when the extension is `.mat', a binary MATLAB file will be generated  
  automatically. This file requires less space on your computer and can be loaded  
  in MATLAB much faster than an ASCII file. Also note that the output  
  parameters are stored as single precision. (Hence, use the Matlab command  
  double for conversion to double precision, if necessary.)  
LAY-OUT with this option the user can prescribe the lay-out of the output to file with  
  the value of [idla].  
[idla] see command READINP (options are: [idla]=1, 3, 4). Option 4 is recommended  
  for postprocessing by MATLAB, however, in case of a generated binary  
  MATLAB file option 3 is recommended.  
  Default: [idla] = 1  
DEPTH water depth (in m) (not the still water depth!).  
BOTLEV bottom level or still water depth (in m).  
  Output is in both active and non-active points.  
  Note: exception value for bottom levels must be given!  
  (See command INPGRID BOTTOM EXCEPTION).  
WATLEV water level or surface elevation (in m).  
  Output is in both active and non-active points.  
  Note: exception value for water levels must be given!  
  (See command INPGRID WLEVEL EXCEPTION).  
VMAG velocity magnitude (in m/s).  
VDIR velocity direction (in degrees; Cartesian or nautical; see command SET).  
VEL flow velocity (vector; in m/s).  
VKSI grid-oriented U-velocity (in m/s).  
VETA grid-oriented V-velocity (in m/s).  
PRESS pressure at bottom (in hPa).  
NHPRES normalised (by density) non-hydrostatic pressure at bottom (in m2/s2).  
QMAG magnitude of discharge per unit width (in m2/s).  
QDIR direction of discharge per unit width (in degrees; Cartesian or nautical).  
DISCH discharge per unit width (vector; in m2/s).  
QKSI grid-oriented U-discharge per unit width (in m2/s).  
QETA grid-oriented V-discharge per unit width (in m2/s).  
VORT vorticity or rotation of the fluid in depth-averaged flow (in 1/s).  
WMAG wind velocity at 10 m above sea level (in m/s).  
WDIR wind direction at 10 m above sea level (in degrees; Cartesian or nautical).  
WIND wind velocity at 10 m above sea level (vector; in m/s).  
FRC bottom friction coefficient (see command FRICTION).  
USTAR magnitude of friction velocity (in m/s).  
UFRIC friction velocity (vector; in m/s).  
SAL salinity (in ppt).  
TEMP temperature (oC).  
SED suspended sediment (in kg/m3).  
HRUN represents the maximum horizontal runup by masking inundated points  
  as 1 and non-inundated points as 0.  
BRKP represents area of wave breaking by masking breaking points as 1  
  and non-breaking points as 0.  
SETUP wave-induced setup (in m).  
HSIG significant wave height (in m; for definition, see Appendix A).  
HRMS RMS wave height (in m; for definition, see Appendix A).  
MVMAG time-averaged or mean velocity magnitude (in m/s).  
MVDIR time-averaged or mean velocity direction (in degrees; Cartesian or nautical;  
  see command SET).  
MVEL time-averaged or mean velocity (vector; in m/s).  
MVKSI time-averaged or mean grid-oriented U-velocity (in m/s).  
MVETA time-averaged or mean grid-oriented V-velocity (in m/s).  
MSAL time-averaged or mean salinity (in ppt).  
MTEMP time-averaged or mean temperature (oC).  
MSED time-averaged or mean suspended sediment (in kg/m3).  
ZK layer interface (in m).  
HK layer thickness (in m).  
VMAGK velocity magnitude per layer (in m/s).  
VDIRK velocity direction per layer (in degrees; Cartesian or nautical).  
VELK flow velocity per layer (vector; in m/s).  
VKSIK grid-oriented U-velocity per layer (in m/s).  
VETAK grid-oriented V-velocity per layer (in m/s).  
VZ velocity in z-direction (in m/s).  
VOMEGA vertical velocity relative to sigma plane (in m/s).  
SALK salinity per layer (in ppt).  
TEMPK temperature per layer (oC).  
SEDK suspended sediment per layer (in kg/m3).  
TKE turbulent kinetic energy per layer interface (in m2/s2).  
EPS dissipation rate of turbulent kinetic energy per layer interface (in m2/s3).  
VISC vertical eddy viscosity per layer interface (in m2/s).  
QMAGK magnitude of discharge per unit width per layer (in m2/s).  
QDIRK direction of discharge per unit width per layer (in degrees; Cartesian or nautical).  
DISCHK discharge per unit width per layer (vector; in m2/s).  
QKSIK grid-oriented U-discharge per unit width per layer (in m2/s).  
QETAK grid-oriented V-discharge per unit width per layer (in m2/s).  
PRESSK pressure per layer (in hPa).  
NHPRSK normalised (by density) non-hydrostatic pressure per layer (in m2/s2).  
MVMAGK time-averaged or mean velocity magnitude per layer (in m/s).  
MVDIRK time-averaged or mean velocity direction per layer (in degrees;  
  Cartesian or nautical; see command SET).  
MVELK time-averaged or mean velocity per layer (vector; in m/s).  
MVKSIK time-averaged or mean grid-oriented U-velocity per layer (in m/s).  
MVETAK time-averaged or mean grid-oriented V-velocity per layer (in m/s).  
MSALK time-averaged or mean salinity per layer (in ppt).  
MTEMPK time-averaged or mean temperature per layer (oC).  
MSEDK time-averaged or mean suspended sediment per layer (in kg/m3).  
MTKE time-averaged or mean turbulent kinetic energy per layer interface (in m2/s2).  
MEPS time-averaged or mean dissipation rate of turbulent kinetic energy per  
  layer interface (in m2/s3).  
MVISC time-averaged or mean vertical eddy viscosity per layer interface (in m2/s).  
TIME full date-time string as part of line used in TABLE only.  
TSEC time in seconds with respect to a reference time (see command QUANTITY).  
XP user instructs SWASH to write the x -coordinate in the problem coordinate system  
  of the output location.  
YP user instructs SWASH to write the y -coordinate in the problem coordinate system  
  of the output location.  
DIST if output has been requested along a curve (see command CURVE) then the distance  
  along the curve can be obtained with the command TABLE. DIST is the distance  
  along the curve measured from the first point on the curve to the output location  
  on the curve in meters (also in the case of spherical coordinates).  
[unit] this controls the scaling of output. The program divides computed values by [unit]  
  before writing to file, so the user should multiply the written value by [unit] to  
  obtain the proper value.  
  Default: if HEADER is selected, value is written as a 5 position integer.  
  SWASH takes [unit] such that the largest number occurring in the block  
  can be printed.  
  If NOHEADER is selected, values are printed in floating-point format, [unit] = 1.  
OUTPUT the user requests output at various times. If the user does not use this option, the  
  program will give BLOCK output for the last time step of the computation.  
[tbegblk] begin time of the first field of the variable, the format is:  
  1 : ISO-notation 19870530.153000  
  2 : (as in HP compiler) '30-May-87 15:30:00'  
  3 : (as in Lahey compiler) 05/30/87.15:30:00  
  4 : 15:30:00  
  5 : 87/05/30 15:30:00'  
  6 : as in WAM 8705301530  
  7 : 153000.000  
  This format is installation dependent. See Implementation Manual or ask the  
  person who installed SWASH on your computer. Default is option 7.  
[deltblk] time interval between fields, the unit is indicated in the next option:  
  SEC unit seconds  
  MIN unit minutes  
  HR unit hours  
  DAY unit days  

Notes:


\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

                 | -> HEADer   |
                 |             |
TABle  'sname'  <     NOHEADer  >  'fname'                                 &
                 |             |
                 |    SWASH    |

             | ...      |                                     | -> Sec  |
       <    <             >   > (OUTput [tbegtbl] [delttbl]  <     MIn   >)
             | ...      |                                     |    HR   |
                                                              |    DAy  |

\begin{picture}(18,0.12)
\thicklines
\put(0,0){\line(1,0){17}}
\put(0,0.1){\line(1,0){17}}
\end{picture}

With this optional command the user indicates that for each location of the output location set 'sname' (see commands POINTS, CURVE, FRAME or GROUP) one or more variables should be written to a file. The keywords HEADER and NOHEADER determine the appearance of the table; the filename determines the destination of the data.


'sname' name of the set of POINTS, CURVE, FRAME or GROUP  
HEADer output is written in fixed format to file with headers giving name of variable  
  and unit per column. A disadvantage of this option is that the data are written  
  in fixed format; numbers too large to be written will be shown as: ****.  
  Number of header lines is 4.  
NOHEADer output is written in floating point format to file and has no headers; it is  
  intended primarily for processing by other programs. With some spreadsheet  
  programs, however, the HEADER option works better.  
SWASH a table on file is produced with a special fixed format appropriate for  
  layer-dependent quantities. This file contains headers with useful  
  information for a correct interpretation of the data.  
'fname' name of the data file where the output is to be written to.  
  Default for option HEADER is output to the PRINT file.  
  In case of NOHEADER the filename is required.  
|...|    
< > the output parameters are the same as given in command BLOCK.  
|...|    
OUTPUT the user requests output at various times. If the user does not use this option,  
  the program will give TABLE output for the last time step of the computation.  
[tbegtbl] begin time of the first field of the variable, the format is:  
  1 : ISO-notation 19870530.153000  
  2 : (as in HP compiler) '30-May-87 15:30:00'  
  3 : (as in Lahey compiler) 05/30/87.15:30:00  
  4 : 15:30:00  
  5 : 87/05/30 15:30:00'  
  6 : as in WAM 8705301530  
  7 : 153000.000  
  This format is installation dependent. See Implementation Manual or ask the  
  person who installed SWASH on your computer. Default is option 7.  
[delttbl] time interval between fields, the unit is indicated in the next option:  
  SEC unit seconds  
  MIN unit minutes  
  HR unit hours  
  DAY unit days  

Notes:


next up previous index
Next: Write or plot intermediate Up: Output Previous: Output locations   Index
The SWASH team 2017-04-06