next up previous index
Next: Sequence of commands Up: Description of commands Previous: Description of commands   Index


List of available commands

The following commands are available to users of SWASH (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 1D-mode / 2D-mode of SWASH  
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 an orthogonal curvilinear computational grid  
VERT defines vertical grid schematisation  

(c)
Commands for input fields:

INPGRID defines dimensions of e.g. bottom, porosity and friction grids  
READINP reads input fields  
INPTRAN defines dimensions of grids for transport of constituents  
READTRA reads stationary input fields of transport constituents  

(d)
Commands for initial and boundary conditions:

INITIAL specifies an initial flow field and turbulence quantities  
BOUND specifies the boundary conditions  
SPONGE defines sponge layers  

(e)
Commands for physics:

WIND specifies wind speed, direction and wind drag  
FRIC specifies bottom friction  
VISC includes horizontal and/or vertical turbulent eddy viscosity  
POROS includes effects of porous structures  
VEGET activates wave damping induced by aquatic vegetation  
TRANSP specifies some relevant parameters for transport of constituents  
BRE controls wave breaking  

(f)
Commands for numerics:

NONHYD to choose approximation for nonhydrostatic pressure  
DISCRET to choose space discretization  
BOTCEL to determine bottom values in cell centers  
TIMEINT to choose time integration  

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  

(h)
Commands to write or plot output quantities:

QUANTITY defines properties of output quantities  
OUTPUT influence format of block and/or table  
BLOCK requests a block output (geographic distribution)  
TABLE requests a table output (set of locations)  

(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  
STOP end of user's input  


next up previous index
Next: Sequence of commands Up: Description of commands Previous: Description of commands   Index
The SWASH team 2017-04-06