Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Div
styleheight:250px;overflow:auto;
Code Block
languagenone
titleXBeach parameter exclude list
linenumberstrue
D50                            # D50 grain size per grain type
D90                            # D90 grain size per grain type
Hrms                           # Hrms wave height for instat = 0,1,2,3
Tlong                          # Wave group period for case instat = 1
Tm01switch                     # Turn off or on Tm01 or Tm-10 switch
Topt                           # Absolute period to optimize coefficient
Trep                           # Representative wave period for instat = 0,1,2,3
alfa                           # Angle of x-axis from East
aquiferbot                     # Level of uniform aquifer bottom
aquiferbotfile                 # Name of the aquifer bottom file
avalanching                    # Include avalanching (1) or exclude (0)
back                           # Switch for boundary at bay side, 0 = radiating boundary (Ad), 1 = reflective boundary; uu=0
bcfile                         # Name of spectrum file
bchwiz                         # Use beachwizard, 0 = beachwizard off, 1 beachwizard on, bed update off, 2 beachwiz on, bed update on. (also requires morphology == 1)
bedfricfile                    # Bed friction file (only valid with values of C)
bedfriction                    # Bed friction formulation: 'chezy','white-colebrook'
compi                          # Imaginary unit
depfile                        # Name of the input bathymetry file
dir0                           # Mean wave direction (Nautical convention) for instat = 0,1,2,3
disch_loc_file                 # Name of discharge locations file
disch_timeseries_file          # Name of discharge timeseries file
drifterfile                    # Name of drifter data file
dt                             # Computational time step, in hydrodynamic time
dthetaS_XB                     # The (counter-clockwise) angle in the degrees needed to rotate from the x-axis in SWAN to the x-axis pointing East
dx                             # Regular grid spacing in x-direction
dy                             # Regular grid spacing in y-direction
dzg1                           # Thickness of top sediment class layers
dzg2                           # Nominal thickness of variable sediment class layer
dzg3                           # Thickness of bottom sediment class layers
flow                           # Include flow calculation (1), or exclude (0)
freewave                       # Switch for free wave propagation 0 = use cg (default); 1 = use sqrt(gh) in instat = 3
front                          # Switch for seaward flow boundary: 0 = radiating boundary(Ad), 1 = Van Dongeren, 1997
g                              # Gravitational acceleration
globalvars                     # Mnems of global output variables, not per se the same sice as nglobalvar (invalid variables, defaults)
gridform                       # Swicth to read in grid bathy files with 'XBeach' or 'Delft3D' format respectively
gw0                            # Level initial groundwater level
gw0file                        # Name of initial groundwater level file
gwReturb                       # Reynolds number for start of turbulent flow in case of gwscheme = turbulent
gwfastsolve                    # Reduce full 2D non-hydrostatic solution to quasi-explicit in longshore direction
gwflow                         # Turn on (1) or off (0) groundwater flow module
gwheadmodel                    # Model to use for vertical groundwater head: 'parabolic' (default), or 'exponential'
gwhorinfil                     # switch to include horizontal infiltration from surface water to groundwater (default = 0)
gwnonh                         # Switch to turn on or off non-hydrostatic pressure for groundwater
gwscheme                       # Scheme for momentum equation (laminar, turbulent)
hotstartflow                   # Switch to hotstart flow conditions with pressure gradient balanced by wind and bed stress
instat                         # Wave boundary condtion type
kmax                           # Number of sigma layers in Quasi-3D model; kmax = 1 (default) is without vertical structure of flow and suspensions
kx                             # Darcy-flow permeability coefficient in x-direction [m/s]
ky                             # Darcy-flow permeability coefficient in y-direction [m/s]
kz                             # Darcy-flow permeability coefficient in z-direction [m/s]
lat                            # Latitude at model location  for computing Coriolis
left                           # Switch for lateral boundary at ny+1, 'neumann' = vv computed from NSWE, 'wall' = reflective wall; vv=0
leftwave                       # old name for lateralwave
lwave                          # Include short wave forcing on NLSW equations and boundary conditions (1), or exclude (0)
maxiter                        # Maximum number of iterations in wave stationary
meanvars                       # Mnems of mean output variables (by variables)
mmpi                           # Number of domains in m direction (cross-shore) when manually specifying mpi domains
morfac                         # Morphological acceleration factor
morfacopt                      # Option indicating whether times should be adjusted (1) or not(0) for morfac
morphology                     # Include morphology (1) or exclude (0)
morstart                       # Start time morphology, in morphological time
morstop                        # Stop time morphology, in morphological time
mpiboundary                    # Fix mpi boundaries along y-lines ('y'), x-lines ('x'), use manual defined domains ('man') or find shortest boundary ('auto')
ncfilename                     # xbeach netcdf output file name
ncross                         # Number of output cross sections
nd                             # Number of computational layers in the bed
nd_var                         # Index of layer with variable thickness
ndischarge                     # Number of discharge locations
ndrifter                       # Number of drifers
ne_layer                       # Name of file containing depth of hard structure
ngd                            # Number of sediment classes
nglobalvar                     # Number of global output variables (as specified by user)
nhbreaker                      # Turn on or off nonhydrostatic breaker model
nmeanvar                       # Number of mean,min,max,var output variables
nmpi                           # Number of domains in n direction (alongshore) when manually specifying mpi domains
nonh                           # Non-hydrostatic pressure option: 0 = NSWE, 1 = NSW + non-hydrostatic pressure compensation Stelling & Zijlema, 2003
nonhspectrum                   # Switch between spectrum format for wave action balance of nonhydrostatic waves
npoints                        # Number of output point locations
npointvar                      # Number of point output variables
nrugauge                       # Number of output runup gauge locations
nship                          # Number of ships
nspectrumloc                   # Number of input spectrum locations
nspr                           # nspr = 1 long wave direction forced into centres of short wave bins, nspr = 0 regular long wave spreadin
ntdischarge                    # Length of discharge time series
nveg                           # Number of vegetation species
nx                             # Number of computiation cell corners in x-direction
ny                             # Number of computiation cell corners in y-direction
oldhu                          # Turn on / off old hu calculation
oldnyq                         # Turn off or on old nyquist switch
outputformat                   # Choice of output file format: 'netcdf', 'fortran', or 'debug'
paulrevere                     # Specifies tide on sea and land ('land') or two sea points ('sea') if tideloc = 2
pointtypes                     # Point types (0 = point, 1=rugauge)
pointvars                      # Mnems of point output variables (by variables)
posdwn                         # Bathymetry is specified positive down (1) or positive up (-1)
projection                     # projection string
px                             # Pi
q3d                            # Turn on (1) or off (0) quasi-3D sediment transport module
random                         # Random seed on (1) or off (0) for instat = 4,5,6 boundary conditions
rho                            # Density of water
rhoa                           # Air density
rhog8                          # 1/8*rho*g
rhos                           # Solid sediment density (no pores)
right                          # Switch for lateral boundary at right, 0 = vv computed from NSWE, 1 = reflective wall; vv=0
rightwave                      # old name for lateralwave
rotate                         # Rotate (1) postprocess output with the rotate function.
rt                             # Duration of wave spectrum at offshore boundary, in morphological time
sedtrans                       # Include sediment transport (1) or exclude (0)
shipfile                       # Name of ship data file
ships                          # Turn on (1) or off (0) ship waves
solver                         # Solver used to solve the linear system, sip, or tridiag (only for 1d)
solver_maxit                   # Maximum number of iterations in the linear sip solver
struct                         # Switch for hard structures
swave                          # Include short waves (1), exclude short waves (0)
swrunup                        # Turn on (1) or off (0) short wave runup
t                              # Computational time, in hydrodynamic time
taper                          # Spin-up time of wave boundary conditions, in morphological time
thetamax                       # Higher directional limit (angle w.r.t computational x-axis)
thetamin                       # Lower directional limit (angle w.r.t computational x-axis)
thetanaut                      # Thetamin,thetamax in cartesian (0) or nautical convention (1)
thetanum                       # Coefficient determining whether upwind (1) or central scheme (0.5) is used.
tideloc                        # Number of corner points on which a tide time series is specified
tidetype                       # Switch for offfshore boundary, velocity boundary or instant water level boundary (default)
timings                        # Switch to turn on (1) or off (0) progress output to screen
tintc                          # Interval time of cross section output
tintg                          # Interval time of global output
tintm                          # Interval time of mean,var,max,min output
tintp                          # Interval time of point and runup gauge output
tnext                          # Next time point for output or wave stationary calculation, in hydrodynamic time
tscross                        # Name of file containing timings of cross section output
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
tstop                          # Stop time of simulation, in morphological time
tunits                         # Units can be defined in udunits format (seconds since 1970-01-01 00:00:00.00 +1:00)
vardx                          # Switch for variable grid spacing: 1 = irregular spacing, 0 = regular grid spacing
vegetation                     # Turn on (1) or off (0) interaction of waves and flow with vegetation
vegiefile                      # Name of vegie species list file
vegiemapfile                   # Name of vegie species map file
wbcversion                     # Version of wave boundary conditions
wearth                         # Angular velocity of earth calculated as: 1/rotation_time (in hours), later changed in calculation code to rad/s
windfile                       # Name of file with non-stationary wind data
windth                         # Nautical wind direction, in case of stationary wind
windv                          # Wind velocity, in case of stationary wind
xfile                          # Name of the file containing x-coordinates of the calculation grid
xori                           # X-coordinate of origin of axis
xyfile                         # Name of the file containing (Delft3D) xy-coordinates of the calculation grid
yfile                          # Name of the file containing y-coordinates of the calculation grid
yori                           # Y-coordinate of origin of axis
zs0                            # Inital water level
zs0file                        # Name of tide boundary condition series
zsinitfile                     # Name of inital condition file zs

Also added the following parameters to ignore list, because of zero-influence:
nrugdepth                      # of depths to compute runup in runup gauge
breakviscfac                   # Factor to increase viscosity during breaking
maxerror                       # Maximum wave height error in wave stationary iteration
facrun                         # calibration coefficient for short wave runup
maxbrsteep                     # Maximum wave steepness criterium
Tm01                           # Old name for Trep
split                          # Split threshold for variable sediment layer (ratio to nominal thickness)
wavint                         # Interval between wave module calls (only in stationary wave mode)
depthscale                     # depthscale of (lab)test simulated. 1 = default, which corresponds to teh real world (nature)
breakvisclen                   # Ratio between local depth and length scale in extra breaking viscosity
dtheta                         # Directional resolution
nsetbathy                      # Number of prescribed bed updates
frac_dz                        # Relative thickness to split time step for bed updating
setbathy                       # Provide timeseries of prescribed bathy input, 0 = off (default), 1 = on
oldwbc                         # (1) Use old version wave boundary conditions for instat 4,5,6
m                              # Power in cos^m directional distribution for instat = 0,1,2,3
Cd                             # Wind drag coefficient
merge                          # Merge threshold for variable sediment layer (ratio to nominal thickness)
ARC                            # Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly (non) reflective
facua                          # Calibration factor time averaged flows due to wave skewness and asymmetry
Div
styleheight:250px;overflow:auto;
Code Block
languagenone
titleXBeach parameter long list
linenumberstrue
BRfac                          # Calibration factor surface slope
C                              # Chezy coefficient
CFL                            # Maximum Courant-Friedrichs-Lewy number
Tbfac                          # Calibration factor for bore interval Tbore: Tbore = Tbfac*Tbore
Tsmin                          # Minimum adaptation time scale in advection diffusion equation sediment
alpha                          # Wave dissipation coefficient in Roelvink formulation
bed                            # Calibration factor for bed transports [0..1]
beta                           # Breaker slope coefficient in roller model
betad                          # Dissipation parameter long wave breaking turbulence
break                          # Type of breaker formulation (1=roelvink, 2=baldock, 3=roelvink adapted, 4=roelvink on/off breaking)
breakerdelay                   # Turn on (1) or off (0) breaker delay model
bulk                           # Option to compute bedload and suspended load seperately; 0 = seperately, 1 = bulk (as in previous versions)
cats                           # Current averaging time scale for wci, in terms of mean wave periods
cf                             # Friction coefficient flow
cmax                           # Maximum allowed sediment concentration
correctHm0                     # Turn off or on Hm0 correction
delta                          # Fraction of wave height to add to water depth
dispc                          # Coefficient in front of the vertical pressure gradient, Default = 1.
dryslp                         # Critical avalanching slope above water (dz/dx and dz/dy)
dtbc                           # Timestep used to describe time series of wave energy and long wave flux at offshore boundary (not affected by morfac)
dwetlayer                      # Thickness of the top soil layer interacting more freely with the surface water
dzmax                          # Maximum bedlevel change due to avalanching
eps                            # Threshold water depth above which cells are considered wet
eps_sd                         # Threshold velocity difference to determine conservation of energy head vs momentum
epsi                           # Ratio of mean current to time varying current through offshore boundary
facAs                          # Calibration factor time averaged flows due to wave asymmetry
facDc                          # Option to control sediment diffusion coefficient [0..1]
facSk                          # Calibration factor time averaged flows due to wave skewness
facsd                          # fraction of the local wave length to use for shoaling delay depth
facsl                          # Factor bedslope effect
facua                          # Calibration factor time averaged flows due to wave skewness and asymmetry
fcutoff                        # Low-freq cutoff frequency for instat = 4,5,6 boundary conditions
form                           # Equilibrium sed. conc. formulation: 1 = Soulsby van Rijn, 1997, 2 = Van Rijn 2008 with modifications by Van Thiel
fw                             # Bed friction factor
fwcutoff                       # Depth greater than which the bed friction factor is NOT applied
gamma                          # Breaker parameter in Baldock or Roelvink formulation
gamma2                         # End of breaking parameter in break = 4 formulation
gammax                         # Maximum ratio wave height to water depth
hmin                           # Threshold water depth above which Stokes drift is included
hswitch                        # Water depth at which is switched from wetslp to dryslp
hwci                           # Minimum depth until which wave-current interaction is used
jetfac                         # Option to mimic turbulence production near revetments [0..1]
kdmin                          # Minimum value of kd ( pi/dx > minkd )
lws                            # 1 = long wave stirring, 0 = no long wave stirring
lwt                            # Switch 0/1 long wave turbulence
n                              # Power in Roelvink dissipation model
nc                             # Smoothing distance (defined as nr of cells) for estimating umean
nmax                           # maximum ratio of cg/c fro computing long wave boundary conditions
nuh                            # Horizontal background viscosity
nuhfac                         # Viscosity switch for roller induced turbulent horizontal viscosity
nuhv                           # Longshore viscosity enhancement factor, following Svendsen (?)
order                          # 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)
por                            # Porosity
reformsteep                    # Wave steepness criterium to reform after breaking
rfb                            # If rfb = 1 then maximum wave surface slope is feeded back in roller energy balance; else rfb = par%Beta
roller                         # Turn on (1) or off(0) roller model
rugdepth                       # Minimum depth for determination of last wet point in runup gauge
scheme                         # Use first-order upwind (upwind_1), second order upwind (upwind_2) or Lax-Wendroff (lax_wendroff)
secbrsteep                     # Secondary maximum wave steepness criterium
secorder                       # Use second order corrections to advection/non-linear terms based on MacCormack scheme
sedcal                         # Sediment transport calibration coefficient per grain type
setbathyfile                   # Name of prescribed bed update file
shoaldelay                     # Turn on (1) or off (0) shoaling delay
sigfac                         # dsig scales with log(sigfac). Default = 1.3
smag                           # Switch for smagorinsky subgrid model for viscocity
smax                           # Being tested: maximum Shields parameter for ceq Diane Foster
snells                         # Turn on (1) or off (0) Snell's law for wave refraction
solver_acc                     # accuracy with respect to the right-hand side used
solver_urelax                  # Underrelaxation parameter
sourcesink                     # In suspended transport use source-sink terms to calculate bed level change (1) or sus transport gradients (0)
sprdthr                        # Threshold ratio to maxval of S above which spec dens are read in (default 0.08*maxval)
sus                            # Calibration factor for suspensions transports [0..1]
sws                            # 1 = short wave & roller stirring and undertow, 0 = no short wave & roller stirring and undertow
trepfac                        # Compute mean wave period over energy band: par%trepfac*maxval(Sf) for instat 4,5,6; converges to Tm01 for trepfac = 0.0 and
tsfac                          # Coefficient determining Ts = tsfac * h/ws in sediment source term
turb                           # Switch to include short wave turbulence:
turbadv                        # Switch 0/1 to activate turbulence advection model for short and or long wave turbulence
ucrcal                         # Critical velocity calibration coefficient per grain type
umin                           # Threshold velocity for upwind velocity detection and for vmag2 in eq. sediment concentration
waveform                       # Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009
wci                            # Turns on (1) or off (0) wave-current interaction
wetslp                         # Critical avalanching slope under water (dz/dx and dz/dy)
z0                             # Zero flow velocity level in Soulsby van Rijn (1997) sed.conc. expression

...

Code Block
languagenone
titleXBeach parameter long list
linenumberstrue
deltagamma                          # FractionBreaker ofparameter wavein heightBaldock toor add to water depth
facuaRoelvink formulation
facAs                          # Calibration factor time averaged flows due to wave skewness and asymmetry
facAs                          # Calibration factor time averaged flows due to wave asymmetry
asymmetry
fw                             # Bed friction factor
beta                           # Breaker slope coefficient in roller model
alpha                          # Wave dissipation coefficient in Roelvink formulation
wetslp                                      # Critical avalanching slope under water (dz/dx and dz/dy)
facSk                          # Calibration factor time averaged flows due to wave skewness
hmin  gammax                         # ThresholdMaximum waterratio depthwave aboveheight whichto Stokes drift is included
hswitchwater depth
cf                        # Water depth at which is# switchedFriction from wetslp to dryslpcoefficient flow

Expert panel

  • Dano Roelvink
  • Ad Reniers
  • Jaap van Thiel de Vries
  • Robert McCall
  • Ap van Dongeren
  • Gerben Ruessink
Invitation

  • Kees den Heijer
  • Arnold van Rooijen
  • Joost den Bieman
  • ...
Invitation

Dear Dear XBeach expert,

Deltares is reconsidering the default settings of XBeach for the use of XBeach as advanced assessment model for the Dutch coast. As scientific developer or advanced XBeach user we would like your opinion on this subject.

...

Best regards,
Bas Hoonhout
Pieter van Geer
http://publicwiki.deltares.nl/display/XBEACH/Default+settings

...

  • structures
  • short-wave runup
  • shoaling delay
  • breaker delay
  • wave-current interaction
  • long-wave stirring
  • long-wave turbulence

Python toolbox

In order to efficiently perform the workflow described above, some Python tools have been developed. The toolbox is available through the OpenEarthTools repository: https://svn.oss.deltares.nl/repos/openearthtools/trunk/python/applications/xbeach/default_settings. A IPython notebook is available at the same location that illustrates the simple workings of the toolbox.

The main functions are as follows:

Code Block
languagepython

import default_settings

# read and write an overview of available XBeach parameters
default_settings.filesys.write_overview('all_params.txt')
ignore_params = default_settings.filesys.read_overview('ignore_params.txt')

# include dependencies and exclude parameters read from ignore list
dependencies = {'hwci' : {'wci' : 1},
'jetfac' : {'swrunup' : 1},
'waveform' : {'turb' : 'wave_averaged'},
'facsd' : {'shoaldelay' : 1},
'z0' : {'form' : 'soulsby_vanrijn'},
'betad' : {'lwt' : 1},
'BRfac' : {'rfb' : 1},
'bed' : {'bulk' : 0}}

params = default_settings.xbeach.get_parameters(dependencies=dependencies)
params_longlist = {k:v for k,v in params.iteritems() if k not in params_ignored}

# write models for marginal sensitivity analysis
default_settings.filesys.write_models(params_longlist, overwrite=False)

# run models for marginal sensitivity analysis
default_settings.filesys.run_models(overwrite=False)

# monitor model progress
default_settings.filesys.stat_models()

# read erosion volumes above SSL
V = default_settings.filesys.read_volumes()

# plot sensitivity
fig, axs = default_settings.plot.plot_volumes(V, params=params)
fig, axs = default_settings.plot.plot_sensitivity(V, params=params)