Bed composition parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| rhos | kgm^-3 | no | no | Solid sediment density (no pores) | no | 2650 | 2400 | 2800 | (par.sedtrans==1) | |
| ngd | - | no | no | Number of sediment classes | no | 1 | 1 | 20 | ||
| nd | - | yes | no | nd_var | Number of computational layers in the bed | no | 3 | 3 | 1000 | |
| dzg1 | m | yes | no | dzg1 dzg2 dzg3 | Thickness of top sediment class layers | no | 0.1 | 0.01 | 1 | (par.sedtrans==1) |
| no | par.dzg1 | 0.01 | 1 | (par.sedtrans==1) | ||||||
| dzg2 | m | yes | no | Nominal thickness of variable sediment class layer | no | par.dzg1 | 0.01 | 1 | (par.sedtrans==1) | |
| dzg3 | m | yes | no | Thickness of bottom sediment class layers | no | par.dzg1 | 0.01 | 1 | (par.sedtrans==1) | |
| por | - | no | no | Porosity | no | 0.4 | 0.3 | 0.5 | ||
| D50 | m | no | no | D50 grain size per grain type | no | 0.0002 | 5e-005 | 0.0008 | ||
| D90 | m | no | no | D90 grain size per grain type | no | 0.0003 | 0.0001 | 0.0015 | ||
| sedcal | - | yes | no | Sediment transport calibration coefficient per grain type | no | 1 | 0 | 2 | (par.sedtrans==1) | |
| ucrcal | - | yes | no | Critical velocity calibration coefficient per grain type | no | 1 | 0 | 2 | (par.sedtrans==1) |
Bed update numerics parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| frac_dz | - | yes | no | Relative thickness to split time step for bed updating | no | 0.7 | 0.5 | 0.98 | (par.morphology==1) | |
| nd_var | - | yes | no | Index of layer with variable thickness | no | 2 | 2 | par.nd | (par.morphology==1) | |
| split | - | yes | no | Split threshold for variable sediment layer (ratio to nominal thickness) | no | 1.01 | 1.005 | 1.1 | (par.morphology==1) | |
| merge | - | yes | no | Merge threshold for variable sediment layer (ratio to nominal thickness) | no | 0.01 | 0.005 | 0.1 | (par.morphology==1) |
Coriolis force parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| wearth | hour^-1 | yes | no | Angular velocity of earth calculated as: 1/rotation_time (in hours), later changed in calculation code to rad/s | no | 0.041667 | 0 | 1 | ||
| lat | deg | yes | no | Latitude at model location for computing Coriolis | no | 0 | -90 | 90 |
Drifters parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| ndrifter | - | no | no | ndrifter | Number of drifers | no | par.ndrifter | 0 | 50 | |
| drifterfile | - | no | no | Name of drifter data file | no |
Flow boundary condition parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| front | - | no | no | Switch for seaward flow boundary: 0 = radiating boundary(Ad), 1 = Van Dongeren, 1997 | no | abs_2d | ||||
| left | - | no | no | Switch for lateral boundary at ny+1, 'neumann' = vv computed from NSWE, 'wall' = reflective wall; vv=0 | no | neumann | ||||
| right | - | no | no | Switch for lateral boundary at right, 0 = vv computed from NSWE, 1 = reflective wall; vv=0 | no | neumann | ||||
| back | - | no | no | Switch for boundary at bay side, 0 = radiating boundary (Ad), 1 = reflective boundary; uu=0 | no | abs_2d | ||||
| ARC | - | yes | no | Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly (non) reflective | no | 1 | 0 | 1 | ||
| order | - | yes | no | Switch for order of wave steering, 1 = first order wave steering (short wave energy only), 2 = second oder wave steering (bound long wave corresponding to short wave forcing is added) | no | 2 | 1 | 2 | ||
| freewave | - | yes | no | Switch for free wave propagation 0 = use cg (default); 1 = use sqrt(gh) in instat = 3 | no | par.carspan | 0 | 1 | ||
| carspan | - | no | yes | freewave | Switch for Carrier-Greenspan test 0 = use cg (default); 1 = use sqrt(gh) in instat = 3 for c&g tests | no | 0 | 0 | 1 | |
| epsi | - | yes | no | Ratio of mean current to time varying current through offshore boundary | no | 0 | -1 | 0.2 | ||
| tidetype | - | yes | no | Switch for offfshore boundary, velocity boundary or instant water level boundary (default) | no | velocity |
Flow discharge boundary conditions
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| ndischarge | - | yes | no | ndischarge | Number of discharge locations | no | par.ndischarge | 0 | 100 | |
| ntdischarge | - | yes | no | ntdischarge | Length of discharge time series | no | par.ntdischarge | 0 | 100 | |
| disch_loc_file | - | yes | no | Name of discharge locations file | no | |||||
| disch_timeseries_file | - | yes | no | Name of discharge timeseries file | no |
Flow numerics parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| eps | m | no | no | Threshold water depth above which cells are considered wet | no | 0.005 | 0.001 | 0.1 | ||
| umin | m/s | no | no | Threshold velocity for upwind velocity detection and for vmag2 in eq. sediment concentration | no | 0 | 0 | 0.2 | ||
| hmin | m | no | no | Threshold water depth above which Stokes drift is included | no | 0.2 | 0.001 | 1 | ||
| secorder | - | yes | no | Use second order corrections to advection/non-linear terms based on mcCormack scheme | no | 0 | 0 | 1 | ||
| oldhu | - | yes | no | Turn on / off old hu calculation | no | 0 | 0 | 1 |
Flow parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| bedfriction | - | no | no | bedfricfile C cf | Bed friction formulation: 'chezy','white-colebrook' | no | chezy | |||
| bedfricfile | - | no | no | C cf | Bed friction file (only valid with values of C) | no | ((par.bedfriction)=='chezy') | |||
| C | m^0.5s^-1 | no | no | C cf | Chezy coefficient | no | 55 | 20 | 100 | ((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & isSetParameter('params.txt','C') & ~ isSetParameter('params.txt','cf') |
| no | 55 | 20 | 100 | ((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & isSetParameter('params.txt','C') & ~ isSetParameter('params.txt','cf') | ||||||
| no | 55 | 20 | 100 | ((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & isSetParameter('params.txt','C') & ~ isSetParameter('params.txt','cf') | ||||||
| cf | - | yes | no | C cf | Friction coefficient flow | no | 0.003 | 0 | 0.1 | ((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & (isSetParameter('params.txt','cf') & ~ isSetParameter('params.txt','C')) |
| nuh | m^2s^-1 | no | no | Horizontal background viscosity | no | 0.1 | 0 | 1 | ||
| nuhfac | - | yes | no | Viscosity switch for roller induced turbulent horizontal viscosity | no | 1 | 0 | 1 | ||
| nuhv | - | yes | no | Longshore viscosity enhancement factor, following Svendsen (?) | no | 1 | 1 | 20 | ||
| smag | - | yes | no | Switch for smagorinsky subgrid model for viscocity | no | 1 | 0 | 1 |
Grid parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| depfile | - | no | no | Name of the input bathymetry file | yes | ((par.gridform)=='xbeach') | ||||
| yes | ((par.gridform)=='xbeach') | |||||||||
| posdwn | - | no | no | Bathymetry is specified positive down (1) or positive up (-1) | no | 1 | -1 | 1 | ((par.gridform)=='xbeach') | |
| no | 1 | -1 | 1 | ((par.gridform)=='xbeach') | ||||||
| nx | - | no | no | Number of computiation cell corners in x-direction | yes | 50 | 2 | 10000 | ((par.gridform)=='xbeach') | |
| ny | - | no | no | Number of computiation cell corners in y-direction | yes | 2 | 0 | 10000 | ((par.gridform)=='xbeach') | |
| alfa | deg | no | no | Angle of x-axis from East | no | 0 | 0 | 360 | ((par.gridform)=='xbeach') | |
| no | 0 | 0 | 360 | ((par.gridform)=='xbeach') | ||||||
| vardx | - | no | no | dx dy xfile yfile | Switch for variable grid spacing: 1 = irregular spacing, 0 = regular grid spacing | no | 0 | 0 | 1 | ((par.gridform)=='xbeach') |
| dx | m | no | no | Regular grid spacing in x-direction | yes | -1 | 0 | 1000000000 | ((par.gridform)=='xbeach') & (par.vardx==0) | |
| no | -1 | 0 | 1000000000 | ((par.gridform)=='xbeach') & (par.vardx==0) | ||||||
| dy | m | no | no | Regular grid spacing in y-direction | yes | -1 | 0 | 1000000000 | ((par.gridform)=='xbeach') & (par.vardx==0) | |
| no | -1 | 0 | 1000000000 | ((par.gridform)=='xbeach') & (par.vardx==0) | ||||||
| xfile | name | no | no | Name of the file containing x-coordinates of the calculation grid | no | ((par.gridform)=='xbeach') & ~((par.vardx==0)) | ||||
| yfile | name | no | no | Name of the file containing y-coordinates of the calculation grid | no | ((par.gridform)=='xbeach') & ~((par.vardx==0)) | ||||
| xori | m | no | no | X-coordinate of origin of axis | no | 0 | -1000000000 | 1000000000 | ((par.gridform)=='xbeach') | |
| no | 0 | -1000000000 | 1000000000 | ((par.gridform)=='xbeach') | ||||||
| yori | m | no | no | Y-coordinate of origin of axis | no | 0 | -1000000000 | 1000000000 | ((par.gridform)=='xbeach') | |
| no | 0 | -1000000000 | 1000000000 | ((par.gridform)=='xbeach') | ||||||
| thetamin | deg | no | no | Lower directional limit (angle w.r.t computational x-axis) | yes | -90 | -180 | 180 | ||
| thetamax | deg | no | no | Higher directional limit (angle w.r.t computational x-axis) | yes | 90 | -180 | 180 | ||
| dtheta | deg | no | no | Directional resolution | yes | 10 | 0.1 | 20 | ||
| thetanaut | - | no | no | Thetamin,thetamax in cartesian (0) or nautical convention (1) | no | 0 | 0 | 1 | ||
| gridform | name | no | no | depfile posdwn nx ny alfa vardx dx dy xfile yfile xori yori xyfile | Swicth to read in grid bathy files with 'XBeach' or 'Delft3D' format respectively | no | xbeach | |||
| xyfile | name | no | no | Name of the file containing (Delft3D) xy-coordinates of the calculation grid | no | (par.gridform)=='delft3d' |
Groundwater parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| kx | ms^-1 | yes | no | ky kz | Darcy-flow permeability coefficient in x-direction [m/s] | no | 0.0001 | 1e-005 | 0.01 | (par.gwflow==1) |
| ky | ms^-1 | yes | no | Darcy-flow permeability coefficient in y-direction [m/s] | no | par.kx | 1e-005 | 0.01 | (par.gwflow==1) | |
| kz | ms^-1 | yes | no | Darcy-flow permeability coefficient in z-direction [m/s] | no | par.kx | 1e-005 | 0.01 | (par.gwflow==1) | |
| dwetlayer | m | yes | no | Thickness of the top soil layer interacting more freely with the surface water | no | 0.2 | 0.01 | 1 | (par.gwflow==1) | |
| aquiferbot | m | yes | no | Level of uniform aquifer bottom | no | -10 | -100 | 100 | (par.gwflow==1) & (par.aquiferbotfile=='') | |
| aquiferbotfile | - | yes | no | aquiferbot | Name of the aquifer bottom file | no | (par.gwflow==1) | |||
| gw0 | m | yes | no | Level initial groundwater level | no | 0 | -5 | 5 | (par.gwflow==1) & (par.gw0file=='') | |
| gw0file | - | yes | no | gw0 | Name of initial groundwater level file | no | (par.gwflow==1) | |||
| gwdelay | s | yes | no | Duration for pressure smoothing function in groundwater module | no | 0.2 | 0.01 | 1 | (par.gwflow==1) |
Initial conditions
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| zs0 | m | no | no | Inital water level | no | 0 | -5 | 5 | ~((par.tideloc>0)) | |
| zsinitfile | name | no | no | Name of inital condition file zs | no |
MPI parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| mpiboundary | - | yes | no | Fix mpi boundaries along y-lines ('y'), x-lines ('x'), or find shortest boundary ('auto') | no | auto |
Model time
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| tstop | s | no | no | morstop tintm | Stop time of simulation, in morphological time | yes | 2000 | 1 | 1000000 | |
| CFL | - | no | no | Maximum Courant-Friedrichs-Lewy number | no | 0.7 | 0.1 | 0.9 |
Morphology parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| morfac | - | no | no | Morphological acceleration factor | no | 1 | 0 | 1000 | (par.morphology==1) | |
| morfacopt | - | yes | no | Option indicating whether times should be adjusted (1) or not(0) for morfac | no | 1 | 0 | 1 | (par.morphology==1) | |
| morstart | s | no | no | Start time morphology, in morphological time | no | 120 | 0 | 10000 | (par.morphology==1) | |
| morstop | s | no | no | Stop time morphology, in morphological time | no | par.tstop | 0 | 10000 | (par.morphology==1) | |
| wetslp | - | no | no | Critical avalanching slope under water (dz/dx and dz/dy) | no | 0.3 | 0.1 | 1 | (par.morphology==1) | |
| dryslp | - | no | no | Critical avalanching slope above water (dz/dx and dz/dy) | no | 1 | 0.1 | 2 | (par.morphology==1) | |
| hswitch | m | yes | no | Water depth at which is switched from wetslp to dryslp | no | 0.1 | 0.01 | 1 | (par.morphology==1) | |
| dzmax | m/s/m | yes | no | Maximum bedlevel change due to avalanching | no | 0.05 | 0 | 1 | (par.morphology==1) | |
| struct | - | no | no | ne_layer | Switch for hard structures | no | 0 | 0 | 1 | (par.morphology==1) |
| ne_layer | name | no | no | Name of file containing depth of hard structure | no | (par.morphology==1) & (par.struct==1) |
Non-hydrostatic correction parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| solver_maxit | - | yes | no | Maximum number of iterations in the linear SIP solver | no | 30 | 1 | 1000 | (par.nonh==1) | |
| solver_acc | - | yes | no | accuracy with respect to the right-hand side usedin the following termination criterion:||b-Ax || < acc*||b|| | no | 0.005 | 1e-005 | 0.1 | (par.nonh==1) | |
| solver_urelax | - | yes | no | Underrelaxation parameter | no | 0.92 | 0.5 | 0.99 | (par.nonh==1) | |
| solver | - | yes | no | Solver used to solve the linear system, 1=SIP, 2=TRIDIAG (only for 1d) | no | 1 | 0 | 2 | (par.nonh==1) | |
| kdmin | - | yes | no | Minimum value of kd ( pi/dx > minkd ) | no | 0 | 0 | 0.05 | (par.nonh==1) | |
| dispc | ? | yes | no | Coefficient in front of the vertical pressure gradient, Default = 1. | no | 1 | 0.1 | 2 | (par.nonh==1) | |
| Topt | s | yes | no | Absolute period to optimize coefficient | no | 10 | 1 | 20 | (par.nonh==1) |
Output variables
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| timings | - | yes | no | Switch to turn on (1) or off (0) progress output to screen | no | 1 | 0 | 1 | ||
| tstart | s | no | no | tintm | Start time of output, in morphological time | no | 1 | 0 | 1000000 | |
| tint | s | no | yes | tintg tintp tintc | Interval time of global output (replaced by tintg) | no | 1 | 0.01 | 100000 | |
| tintg | s | no | no | Interval time of global output | no | par.tint | 0.01 | 100000 | (par.tsglobal=='') | |
| tintp | s | no | no | Interval time of point and runup gauge output | no | par.tint | 0.01 | 100000 | (par.tspoints=='') | |
| tintc | s | yes | no | Interval time of cross section output | no | par.tint | 0.01 | 100000 | (par.tscross=='') | |
| tintm | s | no | no | Interval time of mean,var,max,min output | no | par.tstop-par.tstart | 1 | par.tstop-par.tstart | (par.tsmean=='') | |
| tsglobal | - | yes | no | tintg | Name of file containing timings of global output | no | ||||
| tspoints | - | yes | no | tintp | Name of file containing timings of point output | no | ||||
| tscross | - | yes | no | tintc | Name of file containing timings of cross section output | no | ||||
| tsmean | - | yes | no | tintm | Name of file containing timings of mean, max, min and var output | no | ||||
| nglobalvar | - | no | no | Number of global output variables (as specified by user) | no | -1 | -1 | 20 | ||
| nmeanvar | - | no | no | Number of mean,min,max,var output variables | no | 0 | 0 | 15 | ||
| npointvar | - | no | no | Number of point output variables | no | 0 | 0 | 50 | ||
| npoints | - | no | no | Number of output point locations | no | 0 | 0 | 50 | ||
| nrugauge | - | no | no | Number of output runup gauge locations | no | 0 | 0 | 50 | ||
| rugdepth | m | yes | no | Minimum depth for determination of last wet point in runup gauge | no | 0 | 0 | 0.05 | ||
| ncross | - | yes | no | Number of output cross sections | no | 0 | 0 | 50 | ||
| outputformat | - | yes | no | Choice of output file format: 'netcdf', 'fortran', or 'debug' | no | fortran | ||||
| ncfilename | - | yes | no | xbeach netcdf output file name | no |
Physical constants
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| g | ms^-2 | no | no | Gravitational acceleration | no | 9.81 | 9.7 | 9.9 | ||
| rho | kgm^-3 | no | no | Density of water | no | 1025 | 1000 | 1040 | ||
| depthscale | - | yes | no | depthscale of (lab)test simulated. 1 = default, which corresponds to teh real world (nature)the follwing (numerical) parameters are scaled with the depth scale (see Brandenburg, 2010):eps = eps_default/depthscalehmin = hmin_default/depthscalehswitch = hswitch/depthscaledzmax = dzmax/depthscale**1.5d0Brandenburg concluded that also the following parameters potentially need to be scaled:wetslp, turb (suggested to turn off at depthscales<20) & ucr (distinguish ucr_bed load anducr_sus at depthscales<20) | no | 1 | 1 | 200 |
Physical processes
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| swave | - | no | no | thetamin thetamax dtheta instat | Include short waves (1), exclude short waves (0) | no | 1 | 0 | 1 | |
| lwave | - | no | no | Include short wave forcing on NLSW equations and boundary conditions (1), or exclude (0) | no | 1 | 0 | 1 | ||
| flow | - | no | no | Include flow calculation (1), or exclude (0) | no | 1 | 0 | 1 | ||
| sedtrans | - | no | no | rhos dzg1 dzg2 dzg3 sedcal ucrcal waveform form sws lws BRfac facsl z0 smax tsfac facua facSk facAs turb Tbfac Tsmin lwt betad sus bed bulk thetanum sourcesink cmax | Include sediment transport (1) or exclude (0) | no | 1 | 0 | 1 | |
| morphology | - | no | no | morfac morfacopt morstart morstop wetslp dryslp hswitch dzmax struct ne_layer frac_dz nd_var split merge | Include morphology (1) or exclude (0) | no | 1 | 0 | 1 | |
| avalanching | - | no | no | Include avalanching (1) or exclude (0) | no | 1 | 0 | 1 | ||
| nonh | - | yes | no | solver_maxit solver_acc solver_urelax solver kdmin dispc Topt | Non-hydrostatic pressure option: 0 = NSWE, 1 = NSW + non-hydrostatic pressure compensation Stelling & Zijlema, 2003 | no | 0 | 0 | 1 | |
| gwflow | - | yes | no | kx ky kz dwetlayer aquiferbot aquiferbotfile gw0 gw0file gwdelay | Turn on (1) or off (0) groundwater flow module | no | 0 | 0 | 1 | |
| q3d | - | yes | no | vonkar vicmol kmax sigfac | Turn on (1) or off (0) quasi-3D sediment transport module | no | 0 | 0 | 1 |
Q3D sediment transport parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| vonkar | unknown | yes | no | von Karman constant | no | 0.4 | 0.01 | 1 | (par.q3d==1) | |
| vicmol | unknown | yes | no | molecular viscosity | no | 1e-006 | 0 | 0.001 | (par.q3d==1) | |
| kmax | - | yes | no | Number of sigma layers in Quasi-3D model; kmax = 1 (default) is without vertical structure of flow and suspensions | no | 1 | 1 | 1000 | (par.q3d==1) | |
| sigfac | - | yes | no | dsig scales with log(sigfac). Default = 1.3 | no | 1.3 | 0 | 10 | (par.q3d==1) |
Roller parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| roller | - | yes | no | Turn on (1) or off(0) roller model | no | 1 | 0 | 1 | ||
| beta | - | yes | no | Breaker slope coefficient in roller model | no | 0.1 | 0.05 | 0.3 | ||
| rfb | - | yes | no | If rfb = 1 then maximum wave surface slope is feeded back in roller energy balance; else rfb = par%Beta | no | 0 | 0 | 1 |
Sediment transport numerics parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| thetanum | - | yes | no | Coefficient determining whether upwind (1) or central scheme (0.5) is used. | no | 1 | 0.5 | 1 | (par.sedtrans==1) | |
| sourcesink | - | yes | no | In suspended transport use source-sink terms to calculate bed level change (1) or sus transport gradients (0) | no | 0 | 0 | 1 | (par.sedtrans==1) | |
| cmax | - | yes | no | Maximum allowed sediment concentration | no | 0.1 | 0 | 1 | (par.sedtrans==1) |
Sediment transport parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| waveform | - | no | no | Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009 | no | vanthiel | (par.sedtrans==1) | |||
| form | - | no | no | Equilibrium sed. conc. formulation: 1 = Soulsby van Rijn, 1997, 2 = Van Rijn 2008 with modifications by Van Thiel | no | vanthiel_vanrijn | (par.sedtrans==1) | |||
| sws | - | yes | no | 1 = short wave & roller stirring and undertow, 0 = no short wave & roller stirring and undertow | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| lws | - | yes | no | 1 = long wave stirring, 0 = no long wave stirring | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| BRfac | - | yes | no | Calibration factor surface slope | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| facsl | - | yes | no | Factor bedslope effect | no | 1.6 | 0 | 1.6 | (par.sedtrans==1) | |
| z0 | m | yes | no | Zero flow velocity level in Soulsby van Rijn (1997) sed.conc. expression | no | 0.006 | 0.0001 | 0.05 | (par.sedtrans==1) | |
| smax | - | yes | no | Being tested: maximum Shields parameter for ceq Diane Foster | no | -1 | -1 | 3 | (par.sedtrans==1) | |
| tsfac | - | yes | no | Coefficient determining Ts = tsfac * h/ws in sediment source term | no | 0.1 | 0.01 | 1 | (par.sedtrans==1) | |
| facua | - | yes | no | facSk facAs | Calibration factor time averaged flows due to wave skewness and asymmetry | no | 0.1 | 0 | 1 | (par.sedtrans==1) |
| facSk | - | yes | no | Calibration factor time averaged flows due to wave skewness | no | par.facua | 0 | 1 | (par.sedtrans==1) | |
| facAs | - | yes | no | Calibration factor time averaged flows due to wave asymmetry | no | par.facua | 0 | 1 | (par.sedtrans==1) | |
| turb | - | yes | no | Equlibrium sediment concentration is computed as function of:none = no turbulence, | no | bore_averaged | (par.sedtrans==1) | |||
| Tbfac | - | yes | no | Calibration factor for bore interval Tbore: Tbore = Tbfac*Tbore | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| Tsmin | s | yes | no | Minimum adaptation time scale in advection diffusion equation sediment | no | 0.5 | 0.01 | 10 | (par.sedtrans==1) | |
| lwt | - | yes | no | Switch 0/1 long wave turbulence model | no | 0 | 0 | 1 | (par.sedtrans==1) | |
| betad | - | yes | no | Dissipation parameter long wave breaking turbulence | no | 1 | 0 | 10 | (par.sedtrans==1) | |
| sus | - | yes | no | Calibration factor for suspensions transports [0..1] | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| bed | - | yes | no | Calibration factor for bed transports [0..1] | no | 1 | 0 | 1 | (par.sedtrans==1) | |
| bulk | - | yes | no | Option to compute bedload and suspended load seperately; 0 = seperately, 1 = bulk (as in previous versions) | no | 1 | 0 | 1 | (par.sedtrans==1) |
Tide boundary conditions
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| zs0file | - | no | no | Name of tide boundary condition series | no | (par.tideloc>0) | ||||
| tideloc | - | no | no | zs0 zs0file paulrevere | Number of corner points on which a tide time series is specified | no | 0 | 0 | 4 | |
| paulrevere | - | no | no | Specifies tide on sea and land ('land') or two sea points ('sea') if tideloc = 2if tideloc =>2, then this indicates where the time series are to beapplied. Input for tidal information to xbeach options (3):1. one tidal record --> specify tidal record everywhere2. two tidal records --> Need to specify keyword 'paulrevere'paulrevere=='land' implies to apply one tidal record toboth sea corners and one tidal record to both land cornerspaulrevere=='sea' implies to apply the first tidal record(column 2 in zs0input.dat) to the (x=1,y=1) sea corner andthe second tidal record (third column) to the (x=1,y=N) sea corner3. four tidal records --> Need to list tidal records inzs0input.dat in order of:(x=1,y=1)(x=1,y=N)(x=N,y=N)(x=N,y=1)NOTE: clockwise from (1,1) corner | no | land | (par.tideloc>0) & (par.tideloc==2) |
Wave boundary condition parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| instat | - | no | no | Hrms Tm01 Trep Tlong dir0 m bcfile random fcutoff nspr trepfac sprdthr oldwbc newstatbc correctHm0 oldnyq Tm01switch rt dtbc dthetaS_XB wavint maxerror maxiter | Wave boundary condtion type | yes | bichrom | |||
| taper | s | no | no | Spin-up time of wave boundary conditions, in morphological time | no | 100 | 0 | 1000 | ||
| Hrms | m | no | no | Hrms wave height for instat = 0,1,2,3 | no | 1 | 0 | 10 | ((par.instat)=='stat') | |
| no | 1 | 0 | 10 | ((par.instat)=='stat') | ||||||
| no | 1 | 0 | 10 | ((par.instat)=='stat') | ||||||
| Tm01 | s | no | yes | Trep | Old name for Trep | no | 10 | 1 | 20 | ((par.instat)=='stat') |
| no | 10 | 1 | 20 | ((par.instat)=='stat') | ||||||
| no | 10 | 1 | 20 | ((par.instat)=='stat') | ||||||
| Trep | s | no | no | Representative wave period for instat = 0,1,2,3 | no | par.Tm01 | 1 | 20 | ((par.instat)=='stat') | |
| no | par.Tm01 | 1 | 20 | ((par.instat)=='stat') | ||||||
| no | par.Tm01 | 1 | 20 | ((par.instat)=='stat') | ||||||
| Tlong | s | no | no | Wave group period for case instat = 1 | no | 80 | 20 | 300 | (par.instat)=='bichrom' | |
| dir0 | deg | no | no | Mean wave direction (Nautical convention) for instat = 0,1,2,3 | no | 270 | 180 | 360 | ((par.instat)=='stat') | |
| no | 270 | 180 | 360 | ((par.instat)=='stat') | ||||||
| no | 270 | 180 | 360 | ((par.instat)=='stat') | ||||||
| nmax | - | yes | no | maximum ratio of cg/c fro computing long wave boundary conditions | no | 0.8 | 0.5 | 1 | ||
| m | - | no | no | Power in cos^m directional distribution for instat = 0,1,2,3 | no | 10 | 2 | 128 | ((par.instat)=='stat') | |
| no | 10 | 2 | 128 | ((par.instat)=='stat') | ||||||
| no | 10 | 2 | 128 | ((par.instat)=='stat') | ||||||
| leftwave | - | no | no | old name for lateralwave | no | neumann | ||||
| rightwave | - | no | no | old name for lateralwave | no | neumann |
Wave breaking parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| break | - | no | no | gamma2 | Type of breaker formulation (1=roelvink, 2=baldock, 3=roelvink adapted, 4=roelvink on/off breaking) | no | roelvink2 | |||
| gamma | - | no | no | Breaker parameter in Baldock or Roelvink formulation | no | 0.55 | 0.4 | 0.9 | ||
| gamma2 | - | no | no | End of breaking parameter in break = 4 formulation | no | 0.3 | 0 | 0.5 | ((par.break)=='roelvink_daly') | |
| alpha | - | yes | no | Wave dissipation coefficient in Roelvink formulation | no | 1 | 0.5 | 2 | ||
| n | - | yes | no | Power in Roelvink dissipation model | no | 10 | 5 | 20 | ||
| gammax | - | yes | no | Maximum ratio wave height to water depth | no | 2 | 0.4 | 5 | ||
| delta | - | yes | no | Fraction of wave height to add to water depth | no | 0 | 0 | 1 | ||
| fw | - | yes | no | Bed friction factor | no | 0 | 0 | 1 | ||
| breakerdelay | - | yes | no | Turn on (1) or off (0) breaker delay model | no | 1 | 0 | 1 | ||
| shoaldelay | - | yes | no | Turn on (1) or off (0) shoaling delay | no | 0 | 0 | 1 | ||
| facsd | - | yes | no | fraction of the local wave length to use for shoaling delay depth | no | 1 | 0 | 2 |
Wave numerics parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| scheme | - | yes | no | Use first-order upwind (upwind_1), second order upwind (upwind_2) or Lax-Wendroff (lax_wendroff)for wave propagation | no | upwind_2 | ||||
| wavint | s | no | no | Interval between wave module calls (only in stationary wave mode) | no | 60 | 1 | 3600 | ((par.instat)=='stat' | (par.instat)=='stat_table') | |
| maxerror | m | yes | no | Maximum wave height error in wave stationary iteration | no | 5e-005 | 1e-005 | 0.001 | ((par.instat)=='stat' | (par.instat)=='stat_table') | |
| maxiter | - | yes | no | Maximum number of iterations in wave stationary | no | 500 | 2 | 1000 | ((par.instat)=='stat' | (par.instat)=='stat_table') |
Wave-current interaction parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| wci | - | no | no | Turns on (1) or off (0) wave-current interaction | no | 0 | 0 | 1 | ||
| hwci | m | yes | no | Minimum depth until which wave-current interaction is used | no | 0.1 | 0.001 | 1 | ||
| cats | Trep | yes | no | Current averaging time scale for wci, in terms of mean wave periods | no | 4 | 1 | 50 |
Wave-spectrum boundary condition parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| bcfile | - | no | no | Name of spectrum file | no | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='stat_table' | (par.instat)=='jons_table') | ||||
| random | - | yes | no | Random seed on (1) or off (0) for instat = 4,5,6 boundary conditions | no | 1 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| fcutoff | Hz | yes | no | Low-freq cutoff frequency for instat = 4,5,6 boundary conditions | no | 0 | 0 | 40 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| nspr | - | yes | no | nspr = 1 long wave direction forced into centres of short wave bins, nspr = 0 regular long wave spreadin | no | 0 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| trepfac | - | yes | no | Compute mean wave period over energy band: par%trepfac*maxval(Sf) for instat 4,5,6; converges to Tm01 for trepfac = 0.0 and | no | 0.01 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| sprdthr | - | yes | no | Threshold ratio to maxval of S above which spec dens are read in (default 0.08*maxval) | no | 0.08 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| oldwbc | - | yes | no | (1) Use old version wave boundary conditions for instat 4,5,6 | no | 0 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| newstatbc | - | yes | no | (1) Use new stationary boundary conditions for instat is 'stat' or 'stat_table' | no | 1 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| correctHm0 | - | yes | no | Turn off or on Hm0 correction | no | 1 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| oldnyq | - | yes | no | Turn off or on old nyquist switch | no | 0 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| Tm01switch | - | yes | no | Turn off or on Tm01 or Tm-10 switch | no | 0 | 0 | 1 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') | |
| rt | s | no | no | Duration of wave spectrum at offshore boundary, in morphological time | no | 3600 | 1200 | 7200 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & (filetype==0) | |
| dtbc | s | yes | no | Timestep used to describe time series of wave energy and long wave flux at offshore boundary (not affected by morfac) | no | 0.5 | 0.1 | 2 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & (filetype==0) | |
| dthetaS_XB | deg | yes | no | If SWAN input is not in nautical degrees, dthetaS_XB is the angle from SWAN x-axis to XBeach x-axis in cathesian degrees | no | 0 | -360 | 360 | ((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & ((par.instat)=='swan') |
Wind parameters
| Name | Units | Advanced | Deprecated | Affects | Description | Required | Default | Min | Max | Condition |
|---|---|---|---|---|---|---|---|---|---|---|
| rhoa | kgm^-3 | yes | no | Air density | no | 1.25 | 1 | 2 | ||
| Cd | - | yes | no | Wind drag coefficient | no | 0.002 | 0.0001 | 0.01 | ||
| windv | ms^-1 | no | no | Wind velocity, in case of stationary wind | no | 0 | 0 | 200 | (par.windfile=='') | |
| windth | deg | no | no | Nautical wind direction, in case of stationary wind | no | 270 | -360 | 360 | (par.windfile=='') | |
| windfile | - | no | no | windv windth | Name of file with non-stationary wind data | no |