Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Bed composition parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

rhos

kgm^-3

(error)

(error)

 

Solid sediment density (no pores)

(error)

2650

2400

2800

(par.sedtrans==1)

ngd

-

(error)

(error)

 

Number of sediment classes

(error)

1

1

20

 

nd

-

(tick)

(error)

nd_var

Number of computational layers in the bed

dzg1(error)

m

Thickness of top sediment class layers

dzg2

m

Nominal thickness of variable sediment class layer

dzg3

m

Thickness of bottom sediment class layers

por

-

Porosity

D50

m

D50 grain size per grain type

D90

m

D90 grain size per grain type

sedcal

-

Sediment transport calibration coefficient per grain type

ucrcal

-

Critical velocity calibration coefficient per grain type

Bed update numerics parameters

frac_dz

-

Relative thickness to split time step for bed updating

nd_var

-

Index of layer with variable thickness

split

-

Split threshold for variable sediment layer (ratio to nominal thickness)

merge

-

Merge threshold for variable sediment layer (ratio to nominal thickness)

Constants, not read in params.txt

px

-

Pi

compi

-

Imaginary unit

rhog8

Nm^-3

1/8*rho*g

Coriolis force parameters

wearth

hour^-1

Angular velocity of earth calculated as: 1/rotation_time (in hours), later changed in calculation code to rad/s

lat

deg

Latitude at model location for computing Coriolis

Discharge boundary conditions

disch_loc_file

-

Name of discharge locations file

disch_timeseries_file

-

Name of discharge timeseries file

Drifters parameters

ndrifter

-

Number of drifers

drifterfile

-

Name of drifter data file

Flow boundary condition parameters

front

-

Switch for seaward flow boundary: 0 = radiating boundary(Ad), 1 = Van Dongeren, 1997

left

-

Switch for lateral boundary at ny+1, 'neumann' = vv computed from NSWE, 'wall' = reflective wall; vv=0

right

-

Switch for lateral boundary at right, 0 = vv computed from NSWE, 1 = reflective wall; vv=0

back

-

Switch for boundary at bay side, 0 = radiating boundary (Ad), 1 = reflective boundary; uu=0

ARC

-

Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly (non) reflective

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)

carspan

-

Switch for Carrier-Greenspan test 0 = use cg (default); 1 = use sqrt(gh) in instat = 3 for c&g tests

epsi

-

Ratio of mean current to time varying current through offshore boundary

tidetype

-

Switch for offfshore boundary, velocity boundary or instant water level boundary (default)

Flow numerics parameters

eps

m

Threshold water depth above which cells are considered wet

umin

m/s

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

hmin

m

Threshold water depth above which Stokes drift is included

secorder

-

Use second order corrections to advection/non-linear terms based on mcCormack scheme

oldhu

-

Turn on / off old hu calculation

Flow parameters

bedfriction

-

Bed friction formulation: 'chezy','white-colebrook'

bedfricfile

-

Bed friction file (only valid with values of C)

C

m^0.5s^-1

Chezy coefficient

cf

-

Friction coefficient flow

nuh

m^2s^-1

Horizontal background viscosity

nuhfac

-

Viscosity switch for roller induced turbulent horizontal viscosity

nuhv

-

Longshore viscosity enhancement factor, following Svendsen (question)

smag

-

Switch for smagorinsky subgrid model for viscocity

Grid parameters

depfile

-

Name of the input bathymetry file

posdwn

-

Bathymetry is specified positive down (1) or positive up (-1)

nx

-

Number of computiation cell corners in x-direction

ny

-

Number of computiation cell corners in y-direction

alfa

deg

Angle of x-axis from East

vardx

-

Switch for variable grid spacing: 1 = irregular spacing, 0 = regular grid spacing

dx

m

Regular grid spacing in x-direction

dy

m

Regular grid spacing in y-direction

xfile

name

Name of the file containing x-coordinates of the calculation grid

yfile

name

Name of the file containing y-coordinates of the calculation grid

xori

m

X-coordinate of origin of axis

yori

m

Y-coordinate of origin of axis

thetamin

deg

Lower directional limit (angle w.r.t computational x-axis)

thetamax

deg

Higher directional limit (angle w.r.t computational x-axis)

dtheta

deg

Directional resolution

thetanaut

-

Thetamin,thetamax in cartesian (0) or nautical convention (1)

Groundwater parameters

kx

ms^-1

Darcy-flow permeability coefficient in x-direction m/s

ky

ms^-1

Darcy-flow permeability coefficient in y-direction m/s

kz

ms^-1

Darcy-flow permeability coefficient in z-direction m/s

dwetlayer

m

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

aquiferbot

m

Level of uniform aquifer bottom

aquiferbotfile

-

Name of the aquifer bottom file

gw0

m

Level initial groundwater level

gw0file

-

Name of initial groundwater level file

Initial conditions

zs0

m

Inital water level

zsinitfile

name

Name of inital condition file zs

MPI parameters

mpiboundary

-

Fix mpi boundaries along y-lines ('y'), x-lines ('x'), or find shortest boundary ('auto')

Model time

tstop

s

Stop time of simulation, in morphological time

CFL

-

Maximum Courant-Friedrichs-Lewy number

tunits

-

Units can be defined in udunits format (seconds since 1970-01-01 00:00:00.00 +1:00)

Morphology parameters

morfac

-

Morphological acceleration factor

morfacopt

-

Option indicating whether times should be adjusted (1) or not(0) for morfac

morstart

s

Start time morphology, in morphological time

morstop

s

Stop time morphology, in morphological time

wetslp

-

Critical avalanching slope under water (dz/dx and dz/dy)

dryslp

-

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

hswitch

m

Water depth at which is switched from wetslp to dryslp

dzmax

m/s/m

Maximum bedlevel change due to avalanching

struct

-

Switch for hard structures

ne_layer

name

Name of file containing depth of hard structure

Non-hydrostatic correction parameters

solver_maxit

-

Maximum number of iterations in the linear SIP solver

solver_acc

-

accuracy with respect to the right-hand side usedin the following termination criterion:||b-Ax || < acc*||b||

solver_urelax

-

Underrelaxation parameter

solver

-

Solver used to solve the linear system, 1=SIP, 2=TRIDIAG (only for 1d)

kdmin

-

Minimum value of kd ( pi/dx > minkd )

dispc

?

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

Topt

s

Absolute period to optimize coefficient

Output variables

timings

-

Switch to turn on (1) or off (0) progress output to screen

tstart

s

Start time of output, in morphological time

tint

s

Interval time of global output (replaced by tintg)

tintg

s

Interval time of global output

tintp

s

Interval time of point and runup gauge output

tintc

s

Interval time of cross section output

tintm

s

Interval time of mean,var,max,min output

tsglobal

-

Name of file containing timings of global output

tspoints

-

Name of file containing timings of point output

tscross

-

Name of file containing timings of cross section output

tsmean

-

Name of file containing timings of mean, max, min and var output

nglobalvar

-

Number of global output variables (as specified by user)

globalvars

-

Mnems of global output variables, not per se the same sice as nglobalvar (invalid variables, defaults)

nmeanvar

-

Number of mean,min,max,var output variables

meanvars

-

Mnems of mean output variables (by variables)

npointvar

-

Number of point output variables

pointvars

-

Mnems of point output variables (by variables)

npoints

-

Number of output point locations

nrugauge

-

Number of output runup gauge locations

pointtypes

-

Point types (0 = point, 1=rugauge)

xpointsw

unknown

world x-coordinate of output points

ypointsw

unknown

world y-coordinate of output points

rugdepth

m

Minimum depth for determination of last wet point in runup gauge

ncross

-

Number of output cross sections

outputformat

-

Choice of output file format: 'netcdf', 'fortran', or 'debug'

ncfilename

-

xbeach netcdf output file name

projection

-

projection string

Physical constants

g

ms^-2

Gravitational acceleration

rho

kgm^-3

Density of water

depthscale

-

depthscale of (lab)test simulated. 1 = default, which corresponds to teh real world (nature)the follwing (numerical) parameters are scaled with the depth scale (see Brandenburg, 2010):eps = eps_default/depthscalehmin = hmin_default/depthscalehswitch = hswitch/depthscaledzmax = dzmax/depthscale**1.5d0Brandenburg concluded that also the following parameters potentially need to be scaled:wetslp, turb (suggested to turn off at depthscales<20) & ucr (distinguish ucr_bed load anducr_sus at depthscales<20)

Physical processes

swave

-

Include short waves (1), exclude short waves (0)

lwave

-

Include short wave forcing on NLSW equations and boundary conditions (1), or exclude (0)

flow

-

Include flow calculation (1), or exclude (0)

sedtrans

-

Include sediment transport (1) or exclude (0)

morphology

-

Include morphology (1) or exclude (0)

nonh

-

Non-hydrostatic pressure option: 0 = NSWE, 1 = NSW + non-hydrostatic pressure compensation Stelling & Zijlema, 2003

gwflow

-

Turn on (1) or off (0) groundwater flow module

q3d

-

Turn on (1) or off (0) quasi-3D sediment transport module

Q3D sediment transport parameters

vonkar

unknown

von Karman constant

vicmol

unknown

molecular viscosity

kmax

-

Number of sigma layers in Quasi-3D model; kmax = 1 (default) is without vertical structure of flow and suspensions

sigfac

-

dsig scales with log(sigfac). Default = 1.3

Roller parameters

roller

-

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

beta

-

Breaker slope coefficient in roller model

rfb

-

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

Sediment transport numerics parameters

thetanum

-

Coefficient determining whether upwind (1) or central scheme (0.5) is used.

sourcesink

-

In suspended transport use source-sink terms to calculate bed level change (1) or sus transport gradients (0)

Sediment transport parameters

waveform

-

Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009

form

-

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

sws

-

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

lws

-

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

BRfac

-

Calibration factor surface slope

facsl

-

Factor bedslope effect

z0

m

Zero flow velocity level in Soulsby van Rijn (1997) sed.conc. expression

smax

-

Being tested: maximum Shields parameter for ceq Diane Foster

tsfac

-

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

facua

-

Calibration factor time averaged flows due to wave skewness and asymmetry

facSk

-

Calibration factor time averaged flows due to wave skewness

facAs

-

Calibration factor time averaged flows due to wave asymmetry

turb

-

Equlibrium sediment concentration is computed as function of:none = no turbulence,

Tbfac

-

Calibration factor for bore interval Tbore: Tbore = Tbfac*Tbore

Tsmin

s

Minimum adaptation time scale in advection diffusion equation sediment

lwt

-

Switch 0/1 long wave turbulence model

betad

-

Dissipation parameter long wave breaking turbulence

swtable

-

Name of intra short wave assymetry and skewness table

sus

-

Calibration factor for suspensions transports 0..1

bed

-

Calibration factor for bed transports 0..1

bulk

-

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

Tide boundary conditions

zs0file

-

Name of tide boundary condition series

tideloc

-

Number of corner points on which a tide time series is specified

paulrevere

-

Specifies tide on sea and land ('land') or two sea points ('sea') if tideloc = 2if tideloc =>2, then this indicates where the time series are to beapplied. Input for tidal information to xbeach options (3):1. one tidal record --> specify tidal record everywhere2. two tidal records --> Need to specify keyword 'paulrevere'paulrevere=='land' implies to apply one tidal record toboth sea corners and one tidal record to both land cornerspaulrevere=='sea' implies to apply the first tidal record(column 2 in zs0input.dat) to the (x=1,y=1) sea corner andthe second tidal record (third column) to the (x=1,y=N) sea corner3. four tidal records --> Need to list tidal records inzs0input.dat in order of:(x=1,y=1)(x=1,y=N)(x=N,y=N)(x=N,y=1)NOTE: clockwise from (1,1) corner

Variables, not read in params.txt

dt

s

Computational time step, in hydrodynamic time

t

s

Computational time, in hydrodynamic time

tnext

s

Next time point for output or wave stationary calculation, in hydrodynamic time

Wave boundary condition parameters

instat

-

Wave boundary condtion type

taper

s

Spin-up time of wave boundary conditions, in morphological time

Hrms

m

Hrms wave height for instat = 0,1,2,3

Tm01

s

Old name for Trep

Trep

s

Representative wave period for instat = 0,1,2,3

Tlong

s

Wave group period for case instat = 1

dir0

deg

Mean wave direction (Nautical convention) for instat = 0,1,2,3

nmax

-

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

m

-

Power in cos^m directional distribution for instat = 0,1,2,3

lateralwave

-

Switch for lateral boundary at left, 'neumann' = E Neumann, 'wavefront' = along wave front

leftwave

-

old name for lateralwave

rightwave

-

old name for lateralwave

Wave breaking parameters

break

-

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

gamma

-

Breaker parameter in Baldock or Roelvink formulation

gamma2

-

End of breaking parameter in break = 4 formulation

alpha

-

Wave dissipation coefficient in Roelvink formulation

n

-

Power in Roelvink dissipation model

gammax

-

Maximum ratio wave height to water depth

delta

-

Fraction of wave height to add to water depth

fw

-

Bed friction factor

breakerdelay

-

Turn on (1) or off (0) breaker delay model

Wave numerics parameters

scheme

-

Use first-order upwind (upwind_1), second order upwind (upwind_2) or Lax-Wendroff (lax_wendroff)for wave propagation

wavint

s

Interval between wave module calls (only in stationary wave mode)

maxerror

m

Maximum wave height error in wave stationary iteration

maxiter

-

Maximum number of iterations in wave stationary

Wave-current interaction parameters

wci

-

Turns on (1) or off (0) wave-current interaction

hwci

m

Minimum depth until which wave-current interaction is used

cats

Trep

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

Wave-spectrum boundary condition parameters

bcfile

-

Name of spectrum file

random

-

Random seed on (1) or off (0) for instat = 4,5,6 boundary conditions

fcutoff

Hz

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

nspr

-

nspr = 1 long wave direction forced into centres of short wave bins, nspr = 0 regular long wave spreadin

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

sprdthr

-

Threshold ratio to maxval of S above which spec dens are read in (default 0.08*maxval)

oldwbc

-

(1) Use old version wave boundary conditions for instat 4,5,6

correctHm0

-

Turn off or on Hm0 correction

oldnyq

-

Turn off or on old nyquist switch

Tm01switch

-

Turn off or on Tm01 or Tm-10 switch

rt

s

Duration of wave spectrum at offshore boundary, in morphological time

dtbc

s

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

dthetaS_XB

deg

If SWAN input is not in nautical degrees, dthetaS_XB is the angle from SWAN x-axis to XBeach x-axis in cathesian degrees

Wind parameters

3

3

1000

 

dzg1

m

(tick)

(error)

dzg1 dzg2 dzg3

Thickness of top sediment class layers

(error)

0.1

0.01

1

(par.sedtrans==1)

 

 

 

 

 

 

(error)

par.dzg1

0.01

1

(par.sedtrans==1)

dzg2

m

(tick)

(error)

 

Nominal thickness of variable sediment class layer

(error)

par.dzg1

0.01

1

(par.sedtrans==1)

dzg3

m

(tick)

(error)

 

Thickness of bottom sediment class layers

(error)

par.dzg1

0.01

1

(par.sedtrans==1)

por

-

(error)

(error)

 

Porosity

(error)

0.4

0.3

0.5

(par.sedtrans==1)

D50

m

(error)

(error)

 

D50 grain size per grain type

(error)

0.0002

5e-005

0.0008

(par.sedtrans==1)

D90

m

(error)

(error)

 

D90 grain size per grain type

(error)

0.0003

0.0001

0.0015

(par.sedtrans==1)

sedcal

-

(tick)

(error)

 

Sediment transport calibration coefficient per grain type

(error)

1

0

2

(par.sedtrans==1)

ucrcal

-

(tick)

(error)

 

Critical velocity calibration coefficient per grain type

(error)

1

0

2

(par.sedtrans==1)

Bed update numerics parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

frac_dz

-

(tick)

(error)

 

Relative thickness to split time step for bed updating

(error)

0.7

0.5

0.98

(par.morphology==1)

nd_var

-

(tick)

(error)

 

Index of layer with variable thickness

(error)

2

2

par.nd

(par.morphology==1)

split

-

(tick)

(error)

 

Split threshold for variable sediment layer (ratio to nominal thickness)

(error)

1.01

1.005

1.1

(par.morphology==1)

merge

-

(tick)

(error)

 

Merge threshold for variable sediment layer (ratio to nominal thickness)

(error)

0.01

0.005

0.1

(par.morphology==1)

Constants, not read in params.txt

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

Coriolis force parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

wearth

hour^-1

(tick)

(error)

 

Angular velocity of earth calculated as: 1/rotation_time (in hours), later changed in calculation code to rad/s

(error)

0.041667

0

1

 

lat

deg

(tick)

(error)

 

Latitude at model location for computing Coriolis

(error)

0

-90

90

 

Discharge boundary conditions

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

disch_loc_file

-

(error)

(error)

 

Name of discharge locations file

(error)

 

 

 

 

disch_timeseries_file

-

(error)

(error)

 

Name of discharge timeseries file

(error)

 

 

 

 

Drifters parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

ndrifter

-

(error)

(error)

drifterfile

Number of drifers

(error)

0

0

50

 

drifterfile

-

(error)

(error)

 

Name of drifter data file

(error)

 

 

 

(par.ndrifter\>0)

Flow boundary condition parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

front

-

(error)

(error)

 

Switch for seaward flow boundary: 0 = radiating boundary(Ad), 1 = Van Dongeren, 1997

(error)

abs_2d

 

 

 

left

-

(error)

(error)

 

Switch for lateral boundary at ny+1, 'neumann' = vv computed from NSWE, 'wall' = reflective wall; vv=0

(error)

neumann

 

 

 

right

-

(error)

(error)

 

Switch for lateral boundary at right, 0 = vv computed from NSWE, 1 = reflective wall; vv=0

(error)

neumann

 

 

 

back

-

(error)

(error)

 

Switch for boundary at bay side, 0 = radiating boundary (Ad), 1 = reflective boundary; uu=0

(error)

abs_2d

 

 

 

ARC

-

(tick)

(error)

 

Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly (non) reflective

(error)

1

0

1

 

order

-

(tick)

(error)

 

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)

(error)

2

1

2

 

carspan

-

(tick)

(error)

 

Switch for Carrier-Greenspan test 0 = use cg (default); 1 = use sqrt(gh) in instat = 3 for c&g tests

(error)

0

0

1

 

epsi

-

(tick)

(error)

 

Ratio of mean current to time varying current through offshore boundary

(error)

0

0

0.2

 

tidetype

-

(tick)

(error)

 

Switch for offfshore boundary, velocity boundary or instant water level boundary (default)

(error)

velocity

 

 

 

Flow numerics parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

eps

m

(error)

(error)

 

Threshold water depth above which cells are considered wet

(error)

0.005

0.001

0.1

 

umin

m/s

(error)

(error)

 

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

(error)

0

0

0.2

 

hmin

m

(error)

(error)

 

Threshold water depth above which Stokes drift is included

(error)

0.2

0.001

1

 

secorder

-

(tick)

(error)

 

Use second order corrections to advection/non-linear terms based on mcCormack scheme

(error)

0

0

1

 

oldhu

-

(tick)

(error)

 

Turn on / off old hu calculation

(error)

0

0

1

 

Flow parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

bedfriction

-

(error)

(error)

bedfricfile C cf

Bed friction formulation: 'chezy','white-colebrook'

(error)

chezy

 

 

 

bedfricfile

-

(error)

(error)

C cf

Bed friction file (only valid with values of C)

(error)

 

 

 

((par.bedfriction)=='chezy')

C

m^0.5s^-1

(error)

(error)

C cf

Chezy coefficient

(error)

55

20

100

((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & isSetParameter('params.txt','C') & ~ isSetParameter('params.txt','cf')

 

 

 

 

 

 

(error)

55

20

100

((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & isSetParameter('params.txt','C') & isSetParameter('params.txt','cf')

 

 

 

 

 

 

(error)

55

20

100

((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & ~((isSetParameter('params.txt','cf') & ~ isSetParameter('params.txt','C')) & isSetParameter('params.txt','C') & ~ isSetParameter('params.txt','cf') & isSetParameter('params.txt','C') & isSetParameter('params.txt','cf'))

cf

-

(tick)

(error)

C cf

Friction coefficient flow

(error)

0.003

0

0.1

((par.bedfriction)=='chezy') & ~((par.bedfricfile.ne.'')) & (isSetParameter('params.txt','cf') & ~ isSetParameter('params.txt','C'))

nuh

m^2s^-1

(error)

(error)

 

Horizontal background viscosity

(error)

0.1

0

1

 

nuhfac

-

(tick)

(error)

 

Viscosity switch for roller induced turbulent horizontal viscosity

(error)

1

0

1

 

nuhv

-

(tick)

(error)

 

Longshore viscosity enhancement factor, following Svendsen (?)

(error)

1

1

20

 

smag

-

(tick)

(error)

 

Switch for smagorinsky subgrid model for viscocity

(error)

1

0

1

 

Grid parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

depfile

-

(error)

(error)

 

Name of the input bathymetry file

(tick)

 

 

 

 

posdwn

-

(error)

(error)

 

Bathymetry is specified positive down (1) or positive up (-1)

(error)

1

-1

1

 

nx

-

(error)

(error)

 

Number of computiation cell corners in x-direction

(tick)

50

2

10000

 

ny

-

(error)

(error)

 

Number of computiation cell corners in y-direction

(tick)

2

0

10000

 

alfa

deg

(error)

(error)

 

Angle of x-axis from East

(error)

0

0

360

 

vardx

-

(error)

(error)

dx dy xfile yfile

Switch for variable grid spacing: 1 = irregular spacing, 0 = regular grid spacing

(error)

0

0

1

 

dx

m

(error)

(error)

 

Regular grid spacing in x-direction

(tick)

-1

0

1000000000

(par.vardx==0)

dy

m

(error)

(error)

 

Regular grid spacing in y-direction

(tick)

-1

0

1000000000

(par.vardx==0)

xfile

name

(error)

(error)

 

Name of the file containing x-coordinates of the calculation grid

(error)

 

 

 

~((par.vardx==0))

yfile

name

(error)

(error)

 

Name of the file containing y-coordinates of the calculation grid

(error)

 

 

 

~((par.vardx==0))

xori

m

(error)

(error)

 

X-coordinate of origin of axis

(error)

0

-1000000000

1000000000

 

yori

m

(error)

(error)

 

Y-coordinate of origin of axis

(error)

0

-1000000000

1000000000

 

thetamin

deg

(error)

(error)

 

Lower directional limit (angle w.r.t computational x-axis)

(tick)

-90

-180

180

 

thetamax

deg

(error)

(error)

 

Higher directional limit (angle w.r.t computational x-axis)

(tick)

90

-180

180

 

dtheta

deg

(error)

(error)

 

Directional resolution

(tick)

10

0.1

20

 

thetanaut

-

(error)

(error)

 

Thetamin,thetamax in cartesian (0) or nautical convention (1)

(error)

0

0

1

 

Groundwater parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aba605f3-10a4-42a4-a668-d567da9a217c"><ac:plain-text-body><![CDATA[

kx

ms^-1

(tick)

(error)

ky kz

Darcy-flow permeability coefficient in x-direction [m/s]

(error)

0.0001

1e-005

0.01

(par.gwflow==1)

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="bb9fd27a-210e-4e4d-9552-8b06eb4e938a"><ac:plain-text-body><![CDATA[

ky

ms^-1

(tick)

(error)

 

Darcy-flow permeability coefficient in y-direction [m/s]

(error)

par.kx

1e-005

0.01

(par.gwflow==1)

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aaf3ffdb-a4b7-4bc3-9ceb-f72a5306245e"><ac:plain-text-body><![CDATA[

kz

ms^-1

(tick)

(error)

 

Darcy-flow permeability coefficient in z-direction [m/s]

(error)

par.kx

1e-005

0.01

(par.gwflow==1)

]]></ac:plain-text-body></ac:structured-macro>

dwetlayer

m

(tick)

(error)

 

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

(error)

0.2

0.01

1

(par.gwflow==1)

aquiferbot

m

(tick)

(error)

 

Level of uniform aquifer bottom

(error)

-10

-100

100

(par.gwflow==1) & (par.aquiferbotfile=='')

aquiferbotfile

-

(tick)

(error)

aquiferbot

Name of the aquifer bottom file

(error)

 

 

 

(par.gwflow==1)

gw0

m

(tick)

(error)

 

Level initial groundwater level

(error)

0

-5

5

(par.gwflow==1) & (par.gw0file=='')

gw0file

-

(tick)

(error)

gw0

Name of initial groundwater level file

(error)

 

 

 

(par.gwflow==1)

Initial conditions

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

zs0

m

(error)

(error)

 

Inital water level

(error)

0

-5

5

~((par.tideloc\>0))

zsinitfile

name

(error)

(error)

 

Name of inital condition file zs

(error)

 

 

 

 

MPI parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

mpiboundary

-

(tick)

(error)

 

Fix mpi boundaries along y-lines ('y'), x-lines ('x'), or find shortest boundary ('auto')

(error)

auto

 

 

 

Model time

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

tstop

s

(error)

(error)

morstop tintm

Stop time of simulation, in morphological time

(tick)

2000

1

1000000

 

CFL

-

(error)

(error)

 

Maximum Courant-Friedrichs-Lewy number

(error)

0.7

0.1

0.9

 

Morphology parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

morfac

-

(error)

(error)

 

Morphological acceleration factor

(error)

1

0

1000

(par.morphology==1)

morfacopt

-

(tick)

(error)

 

Option indicating whether times should be adjusted (1) or not(0) for morfac

(error)

1

0

1

(par.morphology==1)

morstart

s

(error)

(error)

 

Start time morphology, in morphological time

(error)

120

0

10000

(par.morphology==1)

morstop

s

(error)

(error)

 

Stop time morphology, in morphological time

(error)

par.tstop

0

10000

(par.morphology==1)

wetslp

-

(error)

(error)

 

Critical avalanching slope under water (dz/dx and dz/dy)

(error)

0.3

0.1

1

(par.morphology==1)

dryslp

-

(error)

(error)

 

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

(error)

1

0.1

2

(par.morphology==1)

hswitch

m

(tick)

(error)

 

Water depth at which is switched from wetslp to dryslp

(error)

0.1

0.01

1

(par.morphology==1)

dzmax

m/s/m

(tick)

(error)

 

Maximum bedlevel change due to avalanching

(error)

0.05

0

1

(par.morphology==1)

struct

-

(error)

(error)

ne_layer

Switch for hard structures

(error)

0

0

1

(par.morphology==1)

ne_layer

name

(error)

(error)

 

Name of file containing depth of hard structure

(error)

 

 

 

(par.morphology==1) & (par.struct==1)

Non-hydrostatic correction parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

solver_maxit

-

(tick)

(error)

 

Maximum number of iterations in the linear SIP solver

(error)

30

1

1000

(par.nonh==1)

solver_acc

-

(tick)

(error)

 

accuracy with respect to the right-hand side usedin the following termination criterion:||b-Ax || \< acc*||b||

(error)

0.005

1e-005

0.1

(par.nonh==1)

solver_urelax

-

(tick)

(error)

 

Underrelaxation parameter

(error)

0.92

0.5

0.99

(par.nonh==1)

solver

-

(tick)

(error)

 

Solver used to solve the linear system, 1=SIP, 2=TRIDIAG (only for 1d)

(error)

1

0

2

(par.nonh==1)

kdmin

-

(tick)

(error)

 

Minimum value of kd ( pi/dx \> minkd )

(error)

0

0

0.05

(par.nonh==1)

dispc

?

(tick)

(error)

 

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

(error)

1

0.1

2

(par.nonh==1)

Topt

s

(tick)

(error)

 

Absolute period to optimize coefficient

(error)

10

1

20

(par.nonh==1)

Output variables

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

timings

-

(tick)

(error)

 

Switch to turn on (1) or off (0) progress output to screen

(error)

1

0

1

 

tstart

s

(error)

(error)

tintm

Start time of output, in morphological time

(error)

1

0

1000000

 

tint

s

(error)

(tick)

tintg tintp tintc

Interval time of global output (replaced by tintg)

(error)

1

0.01

100000

 

tintg

s

(error)

(error)

 

Interval time of global output

(error)

par.tint

0.01

100000

(par.tsglobal=='')

tintp

s

(error)

(error)

 

Interval time of point and runup gauge output

(error)

par.tint

0.01

100000

(par.tspoints=='')

tintc

s

(tick)

(error)

 

Interval time of cross section output

(error)

par.tint

0.01

100000

(par.tscross=='')

tintm

s

(error)

(error)

 

Interval time of mean,var,max,min output

(error)

par.tstop-par.tstart

1

par.tstop-par.tstart

(par.tsmean=='')

tsglobal

-

(tick)

(error)

tintg

Name of file containing timings of global output

(error)

 

 

 

 

tspoints

-

(tick)

(error)

tintp

Name of file containing timings of point output

(error)

 

 

 

 

tscross

-

(tick)

(error)

tintc

Name of file containing timings of cross section output

(error)

 

 

 

 

tsmean

-

(tick)

(error)

tintm

Name of file containing timings of mean, max, min and var output

(error)

 

 

 

 

nglobalvar

-

(error)

(error)

 

Number of global output variables (as specified by user)

(error)

-1

-1

20

 

nmeanvar

-

(error)

(error)

 

Number of mean,min,max,var output variables

(error)

0

0

15

 

npointvar

-

(error)

(error)

 

Number of point output variables

(error)

0

0

50

 

npoints

-

(error)

(error)

 

Number of output point locations

(error)

0

0

50

 

nrugauge

-

(error)

(error)

 

Number of output runup gauge locations

(error)

0

0

50

 

rugdepth

m

(tick)

(error)

 

Minimum depth for determination of last wet point in runup gauge

(error)

0

0

0.05

 

ncross

-

(tick)

(error)

 

Number of output cross sections

(error)

0

0

50

 

outputformat

-

(tick)

(error)

 

Choice of output file format: 'netcdf', 'fortran', or 'debug'

(error)

fortran

 

 

 

ncfilename

-

(tick)

(error)

 

xbeach netcdf output file name

(error)

 

 

 

 

Physical constants

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

g

ms^-2

(error)

(error)

 

Gravitational acceleration

(error)

9.81

9.7

9.9

 

rho

kgm^-3

(error)

(error)

 

Density of water

(error)

1025

1000

1040

 

depthscale

-

(tick)

(error)

 

depthscale of (lab)test simulated. 1 = default, which corresponds to teh real world (nature)the follwing (numerical) parameters are scaled with the depth scale (see Brandenburg, 2010):eps = eps_default/depthscalehmin = hmin_default/depthscalehswitch = hswitch/depthscaledzmax = dzmax/depthscale**1.5d0Brandenburg concluded that also the following parameters potentially need to be scaled:wetslp, turb (suggested to turn off at depthscales\<20) & ucr (distinguish ucr_bed load anducr_sus at depthscales\<20)

(error)

1

1

200

 

Physical processes

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

swave

-

(error)

(error)

thetamin thetamax dtheta instat

Include short waves (1), exclude short waves (0)

(error)

1

0

1

 

lwave

-

(error)

(error)

 

Include short wave forcing on NLSW equations and boundary conditions (1), or exclude (0)

(error)

1

0

1

 

flow

-

(error)

(error)

 

Include flow calculation (1), or exclude (0)

(error)

1

0

1

 

sedtrans

-

(error)

(error)

rhos dzg1 dzg2 dzg3 por D50 D90 sedcal ucrcal waveform form sws lws BRfac facsl z0 smax tsfac facua facSk facAs turb Tbfac Tsmin lwt betad sus bed bulk thetanum sourcesink

Include sediment transport (1) or exclude (0)

(error)

1

0

1

 

morphology

-

(error)

(error)

morfac morfacopt morstart morstop wetslp dryslp hswitch dzmax struct ne_layer frac_dz nd_var split merge

Include morphology (1) or exclude (0)

(error)

1

0

1

 

nonh

-

(tick)

(error)

solver_maxit solver_acc solver_urelax solver kdmin dispc Topt

Non-hydrostatic pressure option: 0 = NSWE, 1 = NSW + non-hydrostatic pressure compensation Stelling & Zijlema, 2003

(error)

0

0

1

 

gwflow

-

(tick)

(error)

kx ky kz dwetlayer aquiferbot aquiferbotfile gw0 gw0file

Turn on (1) or off (0) groundwater flow module

(error)

0

0

1

 

q3d

-

(tick)

(error)

vonkar vicmol kmax sigfac

Turn on (1) or off (0) quasi-3D sediment transport module

(error)

0

0

1

 

Q3D sediment transport parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

vonkar

unknown

(tick)

(error)

 

von Karman constant

(error)

0.4

0.01

1

(par.q3d==1)

vicmol

unknown

(tick)

(error)

 

molecular viscosity

(error)

1e-006

0

0.001

(par.q3d==1)

kmax

-

(tick)

(error)

 

Number of sigma layers in Quasi-3D model; kmax = 1 (default) is without vertical structure of flow and suspensions

(error)

1

1

1000

(par.q3d==1)

sigfac

-

(tick)

(error)

 

dsig scales with log(sigfac). Default = 1.3

(error)

1.3

0

10

(par.q3d==1)

Roller parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

roller

-

(tick)

(error)

 

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

(error)

1

0

1

 

beta

-

(tick)

(error)

 

Breaker slope coefficient in roller model

(error)

0.1

0.05

0.3

 

rfb

-

(tick)

(error)

 

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

(error)

0

0

1

 

Sediment transport numerics parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

thetanum

-

(tick)

(error)

 

Coefficient determining whether upwind (1) or central scheme (0.5) is used.

(error)

1

0.5

1

(par.sedtrans==1)

sourcesink

-

(tick)

(error)

 

In suspended transport use source-sink terms to calculate bed level change (1) or sus transport gradients (0)

(error)

0

0

1

(par.sedtrans==1)

Sediment transport parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

waveform

-

(error)

(error)

 

Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009

(error)

vanthiel

 

 

(par.sedtrans==1)

form

-

(error)

(error)

 

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

(error)

vanthiel_vanrijn

 

 

(par.sedtrans==1)

sws

-

(tick)

(error)

 

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

(error)

1

0

1

(par.sedtrans==1)

lws

-

(tick)

(error)

 

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

(error)

1

0

1

(par.sedtrans==1)

BRfac

-

(tick)

(error)

 

Calibration factor surface slope

(error)

1

0

1

(par.sedtrans==1)

facsl

-

(tick)

(error)

 

Factor bedslope effect

(error)

1.6

0

1.6

(par.sedtrans==1)

z0

m

(tick)

(error)

 

Zero flow velocity level in Soulsby van Rijn (1997) sed.conc. expression

(error)

0.006

0.0001

0.05

(par.sedtrans==1)

smax

-

(tick)

(error)

 

Being tested: maximum Shields parameter for ceq Diane Foster

(error)

-1

-1

3

(par.sedtrans==1)

tsfac

-

(tick)

(error)

 

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

(error)

0.1

0.01

1

(par.sedtrans==1)

facua

-

(tick)

(error)

facSk facAs

Calibration factor time averaged flows due to wave skewness and asymmetry

(error)

0.1

0

1

(par.sedtrans==1)

facSk

-

(tick)

(error)

 

Calibration factor time averaged flows due to wave skewness

(error)

par.facua

0

1

(par.sedtrans==1)

facAs

-

(tick)

(error)

 

Calibration factor time averaged flows due to wave asymmetry

(error)

par.facua

0

1

(par.sedtrans==1)

turb

-

(tick)

(error)

 

Equlibrium sediment concentration is computed as function of:none = no turbulence,

(error)

bore_averaged

 

 

(par.sedtrans==1)

Tbfac

-

(tick)

(error)

 

Calibration factor for bore interval Tbore: Tbore = Tbfac*Tbore

(error)

1

0

1

(par.sedtrans==1)

Tsmin

s

(tick)

(error)

 

Minimum adaptation time scale in advection diffusion equation sediment

(error)

0.2

0.01

10

(par.sedtrans==1)

lwt

-

(tick)

(error)

 

Switch 0/1 long wave turbulence model

(error)

0

0

1

(par.sedtrans==1)

betad

-

(tick)

(error)

 

Dissipation parameter long wave breaking turbulence

(error)

1

0

10

(par.sedtrans==1)

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cf9d5f8f-d59f-4750-9366-f7298f380842"><ac:plain-text-body><![CDATA[

sus

-

(tick)

(error)

 

Calibration factor for suspensions transports [0..1]

(error)

1

0

1

(par.sedtrans==1)

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="60087ce3-18e3-46cf-b34a-b37d47ec94b9"><ac:plain-text-body><![CDATA[

bed

-

(tick)

(error)

 

Calibration factor for bed transports [0..1]

(error)

1

0

1

(par.sedtrans==1)

]]></ac:plain-text-body></ac:structured-macro>

bulk

-

(tick)

(error)

 

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

(error)

1

0

1

(par.sedtrans==1)

Tide boundary conditions

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

zs0file

-

(error)

(error)

 

Name of tide boundary condition series

(error)

 

 

 

(par.tideloc\>0)

tideloc

-

(error)

(error)

zs0 zs0file paulrevere

Number of corner points on which a tide time series is specified

(error)

0

0

4

 

paulrevere

-

(error)

(error)

 

Specifies tide on sea and land ('land') or two sea points ('sea') if tideloc = 2if tideloc =\>2, then this indicates where the time series are to beapplied. Input for tidal information to xbeach options (3):1. one tidal record --\> specify tidal record everywhere2. two tidal records --\> Need to specify keyword 'paulrevere'paulrevere=='land' implies to apply one tidal record toboth sea corners and one tidal record to both land cornerspaulrevere=='sea' implies to apply the first tidal record(column 2 in zs0input.dat) to the (x=1,y=1) sea corner andthe second tidal record (third column) to the (x=1,y=N) sea corner3. four tidal records --\> Need to list tidal records inzs0input.dat in order of:(x=1,y=1)(x=1,y=N)(x=N,y=N)(x=N,y=1)NOTE: clockwise from (1,1) corner

(error)

land

 

 

(par.tideloc\>0) & (par.tideloc==2)

Variables, not read in params.txt

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

Wave boundary condition parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

instat

-

(error)

(error)

Hrms Tm01 Trep Tlong dir0 m bcfile random fcutoff nspr trepfac sprdthr oldwbc correctHm0 oldnyq Tm01switch rt dtbc dthetaS_XB wavint maxerror maxiter

Wave boundary condtion type

(tick)

bichrom

 

 

 

taper

s

(error)

(error)

 

Spin-up time of wave boundary conditions, in morphological time

(error)

100

0

1000

 

Hrms

m

(error)

(error)

 

Hrms wave height for instat = 0,1,2,3

(error)

1

0

10

((par.instat)=='stat')

 

 

 

 

 

 

(error)

1

0

10

(par.instat)=='bichrom'

 

 

 

 

 

 

(error)

1

0

10

(par.instat)=='ts_1' | (par.instat)=='ts_2'

Tm01

s

(error)

(tick)

Trep

Old name for Trep

(error)

10

1

20

((par.instat)=='stat')

 

 

 

 

 

 

(error)

10

1

20

(par.instat)=='bichrom'

 

 

 

 

 

 

(error)

10

1

20

(par.instat)=='ts_1' | (par.instat)=='ts_2'

Trep

s

(error)

(error)

 

Representative wave period for instat = 0,1,2,3

(error)

par.Tm01

1

20

((par.instat)=='stat')

 

 

 

 

 

 

(error)

par.Tm01

1

20

(par.instat)=='bichrom'

 

 

 

 

 

 

(error)

par.Tm01

1

20

(par.instat)=='ts_1' | (par.instat)=='ts_2'

Tlong

s

(error)

(error)

 

Wave group period for case instat = 1

(error)

80

20

300

(par.instat)=='bichrom'

dir0

deg

(error)

(error)

 

Mean wave direction (Nautical convention) for instat = 0,1,2,3

(error)

270

180

360

((par.instat)=='stat')

 

 

 

 

 

 

(error)

270

180

360

(par.instat)=='bichrom'

 

 

 

 

 

 

(error)

270

180

360

(par.instat)=='ts_1' | (par.instat)=='ts_2'

nmax

-

(tick)

(error)

 

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

(error)

0.8

0.5

1

 

m

-

(error)

(error)

 

Power in cos^m directional distribution for instat = 0,1,2,3

(error)

10

2

128

((par.instat)=='stat')

 

 

 

 

 

 

(error)

10

2

128

(par.instat)=='bichrom'

 

 

 

 

 

 

(error)

10

2

128

(par.instat)=='ts_1' | (par.instat)=='ts_2'

leftwave

-

(error)

(error)

 

old name for lateralwave

(error)

neumann

 

 

 

rightwave

-

(error)

(error)

 

old name for lateralwave

(error)

neumann

 

 

 

Wave breaking parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

break

-

(error)

(error)

gamma2

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

(error)

roelvink2

 

 

 

gamma

-

(error)

(error)

 

Breaker parameter in Baldock or Roelvink formulation

(error)

0.55

0.4

0.9

 

gamma2

-

(error)

(error)

 

End of breaking parameter in break = 4 formulation

(error)

0.3

0

0.5

((par.break)=='roelvink_daly')

alpha

-

(tick)

(error)

 

Wave dissipation coefficient in Roelvink formulation

(error)

1

0.5

2

 

n

-

(tick)

(error)

 

Power in Roelvink dissipation model

(error)

10

5

20

 

gammax

-

(tick)

(error)

 

Maximum ratio wave height to water depth

(error)

2

0.4

5

 

delta

-

(tick)

(error)

 

Fraction of wave height to add to water depth

(error)

0

0

1

 

fw

-

(tick)

(error)

 

Bed friction factor

(error)

0

0

1

 

breakerdelay

-

(tick)

(error)

 

Turn on (1) or off (0) breaker delay model

(error)

1

0

1

 

Wave numerics parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

scheme

-

(tick)

(error)

 

Use first-order upwind (upwind_1), second order upwind (upwind_2) or Lax-Wendroff (lax_wendroff)for wave propagation

(error)

upwind_2

 

 

 

wavint

s

(error)

(error)

 

Interval between wave module calls (only in stationary wave mode)

(error)

60

1

3600

((par.instat)=='stat' | (par.instat)=='stat_table')

maxerror

m

(tick)

(error)

 

Maximum wave height error in wave stationary iteration

(error)

5e-005

1e-005

0.001

((par.instat)=='stat' | (par.instat)=='stat_table')

maxiter

-

(tick)

(error)

 

Maximum number of iterations in wave stationary

(error)

500

2

1000

((par.instat)=='stat' | (par.instat)=='stat_table')

Wave-current interaction parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

wci

-

(error)

(error)

 

Turns on (1) or off (0) wave-current interaction

(error)

0

0

1

 

hwci

m

(tick)

(error)

 

Minimum depth until which wave-current interaction is used

(error)

0.1

0.001

1

 

cats

Trep

(tick)

(error)

 

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

(error)

20

1

50

 

Wave-spectrum boundary condition parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

bcfile

-

(error)

(error)

 

Name of spectrum file

(error)

 

 

 

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='stat_table' | (par.instat)=='jons_table')

random

-

(tick)

(error)

 

Random seed on (1) or off (0) for instat = 4,5,6 boundary conditions

(error)

1

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

fcutoff

Hz

(tick)

(error)

 

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

(error)

0

0

40

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

nspr

-

(tick)

(error)

 

nspr = 1 long wave direction forced into centres of short wave bins, nspr = 0 regular long wave spreadin

(error)

0

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

trepfac

-

(tick)

(error)

 

Compute mean wave period over energy band: par%trepfac*maxval(Sf) for instat 4,5,6; converges to Tm01 for trepfac = 0.0 and

(error)

0.01

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

sprdthr

-

(tick)

(error)

 

Threshold ratio to maxval of S above which spec dens are read in (default 0.08*maxval)

(error)

0.08

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

oldwbc

-

(tick)

(error)

 

(1) Use old version wave boundary conditions for instat 4,5,6

(error)

0

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

correctHm0

-

(tick)

(error)

 

Turn off or on Hm0 correction

(error)

1

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

oldnyq

-

(tick)

(error)

 

Turn off or on old nyquist switch

(error)

0

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

Tm01switch

-

(tick)

(error)

 

Turn off or on Tm01 or Tm-10 switch

(error)

0

0

1

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table')

rt

s

(error)

(error)

 

Duration of wave spectrum at offshore boundary, in morphological time

(error)

3600

1200

7200

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & (filetype==0)

dtbc

s

(tick)

(error)

 

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

(error)

0.5

0.1

2

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & (filetype==0)

dthetaS_XB

deg

(tick)

(error)

 

If SWAN input is not in nautical degrees, dthetaS_XB is the angle from SWAN x-axis to XBeach x-axis in cathesian degrees

(error)

0

-360

360

((par.instat)=='jons' | (par.instat)=='swan' | (par.instat)=='vardens' | (par.instat)=='jons_table') & ((par.instat)=='swan')

Wind parameters

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

rhoa

kgm^-3

(tick)

(error)

 

Air density

(error)

1.25

1

2

 

Cd

-

(tick)

(error)

 

Wind drag coefficient

(error)

0.002

0.0001

0.01

 

windv

ms^-1

(error)

(error)

 

Wind velocity, in case of stationary wind

(error)

0

0

200

(par.windfile=='')

windth

deg

(error)

(error)

 

Nautical wind direction, in case of stationary wind

(error)

270

-360

360

(par.windfile=='')

windfile

-

(error)

(error)

windv windth

Name of file with non-stationary wind data

(error)

 

 

 

 

rhoa

kgm^-3

Air density

Cd

-

Wind drag coefficient

windv

ms^-1

Wind velocity, in case of stationary wind

windth

deg

Nautical wind direction, in case of stationary wind

windfile

-

Name of file with non-stationary wind data