next up previous index
Next: Model description Up: Description of commands Previous: Command syntax and input   Index


Start-up


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

PROJect 'name' 'nr'

        'title1'

        'title2'

        'title3'

\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 required command the user defines a number of strings to identify the SWASH run (project name e.g., an engineering project) in the print and plot file.

'name' is the name of the project, at most 16 characters long.  
  Default: blanks  
'nr' is the run identification (to be provided as a character string; e.g. the run  
  number) to distinguish this run among other runs for the same project; it is at  
  most 4 characters long. It is the only required information in this command.  
'title1' is a string of at most 72 characters provided by the user to appear in the  
  output of the program for the user's convenience.  
  Default: blanks  
'title2' same as 'title1'.  
'title3' same as 'title1'.  


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

SET [level] [nor] [depmin] [maxmes] [maxerr] [seed]                        &
    [grav] [rhowat] [temp] [salinity] [dynvis] [rhoair] [rhosed]           &
    [cdcap] [prmean] [backvisc] [kappa]                                    &

               |    NAUTical  |
    CORIolis  <                > [printf] [prtest] [outlev]
               | -> CARTesian |

\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 assigns values to various general parameters.

[level] still water level (in m).  
  Default: [level]=0.  
[nor] direction of North with respect to the x -axis (measured counterclockwise);  
  default [nor]= 90 o, i.e. x -axis of the problem coordinate system  
  points East.  
  When spherical coordinates are used (see command COORD) the value  
  of [nor] may not be modified.  
[depmin] threshold water depth (in m). Any grid point with water depth smaller than  
  [depmin] is taken out of the computation.  
  Default: [depmin] = 0.00005  
[maxmes] maximum number of error messages (not necessarily the number of errors!)  
  during the computation at which the computation is terminated. During the  
  computational process messages are written to the PRINT file.  
  Default: [maxmes] = 200  
[maxerr] during pre-processing SWASH checks input data. Depending on the severity  
  of the errors encountered during this pre-processing, SWASH does not start  
  computations. The user can influence the error level above which SWASH will  
  not start computations (at the level indicated the computations will continue).  
  The error level [maxerr] is coded as follows:  
  1 : warnings,  
  2 : errors (possibly automatically repaired or repairable by SWASH),  
  3 : severe errors.  
  Default: [maxerr] = 1  
[seed] is the seed of the random number generator used to select phase angles  
  for the different Fourier components. By selecting different seeds different  
  time series can be obtained from the same wave spectrum (see command  
  BOUNDCOND).  
  Default: [seed] = 12345678.  
[grav] is the gravitational acceleration (in m/s2).  
  Default: [grav] = 9.81  
[rhowat] is the density of water (in kg/m3).  
  Default: [rhowat] = 1000.  
  Note: this is usually the reference density. The actual density depends on  
  the temperature and salinity of water.  
[temp] is the (ambient) temperature of water (in oC).  
  Default: [temp] = 14.  
[salinity] is the (ambient) salinity of water (in ppt).  
  Default: [salinity] = 31.  
[dynvis] is the dynamical viscosity of water (in kg/ms).  
  Default: [dynvis] = 0.001  
[rhoair] is the density of air (in kg/m3).  
  Default: [rhoair] = 1.205  
[rhosed] is the density of sediment (in kg/m3).  
  Default: [rhosed] = 2650.  
[cdcap] is the maximum value for the wind drag coefficient. A value of [cdcap] = 99999  
  means no cutting off the drag coefficient. A suggestion for this parameter is  
  [cdcap] = 2.5x 10-3.  
  Default: [cdcap] = 99999.  
[prmean] is the mean atmospheric pressure (in N/m2). This will be used to correct the  
  water level along the water level boundaries so that it is consistent with the  
  local atmospheric pressure. A value of [prmean] = -1 means no correction.  
  Default: [prmean] = -1.  
[backvisc] is the background viscosity (in m2/s). It may be convenient to specify this  
  ambient viscosity to account for all forms of unresolved vertical mixing.  
  The value must be small compared to the vertical viscosity calculated by the  
  standard k - $ \varepsilon$ model. Experiences suggest a value of 10-4 to 10-3 m2/s.  
  Default: [backvisc] = 0.  
[kappa] is the Von Karman constant.  
  Default: [kappa] = 0.4  
CORIOLIS indicates that the Coriolis force will be included.  
NAUTICAL indicates that the Nautical convention for wind and current direction (SWASH  
  input and output) and for incident wave boundary condition will be used  
  instead of the default Cartesian convention. For definition, see Section 2.4  
  or Appendix A.  
CARTESIAN indicates that the Cartesian convention for wind and current direction (SWASH  
  input and output) and for incident wave boundary condition will be used.  
  For definition, see Section 2.4 or Appendix A.  
[printf] unit reference number of the PRINT file. As default, [printf] is equal to 4. If  
  it is changed to 6 all print output will be written to the screen. This is useful  
  if print output is lost due to abnormal end of the program, while information  
  about the reason is expected to be in the PRINT file.  
[prtest] unit reference number of the test output file. As default, [prtest] is equal to 4.  
  If it is changed to 6 all test output will be written to the screen. This is  
  useful if test print output is lost due to abnormal end of the program, while  
  information about the reason is expected to be in the test output file.  
[outlev] defines the amount of output for iterative solvers.  
  It is coded as follows:  
  0 : no output,  
  1 : only fatal errors will be printed,  
  2 : gives output concerning the iteration process,  
  3 : additional information about the iteration is printed.  
  Default: [outlev] = 0  


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

      |                 |     |-> TWODimensional |
MODE <   NONSTationary   >   <                    >
      |                 |     |   ONEDimensional |

\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 the run will be either one-dimensional (1D-mode, flume) or two-dimensional (2D-mode, basin).


Note that the keyword NONSTATIONARY is obliged.


The default option is NONSTATIONARY TWODIMENSIONAL.



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

             | -> CARTesian
COORDINATES <                  | -> CCM
             |    SPHErical   <
                               |  QC

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

Command to choose between Cartesian and spherical coordinates (see Section 2.4).

CARTESIAN all locations and distances are in m. Coordinates are given with respect  
  to x - and y -axes chosen by the user in the various commands.  
SPHERICAL all coordinates of locations and geographical grid sizes are given in degrees;  
  x is longitude with x = 0 being the Greenwich meridian and x > 0 is East of  
  this meridian; y is latitude with y > 0 being the Northern hemisphere. Input  
  and output grids have to be oriented with their x -axis to the East; mesh sizes  
  are in degrees. All other distances are in meters.  
CCM defines the projection method in case of spherical coordinates. CCM means  
  central conformal Mercator. The horizontal and vertical scales are uniform  
  in terms of cm/degree over the area shown. In the centre of the scale is  
  identical to that of the conventional Mercator projection (but only at that  
  centre). The area in the projection centre is therefore exactly conformal.  
QC the projection method is quasi-cartesian, i.e. the horizontal and vertical scales  
  are equal to one another in terms of cm/degree.  

Note that spherical coordinates can also be used for relatively small areas, say 10 or 20 km horizontal dimension. This may be useful if one obtains the boundary conditions by nesting in an oceanic model which is naturally formulated in spherical coordinates.


Note that in case of spherical coordinates regular grids must always be oriented E-W, N-S, i.e. [alpc]=0, [alpinp]=0, [alpfr]=0 (see commands CGRID, INPUT GRID and FRAME, respectively).


next up previous index
Next: Model description Up: Description of commands Previous: Command syntax and input   Index
The SWASH team 2017-04-06