List of available commands

The following commands are available to users of SWAN (to look for the commands quickly, see table of contents and index).


Start-up commands
(a)
Start-up commands:

PROJECT title of the problem to be computed  
SET sets values of certain general parameters  
MODE requests a stationary / nonstationary or  
  1D-mode / 2D-mode of SWAN  
COORD to choose between Cartesian and spherical coordinates  

Commands for model description
(b)
Commands for computational grid:

CGRID defines dimensions of computational grid  
READGRID reads a curvilinear or unstructured computational grid  

(c)
Commands for input fields:

INPGRID defines dimensions of bottom, water level, current and friction grids  
READINP reads input fields  
WIND activates constant wind option  
ICE activates constant ice field option  

(d)
Commands for boundary and initial conditions:

BOUND defines the shape of the spectra at the boundary of geographic grid  
BOUNDSPEC defines (parametric) spectra at the boundary of geographic grid  
BOUNDNEST1 defines boundary conditions obtained from (coarse) SWAN run  
BOUNDNEST2 defines boundary conditions obtained from WAM run  
BOUNDNEST3 defines boundary conditions obtained from WAVEWATCH III run  
INITIAL specifies an initial wave field  

(e)
Commands for physics:

GEN1 SWAN runs in first generation mode  
GEN2 SWAN runs in second generation mode  
GEN3 SWAN runs in third generation mode  
WCAP controls whitecapping  
QUAD controls the computation of quadruplets  
BREAKING activates dissipation by depth-induced wave breaking  
FRICTION activates dissipation by bottom friction  
TRIAD activates three wave-wave interactions  
VEGETAT activates dissipation due to vegetation  
MUD activates dissipation due to mud  
SICE activates dissipation due to sea ice  
TURBULE activates dissipation due to turbulence  
BRAGG activates Bragg scattering  
LIMITER de-actives quadruplets if a certain Ursell number exceeds  
OBSTACLE defines characteristics of sub-grid obstacles  
SETUP activates the computation of the wave-induced set-up  
DIFFRAC activates diffraction  
SURFBEAT activates the Infragravity Energy Module (IEM)  
OFF de-activates certain physical processes  

(f)
Commands for numerics:

PROP to choose the numerical propagation scheme  
NUMERIC sets some of the numerical properties of SWAN  

Output commands
(g)
Commands for output locations:

FRAME defines an output frame (a regular grid)  
GROUP defines an output group (for regular and curvilinear grids)  
CURVE defines an output curve  
RAY defines a set of straight output lines (rays)  
ISOLINE defines a depth- or bottom contour (for output along that contour)  
POINTS defines a set of individual output points  
NGRID defines a nested grid  

(h)
Commands to write or plot output quantities:

QUANTITY defines properties of output quantities  
OUTPUT influence format of block, table and/or spectral output  
BLOCK requests a block output (geographic distribution)  
TABLE requests a table output (set of locations)  
SPECOUT requests a spectral output  
NESTOUT requests a spectral output for subsequent nested computations  

(i)
Commands to write or plot intermediate results:

TEST requests an output of intermediate results for testing purposes  

Lock-up commands
(j)
Commands to lock-up the input file:

COMPUTE starts a computation  
HOTFILE stores results for subsequent SWAN run  
STOP end of user's input  

The SWAN team 2024-09-09