Page History

...

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:

collapse

Div

style	height:250px;overflow:auto;

Code Block

linenumbers
language	none
title	XBeach parameter exclude list

true

	true


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

Code Block

language	none
title	XBeach parameter long list
linenumbers	true
collapse	true

ARC


Also added the following parameters to ignore list, because of zero-influence:
nrugdepth

#

Switch

for

active

reflection

compensation

of

at

depths

seaward

to

boundary:

compute

0

runup

=

in

reflective, 1 = weakly (non) reflective BRfac

runup gauge
breakviscfac                   # Factor to increase viscosity during breaking
maxerror

#

Calibration

factor

surface

slope C

              # Maximum wave height error in wave stationary iteration
facrun

#

Chezy

coefficient CFL

               # calibration coefficient for short

# Maximum Courant-Friedrichs-Lewy number Cd

wave runup
maxbrsteep                     # Maximum wave

# Wind drag coefficient Tbfac

steepness criterium
Tm01                           #

Calibration

Old

factor

name for

bore interval Tbore: Tbore = Tbfac*Tbore Tsmin

Trep
split                          # Split

Minimum

threshold

adaptation

for

time

variable

scale

sediment

in

layer

advection

(ratio

diffusion

to

equation

nominal

sediment

thickness)

alpha

wavint                         #

Wave

Interval

dissipation

between

coefficient

wave

in

module

Roelvink formulation bed

calls (only in stationary wave mode)
depthscale                     # depthscale

# Calibration factor for bed transports [0..1] beta

of (lab)test simulated. 1 = default, which corresponds to teh real world (nature)
breakvisclen                   # Ratio between local

#

depth

Breaker

and

slope

length

coefficient

scale in extra

roller

breaking

model

viscosity

betad

dtheta

Dissipation

Directional

parameter

resolution
nsetbathy

long

wave

breaking

turbulence break

                  # Number of prescribed bed updates
frac_dz

#

Type

of

breaker

formulation

(1=roelvink,

2=baldock,

3=roelvink

adapted,

4=roelvink

on/off

breaking) breakerdelay

          # Relative thickness to split time step for bed

#

updating
setbathy

Turn

on

(1)

or

off

(0)

breaker

delay

model breakviscfac

            # Provide timeseries of prescribed bathy input,

#

Factor

to increase viscosity during breaking breakvisclen

off (default), 1 = on
oldwbc

#

Ratio

between

local

depth

and

length

scale

(1)

in

Use

extra

old

breaking

version

viscosity bulk

wave boundary conditions for instat 4,5,6
m

#

Option

to

compute

bedload

and

suspended

load

seperately;

0

Power

=

in

seperately,

cos^m

1

directional

=

distribution

bulk

for

(as

instat

in previous versions) cats

= 0,1,2,3
Cd

#

Current

averaging

time

Wind

scale for wci, in terms of mean wave periods cf

drag coefficient
merge                          #

Friction

Merge

coefficient

threshold

flow cmax

for variable sediment layer (ratio to nominal thickness)
ARC

#

Maximum

allowed

sediment

concentration correctHm0

    # Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly

# Turn off or on Hm0 correction delta

(non) reflective
facua                          #

Fraction

Calibration

of

factor

wave

time

height

averaged

to

flows

add

due to

water

wave

depth depthscale

skewness and asymmetry

Div

style	height:250px;overflow:auto;

Code Block

language	none
title	XBeach parameter long list
linenumbers	true


BRfac

#

depthscale

of

(lab)test

simulated.

1

=

default,

which

corresponds

to

teh

Calibration

real

factor

world

surface

(nature)

slope

dispc

#

Coefficient

in

front

of

the

Chezy

vertical

coefficient
CFL

pressure

gradient,

Default

=

1. dryslp

                       # Maximum

# Critical avalanching slope above water (dz/dx and dz/dy) dtbc

Courant-Friedrichs-Lewy number
Tbfac                          # Calibration factor for bore interval Tbore: Tbore

# Timestep used to describe time series of wave energy and long wave flux at offshore boundary (not affected by morfac) dtheta

= Tbfac*Tbore
Tsmin                          # Minimum adaptation time scale in advection diffusion equation sediment
alpha

#

Directional

resolution dwetlayer

               # Wave dissipation coefficient in Roelvink formulation
bed

#

Thickness

of

the

top

soil

layer

interacting

more

freely

with

the

surface

water dzmax

              # Calibration factor for bed transports [0..1]
beta

#

Maximum

bedlevel

change

due

to

avalanching eps

               # Breaker slope coefficient in roller model
betad

#

Threshold

water

depth

above

which

cells

are

considered

wet eps_sd

          # Dissipation parameter long wave breaking turbulence
break

#

Threshold

velocity

difference

to

determine

conservation

of

energy

head

vs

momentum epsi

   # Type of breaker formulation (1=roelvink, 2=baldock, 3=roelvink adapted, 4=roelvink on/off breaking)
breakerdelay

#

Ratio

of

mean

current

to

time

varying

Turn

current

on

through

(1)

offshore

or

boundary facAs

off (0) breaker delay model
bulk

#

Calibration

factor

time

averaged

flows

due

Option to

wave

compute

asymmetry facDc

bedload and suspended load seperately; 0 = seperately, 1 = bulk (as in previous versions)
cats

#

Option

to

control

sediment

diffusion

coefficient

[0..1] facSk

        # Current averaging time scale for wci, in terms of mean wave periods
cf

#

Calibration

factor

time

averaged

flows

due

to

wave

skewness facrun

              # Friction coefficient flow
cmax

#

calibration

coefficient

for

short

wave

runup facsd

             # Maximum allowed sediment concentration
correctHm0

#

fraction

of

the

local

wave

length

to

use

for

shoaling

delay

depth facsl

# Turn off or on Hm0 correction
delta

#

Factor

bedslope

effect facua

   # Fraction of wave height to add to water depth
dispc

#

Calibration

factor

time

averaged

flows

due

to

wave

skewness

and

asymmetry fcutoff

 # Coefficient in front of the vertical pressure gradient, Default = 1.
dryslp

#

Low-freq

cutoff

frequency

for

instat

=

4,5,6

boundary

conditions form

    # Critical avalanching slope above water (dz/dx and dz/dy)
dtbc

#

Equilibrium

sed.

conc.

formulation:

1

=

Soulsby

van

Rijn,

1997,

2

=

Van

Timestep

Rijn

used

2008

to

with

describe

modifications

time

by

series

Van Thiel frac_dz

of wave energy and long wave flux at offshore boundary (not affected by morfac)
dwetlayer

#

Relative

thickness

to

split

time

step

for

bed

updating fw

 # Thickness of the top soil layer interacting more freely with the surface water
dzmax

#

Bed

friction

factor fwcutoff

        # Maximum bedlevel change due to avalanching
eps

#

Depth

greater

than

which

the

bed

friction

factor

is

NOT

applied gamma

        # Threshold water depth above which cells are considered wet
eps_sd

#

Breaker

parameter

in

Baldock

or

Roelvink

formulation gamma2

         # Threshold velocity difference to determine conservation of energy head vs momentum
epsi

#

End

of

breaking

parameter

in

break

=

4

formulation gammax

             # Ratio of mean current to time varying current through offshore boundary
facAs

#

Maximum

ratio

wave

height

to

water

depth hmin

                  # Calibration factor time averaged flows due to wave

#

asymmetry
facDc

Threshold

water

depth

above

which

Stokes

drift

is

included hswitch

                 # Option to control sediment diffusion

# Water depth at which is switched from wetslp to dryslp hwci

coefficient [0..1]
facSk                          # Calibration factor time averaged flows due to wave skewness
facsd

#

Minimum

depth

until

which

wave-current

interaction

is

used jetfac

                # fraction of the local wave length to use

#

for

Option

shoaling

to

delay

mimic

depth
facsl

turbulence

production

near

revetments

[0..1] kdmin

                     # Factor bedslope effect
fcutoff

#

Minimum

value

of

kd

(

pi/dx

>

minkd

) lws

             # Low-freq cutoff frequency for instat = 4,5,6 boundary conditions
form

#

1

=

long

wave

stirring,

0

=

no

long

wave

stirring lwt

          # Equilibrium sed. conc. formulation: 1 = Soulsby van Rijn, 1997, 2 = Van Rijn 2008 with modifications

#

by

Switch 0/1 long wave turbulence m

Van Thiel
fw                             # Bed friction factor
fwcutoff

#

Power

in

cos^m

directional

distribution

for

instat =

0,1,2,3 maxbrsteep

              # Depth greater than which the bed

#

friction

Maximum

factor

wave

is

steepness

NOT

criterium

applied

maxerror

gamma

#

Maximum

wave

height

Breaker

error

parameter in

wave

Baldock or

stationary

Roelvink

iteration

formulation

merge

gamma2                         #

Merge

End

threshold

of

for

breaking

variable

parameter

sediment

in

layer

break

(ratio

to nominal thickness) n

4 formulation
gammax                         # Maximum ratio wave height

#

to

Power in Roelvink dissipation model nc

water depth
hmin                           #

Smoothing

Threshold

distance

water

(defined

depth

as

above

nr

which

of

Stokes

cells)

drift

for

is

estimating umean nmax

included
hswitch                        #

maximum

Water

ratio

depth

of

at

cg/c

which

fro

is

computing

switched

long

from

wave

wetslp

boundary

to

conditions

dryslp

nrugdepth

hwci

#

Number

of

depths

to compute runup in runup gauge nsetbathy

 # Minimum depth until which wave-current interaction is used
jetfac                         # Option

Number

to

of

mimic

prescribed

turbulence

bed

production

updates nuh

near revetments [0..1]
kdmin                          #

Horizontal

Minimum

background

value

viscosity nuhfac

of kd ( pi/dx > minkd )
lws

#

Viscosity

switch

for

roller

induced

turbulent

horizontal

viscosity nuhv

 # 1 = long wave stirring, 0 = no long wave stirring
lwt

#

Longshore

viscosity

enhancement

factor,

following

Svendsen

(?) order

      # Switch 0/1 long wave turbulence
n

#

Switch

for

order

of

wave

steering,

1

=

first

order

wave

steering

(short

wave

energy

only),

Power

2

in

=

Roelvink

second

dissipation

oder wave steering (bound long wave correspon\ ding to short wave forcing is added) por

model
nc                             # Smoothing distance (defined as nr of cells) for estimating

# Porosity

umean

reformsteep

nmax

#

Wave

steepness

criterium

to

reform

after

breaking rfb

# maximum ratio of cg/c fro computing long wave boundary conditions
nuh

#

If

rfb

=

1

then

maximum

wave

surface

slope

is

feeded

Horizontal

back

background

in

viscosity
nuhfac

roller

energy

balance;

else

rfb

=

par%Beta roller

                  # Viscosity switch for roller induced

# Turn on (1) or off(0) roller model rugdepth

turbulent horizontal viscosity
nuhv                           # Longshore viscosity enhancement

#

factor,

Minimum

following

depth for determination of last wet point in runup gauge scheme

Svendsen (?)
order                          # Switch for order of wave steering,

#

Use

= first

-

 order wave

upwind

steering (

upwind_1

short wave energy only),

second

order

upwind (upwind_2) or Lax-Wendroff (lax_wendroff) secbrsteep

second oder wave steering (bound long wave corresponding to short wave forcing is added)
por

#

Secondary

maximum

wave

steepness

criterium secorder

           # Porosity
reformsteep

#

Use

second

order

corrections

to

advection/non-linear

terms

based

on

MacCormack

Wave

scheme sedcal

steepness criterium to reform after breaking
rfb

#

Sediment

transport

calibration

coefficient

per

grain

type setbathy

 # If rfb = 1 then maximum wave surface slope is feeded back in roller energy balance; else rfb = par%Beta
roller

#

Provide

timeseries

of

prescribed

bathy

input,

0

=

off

(default),

1

=

on setbathyfile

          # Turn on (1) or off(0) roller model
rugdepth

#

Name

of

prescribed

bed

update

file shoaldelay

               # Minimum depth for determination of

#

last

Turn

wet

on

point

(1)

in

or off (0) shoaling delay sigfac

runup gauge
scheme                         #

dsig

Use

scales

first-order

with

upwind

log

sigfac

upwind_1)

.

Default

second

= 1.3 smag

order upwind (upwind_2) or Lax-Wendroff (lax_wendroff)
secbrsteep                     #

Switch

Secondary

for

maximum

smagorinsky

wave

subgrid model for viscocity smax

steepness criterium
secorder                       # Use second order

#

corrections

Being tested: maximum Shields parameter for ceq Diane Foster snells

to advection/non-linear terms based on MacCormack scheme
sedcal                         #

Turn

Sediment

on (1) or off (0) Snell's law for wave refraction solver_acc

transport calibration coefficient per grain type
setbathyfile                   # Name of prescribed bed update file
shoaldelay

#

accuracy

with

respect

to

the

right-hand

side

used solver_urelax

            # Turn on (1) or off

#

(0)

Underrelaxation

shoaling

parameter

delay

sourcesink

sigfac

# In

suspended

transport

use

source-sink

terms

to

dsig

calculate

scales

bed level change (1) or sus transport gradients (0) split

with log(sigfac). Default = 1.3
smag

Split

Switch

threshold

for

variable

smagorinsky

sediment

subgrid

layer

model

(ratio to nominal thickness) sprdthr

for viscocity
smax

#

Threshold

ratio

to

maxval

Being

of

tested:

S

maximum

above

Shields

which

parameter

spec

for

dens

ceq

are

Diane

read

Foster
snells

in

(default

0.08*maxval) sus

                      # Turn on (1) or off

# Calibration factor

(0) Snell's law for

suspensions transports [0..1] sws

wave refraction
solver_acc                     # accuracy with respect to the right-hand

# 1 = short wave & roller stirring and undertow, 0 = no short wave & roller stirring and undertow trepfac

side used
solver_urelax                  # Underrelaxation parameter
sourcesink                     # In suspended

# 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

transport use source-sink terms to calculate bed level change (1) or sus transport gradients (0)
sprdthr                        # Threshold ratio to maxval of

#

Coefficient

above

determining

which

Ts

spec

=

dens

tsfac * h/ws

are read in

sediment source term turb

(default 0.08*maxval)
sus                            #

Switch

Calibration

to

factor

include

for

short

suspensions

wave turbulence: turbadv

transports [0..1]
sws

#

Switch

0/1

to

activate

turbulence

advection model

for

short

and or long

 wave

turbulence ucrcal

& roller stirring and undertow, 0 = no short wave & roller stirring and undertow
trepfac

#

Critical

velocity

calibration

coefficient

per

grain

type umin

      # 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

#

Threshold

velocity

for

upwind

velocity

detection

and

for

vmag2

in

eq.

sediment

concentration waveform

           # Coefficient determining Ts = tsfac * h/ws in sediment source term
turb

#

Option

for

waveshape

model:

1

=

Ruessink

&

Van

Rijn,

2

=

Van

Thiel

de

Vries,

2009 wavint

         # Switch to include short wave turbulence:
turbadv

#

Interval

between

wave

module

calls

(only

in

stationary

wave

mode) wci

    # Switch 0/1 to activate turbulence advection model for short and or long wave turbulence
ucrcal

#

Turns

on

(1)

or

off

(0)

wave-current

interaction wetslp

       # Critical velocity calibration coefficient per grain type
umin

#

Critical

avalanching

slope

under

water

(dz/dx

and

dz/dy) z0

        # Threshold velocity for upwind velocity detection and for vmag2 in eq. sediment concentration
waveform                       # Option for

Zero

waveshape

flow

model:

velocity

level

in

Ruessink

Soulsby

van Rijn (1997) sed.conc. expression

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

Marginal sensitivity Marginal sensitivity analysis

The marginal sensitivity analysis is performed using a default dune profile and representative settings for the Dutch coast (normative conditions). Using this model, a single parameter is varied over the applicable range of values. The default values are always included. The sensitivity is subsequently determined by looking at the variation in erosion volume depending on that parameter setting.

Preliminary results are as follows. The first plot shows for each varied parameter the variation in erosion volume above SSL. The black dot indicates the default value. The red line indicates a linear fit excluding any outliers. The second plot shows the minimum and maximum erosion volumes found when varying a parameter over it's valid range of values. The plot is ordered based on the difference between the minimum and maximum value found. Some parameters

Image Added
Image Added

Zero-influence parameters

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. Image Removed
Image Removed

Expert panel

Dano Roelvink
Ad Reniers
Jaap van Thiel de Vries
Robert McCall
Ap van Dongeren

Short list

Variation matrix

Resolution vs. dimensions

We can choose either to vary a large number of parameters (dimensions) using a limited resolution or vary a small number of parameters using a high resolution.

Cases

Deltaflume ?
Deltaflume 2006
Boers ?
1953 storm surge

Result

Discussion

Several topics within this workflow are still being discussed. These discussions are briefly mentioned below.

Performance indicators

XBeach allows a variety of performance indicators to be used to compare the performance of one set of settings against another. For example, a profile comparison with measured data may be used by computing a BSS score. The BSS score itself, however, is subject to discussion for this purpose. Moreover, comparison data is often obtained from flume experiments on scale. These experiments use scaling rules that are derived by comparing erosion profiles rather than profile shape. The profile shape for these tests can thus not be used. For now, we use the erosion volume above SSL as performance indicator. Another advantage of this indicator is that it relates well to other calibration studies for dune assessment models in the Netherlands.

Scaling

...

. 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	height:250px;overflow:auto;

Code Block

language	none
title	Zero-influence parameters
linenumbers	true


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]

Div

style	height:250px;overflow:auto;

Code Block

language	none
title	Zero-influence parameters (explanations)
linenumbers	true


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

Proposed short list

Code Block

language	none
title	XBeach parameter long list
linenumbers	true


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

Expert panel

Dano Roelvink
Ad Reniers
Jaap van Thiel de Vries
Robert McCall
Ap van Dongeren
Gerben Ruessink
Kees den Heijer
Arnold van Rooijen
Joost den Bieman
...

Invitation

—

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.

XBeach provides about 250 parameters to be set by the user. Many of those are related to case-specific input or are related to processes and functionalities that are not relevant for the application as assessment model for the Dutch coast. Discarding all these parameters, still a long list of over 80 parameters will be available to the user.

An assessment model is supposed to be suitable for application by ordinary users. Therefore we would like to minimise the fraction of these 80+ parameters exposed to these users, preferably by a 100% so that only case-specific data is to be provided by the user. In order to do so, we need to offer a default set of parameter settings that are applicable for dune assessment computations along the Dutch coast. We intend to derive such default set of parameters by systematically varying the parameter settings for a selected set of validation cases that are representative for the Dutch coast. Ultimately we will pick the set of parameters that resembles the validation measurements best.

Systematic variation of a set of 80+ parameters is, however, unfeasible. Only if we would pick 2 values per parameter and a single validation case it would take a zillion years to run the necessary computations. Therefore the first step is to eliminate the long list of 80+ parameters to a short list of less than 10 parameters based on expert judgement. This is where your help is appreciated.

Attached to this e-mail you will find a list of the 80+ relevant XBeach parameters. We would like you to assign 25 points to the parameters that should, according to you, be considered in the systematic variation. Optionally, you may indicate a value range for each parameter. We will divide about 10.000 XBeach simulations over the parameters that received the most points. The number of parameters is not set beforehand. We will consider including more parameters (dimensions) over including more variations per parameter (resolution). Parameters that are not included will be set to their current default value.

As a guidance, we also attached two plots that provide some insight in the (marginal) sensitivity of XBeach for the 80+ parameters found in the list. The marginal sensitivity is determined by running a 1D XBeach simulation using a schematised profile representative for the Dutch coast and normative storm conditions representative for the location Hoek van Holland. During each simulation only a single parameter is varied within it's applicable range. Some parameters depend on others (hwci, jetfac, waveform, facsd, z0, betad, BRfac, bed). In these cases both parameters are set, but only the parameter of interest is varied within it's range.

The first plot shows the sensitivity of the erosion volume above SSL for each parameter over it's valid range of values. The black dot depicts the default value. The red line is a linear fit excluding outliers. The second plot shows the range of erosion volumes found when varying each parameter, again excluding outliers. The second plot is ordered based on the variation of erosion volumes found. Outliers are excluded since they often correspond to valid, but unrealistic values (e.g. dzmax=0).

Please use these plots as guidance only. The plots are generated using a single model set-up only and not representative for all cases that should be taken into consideration. Also some parameters with large influence are not good candidates for systematic variation. For example, the parameter "sus" has a large influence, but it is probably not a good idea to calibrate XBeach turning suspended sediment transport on or off. On the other hand, it might not be so useful to include a parameter to the short list that has no influence at all.

A few remarks on the continuation of this calibration effort might be important to your input:

We only consider 1D cases (transects)
We only consider erosion volumes above SSL as performance indicator (we will look at profiles separately, later on)
We will scale the validation cases to prototype scale and run XBeach at that scale (we will look into scaling issues separately, later on)
We do not include the depthscale parameter in this study (it is always 1), but we will include the parameters set by the depthscale parameter (we will look into scaling issues seperately, later on)
We exclude the following processes / functionalities from calibration beforehand:
- vegetation
- wind
- ships
- non-hydrostatic
- drifters
- mpi
- morfac
- discharge
- groundwater flow
- beach wizard
- sediment fractions
- stationary wave solver

Your input is highly appreciated. You can provide your point assignments by a reply to this e-mail. Any list in any regular file format will do.
If you do not wish to participate, or if you will not be able to provide your input before May, 15th 2014, please let is know.

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

—

Short list

Variation matrix

Resolution vs. dimensions

We can choose either to vary a large number of parameters (dimensions) using a limited resolution or vary a small number of parameters using a high resolution.

Cases

Deltaflume ?
Deltaflume 2006
Boers ?
1953 storm surge

Result

Discussion

Several topics within this workflow are still being discussed. These discussions are briefly mentioned below.

Performance indicators

XBeach allows a variety of performance indicators to be used to compare the performance of one set of settings against another. For example, a profile comparison with measured data may be used by computing a BSS score. The BSS score itself, however, is subject to discussion for this purpose. Moreover, comparison data is often obtained from flume experiments on scale. These experiments use scaling rules that are derived by comparing erosion profiles rather than profile shape. The profile shape for these tests can thus not be used. For now, we use the erosion volume above SSL as performance indicator. Another advantage of this indicator is that it relates well to other calibration studies for dune assessment models in the Netherlands.

Scaling

Comparison with data is often done using data obtained from flume experiments. These experiments are performed on scale. XBeach allows us to simulate the experiment at the scale of the experiment rather than on a 1:1 scale. As for now, this is not done for two reasons. First, the scaling within XBeach is still subject to discussion. Second, other calibration studies for dune assessment models also first scaled the experiment results and then performed the calibration.

Depthscale

The depthscale parameter is subject to discussion and should preferably be omitted. It is therefore not part of the long list. A separate study will investigate the scaling performance in XBeach.

Processes / functionalities

What processes / functionalities do we include? Probably not the following:

vegetation
wind
ships
non-hydrostatic
drifters
mpi
morfac
discharge
groundwater flow
beach wizard
sediment fractions
stationary wave solver

But what about:

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

language	python


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)

Space shortcuts

Child pages

Versions Compared

Old Version 13

New Version Current

Key

Marginal sensitivity Marginal sensitivity analysis

Zero-influence parameters

Expert panel

Short list

Variation matrix

Resolution vs. dimensions

Cases

Result

Discussion

Performance indicators

Scaling

Proposed short list

Expert panel

Invitation

Short list

Variation matrix

Resolution vs. dimensions

Cases

Result

Discussion

Performance indicators

Scaling

Depthscale

Processes / functionalities

Python toolbox