You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

This page moved to the XBeach portal

The contents of this page moved to the new XBeach Open-source Software (OSS) portal at http://oss.deltares.nl/ and can be directly approached using http://www.xbeach.org.

New XBeach repository and portal website

The new XBeach portal website is released on http://oss.deltares.nl! It replaces the general parts of this WIKI space and the Google Groups website.
The Subversion (SVN) repository is migrated as well. The new address is: https://svn.oss.deltares.nl/repos/xbeach. Read the instruction on how to register and create a new working copy or how to relocate to start using the new SVN server.

Bed composition parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

rhos

kgm^-3

 

Solid sediment density (no pores)

2650

2400

2800

(par.sedtrans==1)

ngd

-

 

Number of sediment classes

1

1

20

 

nd

-

nd_var

Number of computational layers in the bed

3

3

1000

 

dzg1

m

dzg1 dzg2 dzg3

Thickness of top sediment class layers

0.1

0.01

1

(par.sedtrans==1)

 

 

 

 

 

 

par.dzg1

0.01

1

(par.sedtrans==1)

dzg2

m

 

Nominal thickness of variable sediment class layer

par.dzg1

0.01

1

(par.sedtrans==1)

dzg3

m

 

Thickness of bottom sediment class layers

par.dzg1

0.01

1

(par.sedtrans==1)

por

-

 

Porosity

0.4

0.3

0.5

(par.sedtrans==1)

D50

m

 

D50 grain size per grain type

0.0002

5e-005

0.0008

(par.sedtrans==1)

D90

m

 

D90 grain size per grain type

0.0003

0.0001

0.0015

(par.sedtrans==1)

sedcal

-

 

Sediment transport calibration coefficient per grain type

1

0

2

(par.sedtrans==1)

ucrcal

-

 

Critical velocity calibration coefficient per grain type

1

0

2

(par.sedtrans==1)

Bed update numerics parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

frac_dz

-

 

Relative thickness to split time step for bed updating

0.7

0.5

0.98

(par.morphology==1)

nd_var

-

 

Index of layer with variable thickness

2

2

par.nd

(par.morphology==1)

split

-

 

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

1.01

1.005

1.1

(par.morphology==1)

merge

-

 

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

0.01

0.005

0.1

(par.morphology==1)

Coriolis force parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

wearth

hour^-1

 

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

0.041667

0

1

 

lat

deg

 

Latitude at model location for computing Coriolis

0

-90

90

 

Discharge boundary conditions

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

ndischarge

-

 

Number of discharge locations

-1

0

100

 

ntdischarge

-

 

Length of discharge time series

-1

0

100

 

disch_loc_file

-

 

Name of discharge locations file

 

 

 

 

disch_timeseries_file

-

 

Name of discharge timeseries file

 

 

 

 

Drifters parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

ndrifter

-

 

Number of drifers

-1

0

50

 

drifterfile

-

 

Name of drifter data file

 

 

 

 

Flow boundary condition parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

front

-

 

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

abs_2d

 

 

 

left

-

 

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

neumann

 

 

 

right

-

 

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

neumann

 

 

 

back

-

 

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

abs_2d

 

 

 

ARC

-

 

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

1

0

1

 

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)

2

1

2

 

carspan

-

 

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

0

0

1

 

epsi

-

 

Ratio of mean current to time varying current through offshore boundary

0

-1

0.2

 

tidetype

-

 

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

velocity

 

 

 

Flow numerics parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

eps

m

 

Threshold water depth above which cells are considered wet

0.005

0.001

0.1

 

umin

m/s

 

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

0

0

0.2

 

hmin

m

 

Threshold water depth above which Stokes drift is included

0.2

0.001

1

 

secorder

-

 

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

0

0

1

 

oldhu

-

 

Turn on / off old hu calculation

0

0

1

 

Flow parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

bedfriction

-

bedfricfile C cf

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

chezy

 

 

 

bedfricfile

-

C cf

Bed friction file (only valid with values of C)

 

 

 

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

C

m^0.5s^-1

C cf

Chezy coefficient

55

20

100

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

 

 

 

 

 

 

55

20

100

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

 

 

 

 

 

 

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

-

C cf

Friction coefficient flow

0.003

0

0.1

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

nuh

m^2s^-1

 

Horizontal background viscosity

0.1

0

1

 

nuhfac

-

 

Viscosity switch for roller induced turbulent horizontal viscosity

1

0

1

 

nuhv

-

 

Longshore viscosity enhancement factor, following Svendsen (?)

1

1

20

 

smag

-

 

Switch for smagorinsky subgrid model for viscocity

1

0

1

 

Grid parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

depfile

-

 

Name of the input bathymetry file

 

 

 

 

posdwn

-

 

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

1

-1

1

 

nx

-

 

Number of computiation cell corners in x-direction

50

2

10000

 

ny

-

 

Number of computiation cell corners in y-direction

2

0

10000

 

alfa

deg

 

Angle of x-axis from East

0

0

360

 

vardx

-

dx dy xfile yfile

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

0

0

1

 

dx

m

 

Regular grid spacing in x-direction

-1

0

1000000000

(par.vardx==0)

dy

m

 

Regular grid spacing in y-direction

-1

0

1000000000

(par.vardx==0)

xfile

name

 

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

 

 

 

~((par.vardx==0))

yfile

name

 

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

 

 

 

~((par.vardx==0))

xori

m

 

X-coordinate of origin of axis

0

-1000000000

1000000000

 

yori

m

 

Y-coordinate of origin of axis

0

-1000000000

1000000000

 

thetamin

deg

 

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

-90

-180

180

 

thetamax

deg

 

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

90

-180

180

 

dtheta

deg

 

Directional resolution

10

0.1

20

 

thetanaut

-

 

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

0

0

1

 

Groundwater parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

kx

ms^-1

ky kz

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

0.0001

1e-005

0.01

(par.gwflow==1)

ky

ms^-1

 

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

par.kx

1e-005

0.01

(par.gwflow==1)

kz

ms^-1

 

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

par.kx

1e-005

0.01

(par.gwflow==1)

dwetlayer

m

 

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

0.2

0.01

1

(par.gwflow==1)

aquiferbot

m

 

Level of uniform aquifer bottom

-10

-100

100

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

aquiferbotfile

-

aquiferbot

Name of the aquifer bottom file

 

 

 

(par.gwflow==1)

gw0

m

 

Level initial groundwater level

0

-5

5

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

gw0file

-

gw0

Name of initial groundwater level file

 

 

 

(par.gwflow==1)

Initial conditions

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

zs0

m

 

Inital water level

0

-5

5

~((par.tideloc>0))

zsinitfile

name

 

Name of inital condition file zs

 

 

 

 

MPI parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

mpiboundary

-

 

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

auto

 

 

 

Model time

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

tstop

s

morstop tintm

Stop time of simulation, in morphological time

2000

1

1000000

 

CFL

-

 

Maximum Courant-Friedrichs-Lewy number

0.7

0.1

0.9

 

Morphology parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

morfac

-

 

Morphological acceleration factor

1

0

1000

(par.morphology==1)

morfacopt

-

 

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

1

0

1

(par.morphology==1)

morstart

s

 

Start time morphology, in morphological time

120

0

10000

(par.morphology==1)

morstop

s

 

Stop time morphology, in morphological time

par.tstop

0

10000

(par.morphology==1)

wetslp

-

 

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

0.3

0.1

1

(par.morphology==1)

dryslp

-

 

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

1

0.1

2

(par.morphology==1)

hswitch

m

 

Water depth at which is switched from wetslp to dryslp

0.1

0.01

1

(par.morphology==1)

dzmax

m/s/m

 

Maximum bedlevel change due to avalanching

0.05

0

1

(par.morphology==1)

struct

-

ne_layer

Switch for hard structures

0

0

1

(par.morphology==1)

ne_layer

name

 

Name of file containing depth of hard structure

 

 

 

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

Non-hydrostatic correction parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

solver_maxit

-

 

Maximum number of iterations in the linear SIP solver

30

1

1000

(par.nonh==1)

solver_acc

-

 

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

0.005

1e-005

0.1

(par.nonh==1)

solver_urelax

-

 

Underrelaxation parameter

0.92

0.5

0.99

(par.nonh==1)

solver

-

 

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

1

0

2

(par.nonh==1)

kdmin

-

 

Minimum value of kd ( pi/dx > minkd )

0

0

0.05

(par.nonh==1)

dispc

?

 

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

1

0.1

2

(par.nonh==1)

Topt

s

 

Absolute period to optimize coefficient

10

1

20

(par.nonh==1)

Output variables

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

timings

-

 

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

1

0

1

 

tstart

s

tintm

Start time of output, in morphological time

1

0

1000000

 

tint

s

tintg tintp tintc

Interval time of global output (replaced by tintg)

1

0.01

100000

 

tintg

s

 

Interval time of global output

par.tint

0.01

100000

(par.tsglobal=='')

tintp

s

 

Interval time of point and runup gauge output

par.tint

0.01

100000

(par.tspoints=='')

tintc

s

 

Interval time of cross section output

par.tint

0.01

100000

(par.tscross=='')

tintm

s

 

Interval time of mean,var,max,min output

par.tstop-par.tstart

1

par.tstop-par.tstart

(par.tsmean=='')

tsglobal

-

tintg

Name of file containing timings of global output

 

 

 

 

tspoints

-

tintp

Name of file containing timings of point output

 

 

 

 

tscross

-

tintc

Name of file containing timings of cross section output

 

 

 

 

tsmean

-

tintm

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

 

 

 

 

nglobalvar

-

 

Number of global output variables (as specified by user)

-1

-1

20

 

nmeanvar

-

 

Number of mean,min,max,var output variables

0

0

15

 

npointvar

-

 

Number of point output variables

0

0

50

 

npoints

-

 

Number of output point locations

0

0

50

 

nrugauge

-

 

Number of output runup gauge locations

0

0

50

 

rugdepth

m

 

Minimum depth for determination of last wet point in runup gauge

0

0

0.05

 

ncross

-

 

Number of output cross sections

0

0

50

 

outputformat

-

 

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

fortran

 

 

 

ncfilename

-

 

xbeach netcdf output file name

 

 

 

 

Physical constants

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

g

ms^-2

 

Gravitational acceleration

9.81

9.7

9.9

 

rho

kgm^-3

 

Density of water

1025

1000

1040

 

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)

1

1

200

 

Physical processes

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

swave

-

thetamin thetamax dtheta instat

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

1

0

1

 

lwave

-

 

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

1

0

1

 

flow

-

 

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

1

0

1

 

sedtrans

-

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)

1

0

1

 

morphology

-

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

Include morphology (1) or exclude (0)

1

0

1

 

nonh

-

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

0

0

1

 

gwflow

-

kx ky kz dwetlayer aquiferbot aquiferbotfile gw0 gw0file

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

0

0

1

 

q3d

-

vonkar vicmol kmax sigfac

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

0

0

1

 

Q3D sediment transport parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

vonkar

unknown

 

von Karman constant

0.4

0.01

1

(par.q3d==1)

vicmol

unknown

 

molecular viscosity

1e-006

0

0.001

(par.q3d==1)

kmax

-

 

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

1

1

1000

(par.q3d==1)

sigfac

-

 

dsig scales with log(sigfac). Default = 1.3

1.3

0

10

(par.q3d==1)

Roller parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

roller

-

 

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

1

0

1

 

beta

-

 

Breaker slope coefficient in roller model

0.1

0.05

0.3

 

rfb

-

 

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

0

0

1

 

Sediment transport numerics parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

thetanum

-

 

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

1

0.5

1

(par.sedtrans==1)

sourcesink

-

 

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

0

0

1

(par.sedtrans==1)

Sediment transport parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

waveform

-

 

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

vanthiel

 

 

(par.sedtrans==1)

form

-

 

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

vanthiel_vanrijn

 

 

(par.sedtrans==1)

sws

-

 

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

1

0

1

(par.sedtrans==1)

lws

-

 

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

1

0

1

(par.sedtrans==1)

BRfac

-

 

Calibration factor surface slope

1

0

1

(par.sedtrans==1)

facsl

-

 

Factor bedslope effect

1.6

0

1.6

(par.sedtrans==1)

z0

m

 

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

0.006

0.0001

0.05

(par.sedtrans==1)

smax

-

 

Being tested: maximum Shields parameter for ceq Diane Foster

-1

-1

3

(par.sedtrans==1)

tsfac

-

 

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

0.1

0.01

1

(par.sedtrans==1)

facua

-

facSk facAs

Calibration factor time averaged flows due to wave skewness and asymmetry

0.1

0

1

(par.sedtrans==1)

facSk

-

 

Calibration factor time averaged flows due to wave skewness

par.facua

0

1

(par.sedtrans==1)

facAs

-

 

Calibration factor time averaged flows due to wave asymmetry

par.facua

0

1

(par.sedtrans==1)

turb

-

 

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

bore_averaged

 

 

(par.sedtrans==1)

Tbfac

-

 

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

1

0

1

(par.sedtrans==1)

Tsmin

s

 

Minimum adaptation time scale in advection diffusion equation sediment

0.2

0.01

10

(par.sedtrans==1)

lwt

-

 

Switch 0/1 long wave turbulence model

0

0

1

(par.sedtrans==1)

betad

-

 

Dissipation parameter long wave breaking turbulence

1

0

10

(par.sedtrans==1)

sus

-

 

Calibration factor for suspensions transports [0..1]

1

0

1

(par.sedtrans==1)

bed

-

 

Calibration factor for bed transports [0..1]

1

0

1

(par.sedtrans==1)

bulk

-

 

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

1

0

1

(par.sedtrans==1)

Tide boundary conditions

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

zs0file

-

 

Name of tide boundary condition series

 

 

 

(par.tideloc>0)

tideloc

-

zs0 zs0file paulrevere

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

0

0

4

 

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

land

 

 

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

Wave boundary condition parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

instat

-

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

bichrom

 

 

 

taper

s

 

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

100

0

1000

 

Hrms

m

 

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

1

0

10

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

 

 

 

 

 

 

1

0

10

(par.instat)=='bichrom'

 

 

 

 

 

 

1

0

10

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

Tm01

s

Trep

Old name for Trep

10

1

20

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

 

 

 

 

 

 

10

1

20

(par.instat)=='bichrom'

 

 

 

 

 

 

10

1

20

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

Trep

s

 

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

par.Tm01

1

20

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

 

 

 

 

 

 

par.Tm01

1

20

(par.instat)=='bichrom'

 

 

 

 

 

 

par.Tm01

1

20

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

Tlong

s

 

Wave group period for case instat = 1

80

20

300

(par.instat)=='bichrom'

dir0

deg

 

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

270

180

360

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

 

 

 

 

 

 

270

180

360

(par.instat)=='bichrom'

 

 

 

 

 

 

270

180

360

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

nmax

-

 

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

0.8

0.5

1

 

m

-

 

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

10

2

128

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

 

 

 

 

 

 

10

2

128

(par.instat)=='bichrom'

 

 

 

 

 

 

10

2

128

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

leftwave

-

 

old name for lateralwave

neumann

 

 

 

rightwave

-

 

old name for lateralwave

neumann

 

 

 

Wave breaking parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

break

-

gamma2

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

roelvink2

 

 

 

gamma

-

 

Breaker parameter in Baldock or Roelvink formulation

0.55

0.4

0.9

 

gamma2

-

 

End of breaking parameter in break = 4 formulation

0.3

0

0.5

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

alpha

-

 

Wave dissipation coefficient in Roelvink formulation

1

0.5

2

 

n

-

 

Power in Roelvink dissipation model

10

5

20

 

gammax

-

 

Maximum ratio wave height to water depth

2

0.4

5

 

delta

-

 

Fraction of wave height to add to water depth

0

0

1

 

fw

-

 

Bed friction factor

0

0

1

 

breakerdelay

-

 

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

1

0

1

 

Wave numerics parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

scheme

-

 

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

upwind_2

 

 

 

wavint

s

 

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

60

1

3600

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

maxerror

m

 

Maximum wave height error in wave stationary iteration

5e-005

1e-005

0.001

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

maxiter

-

 

Maximum number of iterations in wave stationary

500

2

1000

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

Wave-current interaction parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

wci

-

 

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

0

0

1

 

hwci

m

 

Minimum depth until which wave-current interaction is used

0.1

0.001

1

 

cats

Trep

 

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

4

1

50

 

Wave-spectrum boundary condition parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

bcfile

-

 

Name of spectrum file

 

 

 

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

random

-

 

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

1

0

1

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

fcutoff

Hz

 

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

0

0

40

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

nspr

-

 

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

0

0

1

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

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

0.01

0

1

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

sprdthr

-

 

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

0.08

0

1

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

oldwbc

-

 

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

0

0

1

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

correctHm0

-

 

Turn off or on Hm0 correction

1

0

1

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

oldnyq

-

 

Turn off or on old nyquist switch

0

0

1

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

Tm01switch

-

 

Turn off or on Tm01 or Tm-10 switch

0

0

1

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

rt

s

 

Duration of wave spectrum at offshore boundary, in morphological time

3600

1200

7200

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

dtbc

s

 

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

0.5

0.1

2

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

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

0

-360

360

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

Wind parameters

Unknown macro: {table-plus}

Name

Units

Advanced

Deprecated

Affects

Description

Required

Default

Min

Max

Condition

rhoa

kgm^-3

 

Air density

1.25

1

2

 

Cd

-

 

Wind drag coefficient

0.002

0.0001

0.01

 

windv

ms^-1

 

Wind velocity, in case of stationary wind

0

0

200

(par.windfile=='')

windth

deg

 

Nautical wind direction, in case of stationary wind

270

-360

360

(par.windfile=='')

windfile

-

windv windth

Name of file with non-stationary wind data

 

 

 

 

  • No labels