Input parameters

Table 41 Overview of available keywords related to *
parameter description default range units
ARC+ Switch for active reflection compensation at seaward boundary 1 0 - 1
BRfac+ Calibration factor surface slope 1.0 0.0 - 1.0
CFL Maximum courant-friedrichs-lewy number 0.7 0.1 - 0.9
Cd+ Wind drag coefficient 0.002 0.0001 - 0.01
Hrms Hrms wave height for instat = stat, bichrom, ts_1 or ts_2 1.0 0.0 - 10.0 m
Tbfac+ Calibration factor for bore interval tbore: tbore = tbfac*tbore 1.0 0.0 - 1.0
Tlong Wave group period for case instat = bichrom 80.0 20.0 - 300.0 s
Tm01switch+ Switch to enable tm01 rather than tm-10 0 0 - 1
Topt+ Absolute period to optimize coefficient 10.0 1.0 - 20.0 s
Trep Representative wave period for instat = stat, bichrom, ts_1 or ts_2 10.0 1.0 - 20.0 s
Tsmin+ Minimum adaptation time scale in advection diffusion equation sediment 0.5 0.01 - 10.0 s
advection Include advection in flow solver 1 0 - 1
alfa Angle of x-axis from east 0.0 0.0 - 360.0 deg
alpha+ Wave dissipation coefficient in roelvink formulation 1.0 0.5 - 2.0
aquiferbot+ Level of uniform aquifer bottom -10.0 -100.0 - 100.0 m
aquiferbotfile+ Name of the aquifer bottom file <file>
avalanching Turn on avalanching 1 0 - 1
back Switch for boundary at bay side abs_2d wall, abs_1d, abs_2d, wlevel
bcfile Name of spectrum file <file>
bchwiz Turn on beachwizard 0 0 - 1
bclwonly Switch to run boundary conditions with long waves only 0 0 - 1
bdslpeffdir Modify the direction of the sediment transport based on the bed slope none none, talmon
bdslpeffdirfac Calibration factor in the modification of the direction 1.0 0.0 - 2.0
bdslpeffini Modify the critical shields parameter based on the bed slope none none, total, bed
bdslpeffmag Modify the magnitude of the sediment transport based on the bed slope, uses facsl roelvink_total none, roelvink_total, roelvink_bed, soulsby_total, soulsby_bed
bed+ Calibration factor for bed transports 1 0 - 1
bedfriccoef Bed friction coefficient 0.01 3.5e-05 - 0.9
bedfricfile Bed friction file (only valid with values of c) <file>
bedfriction Bed friction formulation chezy chezy, cf, white-colebrook, manning, white-colebrook-grainsize
bermslope Swash zone slope for (semi-) reflective beaches 0.0 0.0 - 1.0
beta+ Breaker slope coefficient in roller model 0.1 0.05 - 0.3
betad+ Dissipation parameter long wave breaking turbulence 1.0 0.0 - 10.0
break Type of breaker formulation roelvink2 roelvink1, baldock, roelvink2, roelvink_daly, janssen
breakerdelay+ Switch to enable breaker delay model 1.0 0.0 - 3.0
breakviscfac+ Factor to increase viscosity during breaking 1.5 1.0 - 3.0
breakvisclen+ Ratio between local depth and length scale in extra breaking viscosity 1.0 0.75 - 3.0
bulk+ Switch to compute bulk transport rather than bed and suspended load separately 0 0 - 1
cats+ Current averaging time scale for wci, in terms of mean wave periods 4.0 1.0 - 50.0 Trep
ci+ Mass coefficient in shields inertia term 1.0 0.5 - 1.5
cm Mass coefficient in shields inertia term 1.5 0.0 - 3.0
cmax+ Maximum allowed sediment concentration 0.1 0.0 - 1.0
compi Imaginary unit -123
correctHm0 Switch to enable hm0 correction 1 0 - 1
cyclic Turn on cyclic boundary conditions 0 0 - 1
defuse Turn on timestep explosion prevention mechanism 1 0 - 1
delta+ Fraction of wave height to add to water depth 0.0 0.0 - 1.0
deltar Estimated ripple height 0.025 0.001 - 1.0
depfile* Name of the input bathymetry file <file>
depthscale+ Depthscale of (lab)test simulat, affects eps, hmin, hswitch and dzma 1.0 1.0 - 200.0
dilatancy Switch to reduce critical shields number due dilatancy 0 0 - 1
dir0 Mean wave direction for instat = stat, bichrom, ts_1 or ts_2 (nautical convention) 270.0 -360.0 - 360.0 deg
disch_loc_file+ Name of discharge locations file <file>
disch_timeseries_file+ Name of discharge timeseries file <file>
dispc+ Coefficient in front of the vertical pressure gradient -1.0 0.1 - 2.0 ?
drifterfile Name of drifter data file <file>
dryslp Critical avalanching slope above water (dz/dx and dz/dy) 1.0 0.1 - 2.0
dt Computational time step, in hydrodynamic time -123 s
dtbc+ Timestep used to describe time series of wave energy and long wave flux at offshore boundary (not affected by morfac) 1.0 0.1 - 2.0 s
dtheta* Directional resolution 10.0 0.1 - 180.0 deg
dthetaS_XB+ The (counter-clockwise) angle in the degrees needed to rotate from the x-axis in swan to the x-axis pointing east 0.0 -360.0 - 360.0 deg
dtheta_s* Directional resolution in case of stationary refraction 10.0 0.1 - 20.0 deg
dtset Fixed timestep, overrides use of cfl 0.0 0.001 - 100.0
dwetlayer+ Thickness of the top soil layer interacting more freely with the surface water 0.1 0.01 - 1.0 m
dx* Regular grid spacing in x-direction -1.0 0.0 - 1000000000.0 m
dy* Regular grid spacing in y-direction -1.0 0.0 - 1000000000.0 m
dzg1+ Thickness of top sediment class layers par%dzg1 0.01 - 1.0 m
dzg2+ Nominal thickness of variable sediment class layer par%dzg1 0.01 - 1.0 m
dzg3+ Thickness of bottom sediment class layers par%dzg1 0.01 - 1.0 m
dzmax+ Maximum bed level change due to avalanching 0.05 0.0 - 1.0 m/s/m
eps Threshold water depth above which cells are considered wet 0.005 0.001 - 0.1 m
eps_sd Threshold velocity difference to determine conservation of energy head versus momentum 0.5 0.0 - 1.0 m/s
epsi+ Ratio of mean current to time varying current through offshore boundary -1.0 -1.0 - 0.2
facAs+ Calibration factor time averaged flows due to wave asymmetry 0.1 0.0 - 1.0
facDc+ Option to control sediment diffusion coefficient 1.0 0.0 - 1.0
facSk+ Calibration factor time averaged flows due to wave skewness 0.1 0.0 - 1.0
facrun Calibration coefficient for short wave runup 1.0 0.0 - 2.0
facsd Fraction of the local wave length to use for shoaling delay depth 1.0 0.0 - 2.0
facsl+ Factor bedslope effect 1.6 0.0 - 1.6
facua+ Calibration factor time averaged flows due to wave skewness and asymmetry 0.1 0.0 - 1.0
fallvelred Switch to reduce fall velocity for high concentrations 0 0 - 1
fcutoff+ Low-freq cutoff frequency for instat = jons, swan or vardens boundary conditions 0.0 0.0 - 40.0 Hz
flow Turn on flow calculation 1 0 - 1
form Equilibrium sediment concentration formulation vanthiel_vanrijn soulsby_vanrijn, vanthiel_vanrijn, vanrijn1993
frac_dz+ Relative thickness to split time step for bed updating 0.7 0.5 - 0.98
freewave+ Switch for free wave propagation 0 = use cg (default); 1 = use sqrt(gh) in instat = ts_2 0 0 - 1
friction_acceleration Turn on or off the effect of acceleration on bed roughness (morrison) none none, mccall, nielsen
friction_infiltration Turn on or off the effect of infiltration on bed roughness (conley and inman) 0 0 - 1
friction_turbulence Turn on or off the effect of turbulence on bed roughness (reniers van thiel) 0 0 - 1
front Switch for seaward flow boundary abs_2d abs_1d, abs_2d, wall, wlevel, nonh_1d, waveflume
fwcutoff Depth greater than which the bed friction factor is not applied 1000.0 0.0 - 1000.0
g Gravitational acceleration 9.81 9.7 - 9.9 ms^-2
gamma Breaker parameter in baldock or roelvink formulation 0.55 0.4 - 0.9
gamma2 End of breaking parameter in roelvink daly formulation 0.3 0.0 - 0.5
gamma_turb Calibration factor for turbulence contribution to bed roughness 1.0 0.0 - 2.0
gammax+ Maximum ratio wave height to water depth 2.0 0.4 - 5.0
gridform Grid definition format xbeach xbeach, delft3d
gw0+ Level initial groundwater level 0.0 -5.0 - 5.0 m
gw0file+ Name of initial groundwater level file <file>
gwReturb+ Reynolds number for start of turbulent flow in case of gwscheme = turbulent 100.0 1.0 - 600.0
gwfastsolve Reduce full 2d non-hydrostatic solution to quasi-explicit in longshore direction 0 0 - 1
gwflow+ Turn on groundwater flow 0 0 - 1
gwheadmodel+ Model to use for vertical groundwater head parabolic parabolic, exponential
gwhorinfil+ Switch to include horizontal infiltration from surface water to groundwater 0 0 - 1
gwnonh+ Switch to turn on or off non-hydrostatic pressure for groundwater 0 0 - 1
gwscheme+ Scheme for momentum equation laminar laminar, turbulent
hmin Threshold water depth above which stokes drift is included 0.2 0.001 - 1.0 m
hotstartflow+ Switch for hotstart flow conditions with pressure gradient balanced by wind and bed stress 0 0 - 1
hswitch+ Water depth at which is switched from wetslp to dryslp 0.1 0.01 - 1.0 m
hwci+ Minimum depth until which wave-current interaction is used 0.1 0.001 - 1.0 m
hwcimax+ Maximum depth until which wave-current interaction is used 100.0 0.01 - 100.0 m
instat Old wave boundary condition type bichrom stat, bichrom, ts_1, ts_2, jons, swan, vardens, reuse, ts_nonh, off, stat_table, jons_table
irhog8 ^-1 -123 N^-1m^3
jetfac Option to mimic turbulence production near revetments 0.0 0.0 - 1.0
kdmin+ Minimum value of kd (pi/dx > min(kd)) 0.0 0.0 - 0.05
kmax Number of sigma layers in quasi-3d model; kmax = 1 is without vertical structure of flow and suspensions 100 1 - 1000
kx+ Darcy-flow permeability coefficient in x-direction 0.0001 1e-05 - 0.1 ms^-1
ky+ Darcy-flow permeability coefficient in y-direction 0.0001 1e-05 - 0.1 ms^-1
kz+ Darcy-flow permeability coefficient in z-direction 0.0001 1e-05 - 0.1 ms^-1
lat+ Latitude at model location for computing coriolis 0.0 -90.0 - 90.0 deg
lateralwave Switch for lateral boundary at left neumann neumann, wavecrest, cyclic
left Switch for lateral boundary at ny+1 neumann neumann, wall, no_advec, neumann_v, abs_1d
lsgrad Factor to include longshore transport gradient in 1d simulationsdsy/dy=lsgrad*sy; dimension 1/length scale of longshore gradients 0.0 -0.1 - 0.1 1/m
lwave Turn on short wave forcing on nlsw equations and boundary conditions 1 0 - 1
lws+ Switch to enable long wave stirring 1 0 - 1
lwt+ Switch to enable long wave turbulence 0 0 - 1
m Power in cos^m directional distribution for instat = stat, bichrom, ts_1 or ts_2 10 2 - 128
maxbrsteep+ Maximum wave steepness criterium 0.4 0.3 - 0.8
maxdtfac Maximum increase/decrease in time stp in explosion prevention mechanism 500.0 100.0 - 1000.0
maxerror+ Maximum wave height error in wave stationary iteration 0.0005 1e-05 - 0.001 m
maxiter+ Maximum number of iterations in wave stationary 500 2 - 1000
merge+ Merge threshold for variable sediment layer (ratio to nominal thickness) 0.01 0.005 - 0.1
mmpi+ Number of domains in cross-shore direction when manually specifying mpi domains 2 1 - 100
morfac Morphological acceleration factor 1.0 0.0 - 1000.0
morfacopt+ Switch to adjusting output times for morfac 1 0 - 1
morphology Turn on morphology 1 0 - 1
morstart Start time morphology, in morphological time 0.0 0.0 - par%tstop s
morstop Stop time morphology, in morphological time 2000.0 0.0 - 10000000.0 s
mpiboundary+ Fix mpi boundaries along y-lines, x-lines, use manual defined domains or find shortest boundary automatically auto auto, x, y, man
n+ Power in roelvink dissipation model 10.0 5.0 - 20.0
nc Smoothing distance for estimating umean (defined as nr of cells) par%ny+1 1 - par%ny+1
ncfilename+ Xbeach netcdf output file name <file>
nd+ Number of computational layers in the bed 3 3 - 1000
nd_var+ Index of layer with variable thickness 2 1 - par%nd
ndischarge+ Number of discharge locations par%ndischarge 0 - 100
ndrifter Number of drifers par%ndrifter 0 - 50
ne_layer Name of file containing thickness of the erodible layer <file>
ngd Number of sediment classes 1 1 - 20
nglobalvar Number of global output variables (as specified by user) -1 -1 - 20
nhbreaker+ Non-hydrostatic breaker model 2 0 - 2
nhlay+ Layer distribution in the nonhydrostatic model, default = 0.33 0.33 0.0 - 1.0
nmax+ Maximum ratio of cg/c for computing long wave boundary conditions 0.8 0.5 - 1.0
nmeanvar Number of mean, min, max, var output variables 0 0 - 15
nmpi+ Number of domains in alongshore direction when manually specifying mpi domains 4 1 - 100
nonh+ Turn on non-hydrostatic pressure: 0 = nswe, 1 = nsw + non-hydrostatic pressure compensation stelling & zijlema, 2003 0 0 - 1
nonhq3d Turn on or off the the reduced two-layer nonhydrostatic model, default = 0 0 0 - 1
nonhspectrum+ Spectrum format for wave action balance of nonhydrostatic waves 0 0 - 1
npoints Number of output point locations 0 0 - 50
npointvar Number of point output variables 0 0 - 50
nrugauge Number of output runup gauge locations 0 0 - 50
nrugdepth+ Number of depths to compute runup in runup gauge 1 1 - 10
nsetbathy+ Number of prescribed bed updates 1 1 - 1000
nship+ Number of ships -123
nspectrumloc+ Number of input spectrum locations 1 1 - par%ny+1
nspr Switch to enable long wave direction forced into centres of short wave bins 0 0 - 1
ntdischarge+ Length of discharge time series par%ntdischarge 0 - 100
nuh Horizontal background viscosity 0.1 0.0 - 1.0 m^2s^-1
nuhfac+ Viscosity switch for roller induced turbulent horizontal viscosity 1.0 0.0 - 1.0
nuhv Longshore viscosity enhancement factor, following svendsen (?) 1.0 1.0 - 20.0
nveg Number of vegetation species -123
nx* Number of computational cell corners in x-direction 50 2 - 10000
ny* Number of computational cell corners in y-direction 2 0 - 10000
nz Number of computational cells in z-direction 1 1 - 100
oldhu Switch to enable old hu calculation 0 0 - 1
order+ Switch for order of wave steering,first order wave steering (short wave energy only), second oder wave steering (bound long wave corresponding to short wave forcing is added) 2.0 1.0 - 2.0
outputformat+ Output file format fortran fortran, netcdf, debug
outputprecision Switch between single and double precision output in netcdf double single, double
paulrevere Specifies tide on sea and land or two sea points if tideloc = 2 land land, sea
phit+ Phase lag angle in nielsen transport equation 25.0 0.0 - 90.0
por Porosity 0.4 0.3 - 0.5
pormax Max porosity used in the experession of van rhee 0.5 0.3 - 0.6
posdwn Bathymetry is specified positive down (1) or positive up (-1) 1.0 -1.0 - 1.0
projection+ Projection string
px Pi 4.d0*atan(1.d0)
q3d Turn on quasi-3d sediment transport 0 0 - 1
random+ Switch to enable random seed for instat = jons, swan or vardens boundary conditions 1 0 - 1
reformsteep+ Wave steepness criterium to reform after breaking 0.25d0*par%maxbrsteep 0.0 - 0.95d0*par%maxbrsteep
remdryoutput Remove dry output points from output data of zs etc. 1 0 - 1
reposeangle Angle of internal friction 30.0 0.0 - 45.0 deg
rfb+ Switch to feed back maximum wave surface slope in roller energy balance, otherwise rfb = par%beta 0 0 - 1
rheeA A parameter in the van rhee expression 0.75 0.75 - 2.0
rho Density of water 1025.0 1000.0 - 1040.0 kgm^-3
rhoa+ Air density 1.25 1.0 - 2.0 kgm^-3
rhog8 1/8*rho*g -123 Nm^-3
rhos Solid sediment density (no pores) 2650.0 2400.0 - 2800.0 kgm^-3
right Switch for lateral boundary at 0 neumann neumann, wall, no_advec, neumann_v, abs_1d
roller+ Switch to enable roller model 1 0 - 1
rotate Rotate output as postprocessing with given angle 1 0 - 1
rt Duration of wave spectrum at offshore boundary, in morphological time min(3600.d0,par%tstop) 1200.0 - 7200.0 s
rwave User-defined wave roughness adjustment factor 2.0 0.1 - 10.0
scheme+ Numerical scheme for wave propagation warmbeam upwind_1, lax_wendroff, upwind_2, warmbeam
secbrsteep+ Secondary maximum wave steepness criterium 0.5d0*par%maxbrsteep 0.0 - 0.95d0*par%maxbrsteep
secorder+ Use second order corrections to advection/non-linear terms based on maccormack scheme 0 0 - 1
sedtrans Turn on sediment transport 1 0 - 1
setbathy Turn on timeseries of prescribed bathy input 0 0 - 1
setbathyfile*+ Name of prescribed bed update file <file>
shipfile Name of ship data file <file>
ships+ Turn on ship waves 0 0 - 1
shoaldelay Switch to enable shoaling delay 0 0 - 1
sigfac Dsig scales with log(sigfac) 1.3 0.0 - 10.0
single_dir+ Turn on stationary model for refraction, surfbeat based on mean direction 0 0 - 1
smag+ Switch for smagorinsky subgrid model for viscocity 1 0 - 1
smax+ Maximum shields parameter for equilibrium sediment concentration acc. diane foster -1.0 -1.0 - 3.0
snells+ Turn on snell’s law for wave refraction 0 0 - 1
solver+ Solver used to solve the linear system tridiag sip, tridiag
solver_acc+ Accuracy with respect to the right-hand side usedin the following termination criterion: ||b-ax || < acc*||b|| 0.005 1e-05 - 0.1
solver_maxit+ Maximum number of iterations in the linear sip solver 30 1 - 1000
solver_urelax+ Underrelaxation parameter 0.92 0.5 - 0.99
sourcesink+ Switch to enable source-sink terms to calculate bed level change rather than suspended transport gradients 0 0 - 1
split+ Split threshold for variable sediment layer (ratio to nominal thickness) 1.01 1.005 - 1.1
sprdthr+ Threshold ratio to maximum value of s above which spectrum densities are read in 0.08 0.0 - 1.0
struct Switch for enabling hard structures 0 0 - 1
sus+ Calibration factor for suspensions transports 1 0 - 1
swave Turn on short waves 1 0 - 1
swkhmin Minimum kh value to include in wave action balance, lower included in nlswe (default -1.d0) -0.01 -0.01 - 0.35
swrunup Turn on short wave runup 0 0 - 1
sws+ Switch to enable short wave and roller stirring and undertow 1 0 - 1
t Computational time, in hydrodynamic time -123 s
taper Spin-up time of wave boundary conditions, in morphological time 100.0 0.0 - 1000.0 s
thetamax* Higher directional limit (angle w.r.t computational x-axis) 90.0 -360.0 - 360.0 deg
thetamin* Lower directional limit (angle w.r.t computational x-axis) -90.0 -360.0 - 360.0 deg
thetanaut Switch to specify thetamin and thetamax in nautical convention rather than cartesian 0 0 - 1
thetanum+ Coefficient determining whether upwind (1) or central scheme (0.5) is used. 1.0 0.5 - 1.0
tideloc Number of corner points on which a tide time series is specified 0 0 - 4
tidetype+ Switch for offfshore boundary, velocity boundary or instant water level boundary velocity instant, velocity
timings+ Switch enable progress output to screen 1 0 - 1
tintc+ Interval time of cross section output -123 s
tintg Interval time of global output 1.0 0.01 - par%tstop-par%tstart s
tintm Interval time of mean, var, max, min output par%tstop-par%tstart 1.0 - par%tstop-par%tstart s
tintp Interval time of point and runup gauge output 1.0 0.01 - par%tstop-par%tstart s
tnext Next time point for output or wave stationary calculation, in hydrodynamic time -123 s
trepfac+ Compute mean wave period over energy band: par%trepfac*maxval(sf) for instat jons, swan or vardens; converges to tm01 for trepfac = 0.0 and 0.01 0.0 - 1.0
tsfac+ Coefficient determining ts = tsfac * h/ws in sediment source term 0.1 0.01 - 1.0
tsglobal+ Name of file containing timings of global output
tsmean+ Name of file containing timings of mean, max, min and var output
tspoints+ Name of file containing timings of point output
tstart Start time of output, in morphological time 0.0 0.0 - par%tstop s
tstop* Stop time of simulation, in morphological time 2000.0 1.0 - 1000000.0 s
tunits+ Time units in udunits format (seconds since 1970-01-01 00:00:00.00 +1:00) s
turb+ Switch to include short wave turbulence wave_averaged none, wave_averaged, bore_averaged
turbadv+ Switch to activate turbulence advection model for short and or long wave turbulence none none, lagrangian, eulerian
umin Threshold velocity for upwind velocity detection and for vmag2 in equilibrium sediment concentration 0.0 0.0 - 0.2 m/s
vardx Switch for variable grid spacing 0 0 - 1
vegcanflo Include incanopy flow [1] or not [0] 0 0 - 1
vegetation+ Turn on interaction of waves and flow with vegetation 0 0 - 1
veggiefile Name of veggie species list file
veggiemapfile Name of veggie species map file
vegnonlin Include non-linear wave effect [1] or not [0] 0 0 - 1
veguntow Include undertow in phase-averaged vegetati 1 0 - 1
vicmol Molecular viscosity 1e-06 0.0 - 0.001
viscosity Include viscosity in flow solver 1 0 - 1
vonkar Von karman constant 0.4 0.01 - 1.0
waveform Wave shape model vanthiel ruessink_vanrijn, vanthiel
wavemodel Stationary (0), surfbeat (1) or non-hydrostatic (2) surfbeat stationary, surfbeat, nonh
wavfriccoef Wave friction coefficient -123
wavfricfile Wave friction file <file>
wavint Interval between wave module calls (only in stationary wave mode) 60.0 1.0 - 3600.0 s
wbctype New wave boundary condition type params params, parametric, swan, vardens, off, jonstable, reuse, ts_1, ts_2, ts_nonh
wbcversion Version of wave boundary conditions 3 1 - 3
wci Turns on wave-current interaction 0 0 - 1
wearth+ Angular velocity of earth calculated as: 1/rotation_time (in hours) 1.d0/24.d0 0.0 - 1.0 hour^-1
wetslp Critical avalanching slope under water (dz/dx and dz/dy) 0.3 0.1 - 1.0
wind Include wind in flow solver 1 0 - 1
windfile Name of file with non-stationary wind data <file>
windth Nautical wind direction, in case of stationary wind 270.0 -360.0 - 360.0 deg
windv Wind velocity, in case of stationary wind 0.0 0.0 - 200.0 ms^-1
ws Average fall velocity (is computed in morphevolution) 0.02d0 m/s
xfile Name of the file containing x-coordinates of the calculation grid <file>
xori X-coordinate of origin of axis 0.0 -1000000000.0 - 1000000000.0 m
xyfile* Name of the file containing delft3d xy-coordinates of the calculation grid <file>
yfile Name of the file containing y-coordinates of the calculation grid <file>
yori Y-coordinate of origin of axis 0.0 -1000000000.0 - 1000000000.0 m
z0+ Zero flow velocity level in soulsby and van rijn (1997) sediment concentration 0.006 0.0001 - 0.05 m
zs0 Inital water level 0.0 -5.0 - 5.0 m
zs0file Name of tide boundary condition series <file>
zsinitfile Name of inital water level file <file>