...
Info |
---|
rhos | kgm^-3 | Solid sediment density (no pores) |
ngd | - | Number of sediment classes |
nd | - | Number of computational layers in the bed |
dzg1 | 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 |
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
| ||
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. |
hide-if | ||||||
---|---|---|---|---|---|---|
| ||||||
Bed composition parametersBed update numerics parametersCoriolis force parametersDischarge boundary conditionsDrifters parametersFlow boundary condition parametersFlow numerics parametersFlow parametersGrid parametersGroundwater parametersInitial conditionsMPI parametersModel timeMorphology parametersNon-hydrostatic correction parametersOutput variablesPhysical constantsPhysical processesQ3D sediment transport parametersRoller parametersSediment transport numerics parametersSediment transport parametersTide boundary conditionsWave boundary condition parametersWave breaking parametersWave numerics parametersWave-current interaction parametersWave-spectrum boundary condition parametersWind parameters |
...
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
...
-
...