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

...

The long list is constructed based on parsing the params.F90 file for settings and removing any parameters that are either case-dependent input (e.g. Hm0) or irrelevant (ships, groundwater flow, etc.). The following parameters are excluded from the long list:

{div:style=
Div
Wiki Markup
style
height:250px;overflow:auto;
} {
Code Block
:
language
=none|linenumbers=true|title=XBeach parameter exclude list}
none
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
{code} {
}{div:style=
Div
Wiki Markup
style
height:250px;overflow:auto;
} {
Code Block
:
language
=none|linenumbers=true|title=XBeach parameter long list}
none
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
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} {div}

Marginal sensitivity analysis

...

Some parameters show no influence at all. This might be due to the fact that a parameter is only applicable to a part of XBeach that is not enabled by default. But it might also mean that there is no influence at all in the case simulated. The zero-influence parameters are discussed below.

{div:style=
Div
Wiki Markup
style
height:250px;overflow:auto;
} {
Code Block
:
language
=none|linenumbers=true|title=
none
titleZero-influence
parameters
}
linenumberstrue

fwcutoff                       # Depth greater than which the bed friction factor is NOT applied
hwci                           # Minimum depth until which wave-current interaction is used
jetfac                         # Option to mimic turbulence production near revetments [0..1]
dtbc                           # Timestep used to describe time series of wave energy and long wave flux at offshore boundary (not affected by morfac)
sigfac                         # dsig scales with log(sigfac). Default = 1.3
gamma2                         # End of breaking parameter in break = 4 formulation
lwt                            # Switch 0/1 long wave turbulence
waveform                       # Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009
facsd                          # fraction of the local wave length to use for shoaling delay depth
z0                             # Zero flow velocity level in Soulsby van Rijn (1997) sed.conc. expression
betad                          # Dissipation parameter long wave breaking turbulence
correctHm0                     # Turn off or on Hm0 correction
BRfac                          # Calibration factor surface slope
bed                            # Calibration factor for bed transports [0..1]
{code} {
}{div:style=
Div
Wiki Markup
style
height:250px;overflow:auto;
} {
Code Block
:
language
=none|linenumbers=true|title=
none
titleZero-influence
parameters
(explanations)
}
linenumberstrue

fwcutoff                       # ? relevant for all
hwci                           # only relevant for wci=1, default is wci=0
jetfac                         # only relevant for swrunup=1, default is swrunup=0
dtbc                           # ? relevant for all
sigfac                         # only relevant for kmax>1, default is kmax=1
gamma2                         # ? relevant for break=roelvink1 or break=roelvink2, default is break=roelvink2
lwt                            # ? relevant for turbulence computation, which is the default
waveform                       # only possible when turb!=bore_averaged, default is turb=bore_averaged
facsd                          # only relevant for shoaldelay=1, default is shoaldelay=0
z0                             # only relevant for form=soulsby_vanrijn, default is form=vanthiel_vanrijn
betad                          # only relevant for lwt=1, default is lwt=0
correctHm0                     # ? relevant for all
BRfac                          # only relevant for rfb=1, default is rfb=0
bed                            # only relevant for bulk=0, default is bulk=1
{code} {div}
Proposed short list
Code Block
languagenone
titleXBeach parameter long list
linenumberstrue
gamma                          # Breaker parameter in Baldock or Roelvink formulation
facAs                          # Calibration factor time averaged flows due to wave 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
gammax                         # Maximum ratio wave height to water depth
cf                             # Friction coefficient flow

...