| Wiki Markup |
|---|
{redirect:location=http://oss.deltares.nl/web/xbeach/reference|delay=5|visible=true}
{info:title=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].
{info}
{hide-if:space=XBEACH}
{include:ContentHeader}
h3. Bed composition parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| rhos | kgm^\-3 | (x) | (x) | | Solid sediment density \(no pores\) | (x) | 2650 | 2400 | 2800 | \(par.sedtrans==1\) |
| ngd | \- | (x) | (x) | | Number of sediment classes | (x) | 1 | 1 | 20 | |
| nd | \- | (/) | (x) | nd_var | Number of computational layers in the bed | (x) | 3 | 3 | 1000 | |
| dzg1 | m | (/) | (x) | dzg1 dzg2 dzg3 | Thickness of top sediment class layers | (x) | 0.1 | 0.01 | 1 | \(par.sedtrans==1\) |
| | | | | | | (x) | par.dzg1 | 0.01 | 1 | \(par.sedtrans==1\) |
| dzg2 | m | (/) | (x) | | Nominal thickness of variable sediment class layer | (x) | par.dzg1 | 0.01 | 1 | \(par.sedtrans==1\) |
| dzg3 | m | (/) | (x) | | Thickness of bottom sediment class layers | (x) | par.dzg1 | 0.01 | 1 | \(par.sedtrans==1\) |
| por | \- | (x) | (x) | | Porosity | (x) | 0.4 | 0.3 | 0.5 | \(par.sedtrans==1\) |
| D50 | m | (x) | (x) | | D50 grain size per grain type | (x) | 0.0002 | 5e\-005 | 0.0008 | \(par.sedtrans==1\) |
| D90 | m | (x) | (x) | | D90 grain size per grain type | (x) | 0.0003 | 0.0001 | 0.0015 | \(par.sedtrans==1\) |
| sedcal | \- | (/) | (x) | | Sediment transport calibration coefficient per grain type | (x) | 1 | 0 | 2 | \(par.sedtrans==1\) |
| ucrcal | \- | (/) | (x) | | Critical velocity calibration coefficient per grain type | (x) | 1 | 0 | 2 | \(par.sedtrans==1\) |
{table-plus}
h3. Bed update numerics parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| frac_dz | \- | (/) | (x) | | Relative thickness to split time step for bed updating | (x) | 0.7 | 0.5 | 0.98 | \(par.morphology==1\) |
| nd_var | \- | (/) | (x) | | Index of layer with variable thickness | (x) | 2 | 2 | par.nd | \(par.morphology==1\) |
| split | \- | (/) | (x) | | Split threshold for variable sediment layer \(ratio to nominal thickness\) | (x) | 1.01 | 1.005 | 1.1 | \(par.morphology==1\) |
| merge | \- | (/) | (x) | | Merge threshold for variable sediment layer \(ratio to nominal thickness\) | (x) | 0.01 | 0.005 | 0.1 | \(par.morphology==1\) |
{table-plus}
h3. Coriolis force parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| wearth | hour^\-1 | (/) | (x) | | Angular velocity of earth calculated as: 1/rotation_time \(in hours\), later changed in calculation code to rad/s | (x) | 0.041667 | 0 | 1 | |
| lat | deg | (/) | (x) | | Latitude at model location for computing Coriolis | (x) | 0 | \-90 | 90 | |
{table-plus}
h3. Discharge boundary conditions
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| ndischarge | \- | (x) | (x) | | Number of discharge locations | (x) | \-1 | 0 | 100 | |
| ntdischarge | \- | (x) | (x) | | Length of discharge time series | (x) | \-1 | 0 | 100 | |
| disch_loc_file | \- | (x) | (x) | | Name of discharge locations file | (x) | | | | |
| disch_timeseries_file | \- | (x) | (x) | | Name of discharge timeseries file | (x) | | | | |
{table-plus}
h3. Drifters parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| ndrifter | \- | (x) | (x) | | Number of drifers | (x) | \-1 | 0 | 50 | |
| drifterfile | \- | (x) | (x) | | Name of drifter data file | (x) | | | | |
{table-plus}
h3. Flow boundary condition parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| front | \- | (x) | (x) | | Switch for seaward flow boundary: 0 = radiating boundary\(Ad\), 1 = Van Dongeren, 1997 | (x) | abs_2d | | | |
| left | \- | (x) | (x) | | Switch for lateral boundary at ny+1, 'neumann' = vv computed from NSWE, 'wall' = reflective wall; vv=0 | (x) | neumann | | | |
| right | \- | (x) | (x) | | Switch for lateral boundary at right, 0 = vv computed from NSWE, 1 = reflective wall; vv=0 | (x) | neumann | | | |
| back | \- | (x) | (x) | | Switch for boundary at bay side, 0 = radiating boundary \(Ad\), 1 = reflective boundary; uu=0 | (x) | abs_2d | | | |
| ARC | \- | (/) | (x) | | Switch for active reflection compensation at seaward boundary: 0 = reflective, 1 = weakly \(non\) reflective | (x) | 1 | 0 | 1 | |
| order | \- | (/) | (x) | | 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\) | (x) | 2 | 1 | 2 | |
| carspan | \- | (/) | (x) | | Switch for Carrier\-Greenspan test 0 = use cg \(default\); 1 = use sqrt\(gh\) in instat = 3 for c&g tests | (x) | 0 | 0 | 1 | |
| epsi | \- | (/) | (x) | | Ratio of mean current to time varying current through offshore boundary | (x) | 0 | \-1 | 0.2 | |
| tidetype | \- | (/) | (x) | | Switch for offfshore boundary, velocity boundary or instant water level boundary \(default\) | (x) | velocity | | | |
{table-plus}
h3. Flow numerics parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| eps | m | (x) | (x) | | Threshold water depth above which cells are considered wet | (x) | 0.005 | 0.001 | 0.1 | |
| umin | m/s | (x) | (x) | | Threshold velocity for upwind velocity detection and for vmag2 in eq. sediment concentration | (x) | 0 | 0 | 0.2 | |
| hmin | m | (x) | (x) | | Threshold water depth above which Stokes drift is included | (x) | 0.2 | 0.001 | 1 | |
| secorder | \- | (/) | (x) | | Use second order corrections to advection/non\-linear terms based on mcCormack scheme | (x) | 0 | 0 | 1 | |
| oldhu | \- | (/) | (x) | | Turn on / off old hu calculation | (x) | 0 | 0 | 1 | |
{table-plus}
h3. Flow parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| bedfriction | \- | (x) | (x) | bedfricfile C cf | Bed friction formulation: 'chezy','white\-colebrook' | (x) | chezy | | | |
| bedfricfile | \- | (x) | (x) | C cf | Bed friction file \(only valid with values of C\) | (x) | | | | \(\(par.bedfriction\)=='chezy'\) |
| C | m^0.5s^\-1 | (x) | (x) | C cf | Chezy coefficient | (x) | 55 | 20 | 100 | \(\(par.bedfriction\)=='chezy'\) & \~\(\(par.bedfricfile.ne.''\)\) & isSetParameter\('params.txt','C'\) & ~ isSetParameter\('params.txt','cf'\) |
| | | | | | | (x) | 55 | 20 | 100 | \(\(par.bedfriction\)=='chezy'\) & \~\(\(par.bedfricfile.ne.''\)\) & isSetParameter\('params.txt','C'\) & isSetParameter\('params.txt','cf'\) |
| | | | | | | (x) | 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 | \- | (/) | (x) | C cf | Friction coefficient flow | (x) | 0.003 | 0 | 0.1 | \(\(par.bedfriction\)=='chezy'\) & \~\(\(par.bedfricfile.ne.''\)\) & \(isSetParameter\('params.txt','cf'\) & ~ isSetParameter\('params.txt','C'\)\) |
| nuh | m^2s^\-1 | (x) | (x) | | Horizontal background viscosity | (x) | 0.1 | 0 | 1 | |
| nuhfac | \- | (/) | (x) | | Viscosity switch for roller induced turbulent horizontal viscosity | (x) | 1 | 0 | 1 | |
| nuhv | \- | (/) | (x) | | Longshore viscosity enhancement factor, following Svendsen \(?\) | (x) | 1 | 1 | 20 | |
| smag | \- | (/) | (x) | | Switch for smagorinsky subgrid model for viscocity | (x) | 1 | 0 | 1 | |
{table-plus}
h3. Grid parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| depfile | \- | (x) | (x) | | Name of the input bathymetry file | (/) | | | | |
| posdwn | \- | (x) | (x) | | Bathymetry is specified positive down \(1\) or positive up \(\-1\) | (x) | 1 | \-1 | 1 | |
| nx | \- | (x) | (x) | | Number of computiation cell corners in x\-direction | (/) | 50 | 2 | 10000 | |
| ny | \- | (x) | (x) | | Number of computiation cell corners in y\-direction | (/) | 2 | 0 | 10000 | |
| alfa | deg | (x) | (x) | | Angle of x\-axis from East | (x) | 0 | 0 | 360 | |
| vardx | \- | (x) | (x) | dx dy xfile yfile | Switch for variable grid spacing: 1 = irregular spacing, 0 = regular grid spacing | (x) | 0 | 0 | 1 | |
| dx | m | (x) | (x) | | Regular grid spacing in x\-direction | (/) | \-1 | 0 | 1000000000 | \(par.vardx==0\) |
| dy | m | (x) | (x) | | Regular grid spacing in y\-direction | (/) | \-1 | 0 | 1000000000 | \(par.vardx==0\) |
| xfile | name | (x) | (x) | | Name of the file containing x\-coordinates of the calculation grid | (x) | | | | \~\(\(par.vardx==0\)\) |
| yfile | name | (x) | (x) | | Name of the file containing y\-coordinates of the calculation grid | (x) | | | | \~\(\(par.vardx==0\)\) |
| xori | m | (x) | (x) | | X\-coordinate of origin of axis | (x) | 0 | \-1000000000 | 1000000000 | |
| yori | m | (x) | (x) | | Y\-coordinate of origin of axis | (x) | 0 | \-1000000000 | 1000000000 | |
| thetamin | deg | (x) | (x) | | Lower directional limit \(angle w.r.t computational x\-axis\) | (/) | \-90 | \-180 | 180 | |
| thetamax | deg | (x) | (x) | | Higher directional limit \(angle w.r.t computational x\-axis\) | (/) | 90 | \-180 | 180 | |
| dtheta | deg | (x) | (x) | | Directional resolution | (/) | 10 | 0.1 | 20 | |
| thetanaut | \- | (x) | (x) | | Thetamin,thetamax in cartesian \(0\) or nautical convention \(1\) | (x) | 0 | 0 | 1 | |
{table-plus}
h3. Groundwater parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| kx | ms^\-1 | (/) | (x) | ky kz | Darcy\-flow permeability coefficient in x\-direction \[m/s\] | (x) | 0.0001 | 1e\-005 | 0.01 | \(par.gwflow==1\) |
| ky | ms^\-1 | (/) | (x) | | Darcy\-flow permeability coefficient in y\-direction \[m/s\] | (x) | par.kx | 1e\-005 | 0.01 | \(par.gwflow==1\) |
| kz | ms^\-1 | (/) | (x) | | Darcy\-flow permeability coefficient in z\-direction \[m/s\] | (x) | par.kx | 1e\-005 | 0.01 | \(par.gwflow==1\) |
| dwetlayer | m | (/) | (x) | | Thickness of the top soil layer interacting more freely with the surface water | (x) | 0.2 | 0.01 | 1 | \(par.gwflow==1\) |
| aquiferbot | m | (/) | (x) | | Level of uniform aquifer bottom | (x) | \-10 | \-100 | 100 | \(par.gwflow==1\) & \(par.aquiferbotfile==''\) |
| aquiferbotfile | \- | (/) | (x) | aquiferbot | Name of the aquifer bottom file | (x)| | | | | \(par.gwflow==1\) |
| gw0 | m | (/) | (x) | | Level initial groundwater level | (x) | 0 | \-5 | 5 | \(par.gwflow==1\) & \(par.gw0file==''\) |
| gw0file | \- | (/) | (x) | gw0 | Name of initial groundwater level file | (x) | | | | \(par.gwflow==1\) |
{table-plus}
h3. Initial conditions
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| zs0 | m | (x) | (x) | | Inital water level | (x) | 0 | \-5 | 5 | \~\(\(par.tideloc>0\)\) |
| zsinitfile | name | (x) | (x) | | Name of inital condition file zs | (x) | | | | |
{table-plus}
h3. MPI parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| mpiboundary | \- | (/) | (x) | | Fix mpi boundaries along y\-lines \('y'\), x\-lines \('x'\), or find shortest boundary \('auto'\) | (x) | auto | | | |
{table-plus}
h3. Model time
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| tstop | s | (x) | (x) | morstop tintm | Stop time of simulation, in morphological time | (/) | 2000 | 1 | 1000000 | |
| CFL | \- | (x) | (x) | | Maximum Courant\-Friedrichs\-Lewy number | (x) | 0.7 | 0.1 | 0.9 | |
{table-plus}
h3. Morphology parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| morfac | \- | (x) | (x) | | Morphological acceleration factor | (x) | 1 | 0 | 1000 | \(par.morphology==1\) |
| morfacopt | \- | (/) | (x) | | Option indicating whether times should be adjusted \(1\) or not\(0\) for morfac | (x) | 1 | 0 | 1 | \(par.morphology==1\) |
| morstart | s | (x) | (x) | | Start time morphology, in morphological time | (x) | 120 | 0 | 10000 | \(par.morphology==1\) |
| morstop | s | (x) | (x) | | Stop time morphology, in morphological time | (x) | par.tstop | 0 | 10000 | \(par.morphology==1\) |
| wetslp | \- | (x) | (x) | | Critical avalanching slope under water \(dz/dx and dz/dy\) | (x) | 0.3 | 0.1 | 1 | \(par.morphology==1\) |
| dryslp | \- | (x) | (x) | | Critical avalanching slope above water \(dz/dx and dz/dy\) | (x) | 1 | 0.1 | 2 | \(par.morphology==1\) |
| hswitch | m | (/) | (x) | | Water depth at which is switched from wetslp to dryslp | (x) | 0.1 | 0.01 | 1 | \(par.morphology==1\) |
| dzmax | m/s/m | (/) | (x) | | Maximum bedlevel change due to avalanching | (x) | 0.05 | 0 | 1 | \(par.morphology==1\) |
| struct | \- | (x) | (x) | ne_layer | Switch for hard structures | (x) | 0 | 0 | 1 | \(par.morphology==1\) |
| ne_layer | name | (x) | (x) | | Name of file containing depth of hard structure | (x) | | | | \(par.morphology==1\) & \(par.struct==1\) |
{table-plus}
h3. Non\-hydrostatic correction parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| solver_maxit | \- | (/) | (x) | | Maximum number of iterations in the linear SIP solver | (x) | 30 | 1 | 1000 | \(par.nonh==1\) |
| solver_acc | \- | (/) | (x) | | accuracy with respect to the right\-hand side usedin the following termination criterion:\|\|b\-Ax \|\| < acc*\|\|b\|\| | (x) | 0.005 | 1e\-005 | 0.1 | \(par.nonh==1\) |
| solver_urelax | \- | (/) | (x) | | Underrelaxation parameter | (x) | 0.92 | 0.5 | 0.99 | \(par.nonh==1\) |
| solver | \- | (/) | (x) | | Solver used to solve the linear system, 1=SIP, 2=TRIDIAG \(only for 1d\) | (x) | 1 | 0 | 2 | \(par.nonh==1\) |
| kdmin | \- | (/) | (x) | | Minimum value of kd \( pi/dx > minkd \) | (x) | 0 | 0 | 0.05 | \(par.nonh==1\) |
| dispc | ? | (/) | (x) | | Coefficient in front of the vertical pressure gradient, Default = 1. | (x) | 1 | 0.1 | 2 | \(par.nonh==1\) |
| Topt | s | (/) | (x) | | Absolute period to optimize coefficient | (x) | 10 | 1 | 20 | \(par.nonh==1\) |
{table-plus}
h3. Output variables
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| timings | \- | (/) | (x) | | Switch to turn on \(1\) or off \(0\) progress output to screen | (x) | 1 | 0 | 1 | |
| tstart | s | (x) | (x) | tintm | Start time of output, in morphological time | (x) | 1 | 0 | 1000000 | |
| tint | s | (x) | (/) | tintg tintp tintc | Interval time of global output \(replaced by tintg\) | (x) | 1 | 0.01 | 100000 | |
| tintg | s | (x) | (x) | | Interval time of global output | (x) | par.tint | 0.01 | 100000 | \(par.tsglobal==''\) |
| tintp | s | (x) | (x) | | Interval time of point and runup gauge output | (x) | par.tint | 0.01 | 100000 | \(par.tspoints==''\) |
| tintc | s | (/) | (x) | | Interval time of cross section output | (x) | par.tint | 0.01 | 100000 | \(par.tscross==''\) |
| tintm | s | (x) | (x) | | Interval time of mean,var,max,min output | (x) | par.tstop\-par.tstart | 1 | par.tstop\-par.tstart | \(par.tsmean==''\) |
| tsglobal | \- | (/) | (x) | tintg | Name of file containing timings of global output | (x) | | | | |
| tspoints | \- | (/) | (x) | tintp | Name of file containing timings of point output | (x) | | | | |
| tscross | \- | (/) | (x) | tintc | Name of file containing timings of cross section output | (x) | | | | |
| tsmean | \- | (/) | (x) | tintm | Name of file containing timings of mean, max, min and var output | (x) | | | | |
| nglobalvar | \- | (x) | (x) | | Number of global output variables \(as specified by user\) | (x) | \-1 | \-1 | 20 | |
| nmeanvar | \- | (x) | (x) | | Number of mean,min,max,var output variables | (x) | 0 | 0 | 15 | |
| npointvar | \- | (x) | (x) | | Number of point output variables | (x) | 0 | 0 | 50 | |
| npoints | \- | (x) | (x) | | Number of output point locations | (x) | 0 | 0 | 50 | |
| nrugauge | \- | (x) | (x) | | Number of output runup gauge locations | (x) | 0 | 0 | 50 | |
| rugdepth | m | (/) | (x) | | Minimum depth for determination of last wet point in runup gauge | (x) | 0 | 0 | 0.05 | |
| ncross | \- | (/) | (x) | | Number of output cross sections | (x) | 0 | 0 | 50 | |
| outputformat | \- | (/) | (x) | | Choice of output file format: 'netcdf', 'fortran', or 'debug' | (x) | fortran | | | | |
| ncfilename | \- | (/) | (x) | | xbeach netcdf output file name | (x) | | | | |
{table-plus}
h3. Physical constants
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| g | ms^\-2 | (x) | (x) | | Gravitational acceleration | (x) | 9.81 | 9.7 | 9.9 | |
| rho | kgm^\-3 | (x) | (x) | | Density of water | (x) | 1025 | 1000 | 1040 | |
| depthscale | \- | (/) | (x) | | 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\) | (x) | 1 | 1 | 200 | |
{table-plus}
h3. Physical processes
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| swave | \- | (x) | (x) | thetamin thetamax dtheta instat | Include short waves \(1\), exclude short waves \(0\) | (x) | 1 | 0 | 1 | |
| lwave | \- | (x) | (x) | | Include short wave forcing on NLSW equations and boundary conditions \(1\), or exclude \(0\) | (x) | 1 | 0 | 1 | |
| flow | \- | (x) | (x) | | Include flow calculation \(1\), or exclude \(0\) | (x) | 1 | 0 | 1 | |
| sedtrans | \- | (x) | (x) | 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\) | (x) | 1 | 0 | 1 | |
| morphology | \- | (x) | (x) | morfac morfacopt morstart morstop wetslp dryslp hswitch dzmax struct ne_layer frac_dz nd_var split merge | Include morphology \(1\) or exclude \(0\) | (x) | 1 | 0 | 1 | |
| nonh | \- | (/) | (x) | 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 | (x) | 0 | 0 | 1 | |
| gwflow | \- | (/) | (x) | kx ky kz dwetlayer aquiferbot aquiferbotfile gw0 gw0file | Turn on \(1\) or off \(0\) groundwater flow module | (x) | 0 | 0 | 1 | |
| q3d | \- | (/) | (x) | vonkar vicmol kmax sigfac | Turn on \(1\) or off \(0\) quasi\-3D sediment transport module | (x) | 0 | 0 | 1 | |
{table-plus}
h3. Q3D sediment transport parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| vonkar | unknown | (/) | (x) | | von Karman constant | (x) | 0.4 | 0.01 | 1 | \(par.q3d==1\) |
| vicmol | unknown | (/) | (x) | | molecular viscosity | (x) | 1e\-006 | 0 | 0.001 | \(par.q3d==1\) |
| kmax | \- | (/) | (x) | | Number of sigma layers in Quasi\-3D model; kmax = 1 \(default\) is without vertical structure of flow and suspensions | (x) | 1 | 1 | 1000 | \(par.q3d==1\) |
| sigfac | \- | (/) | (x) | | dsig scales with log\(sigfac\). Default = 1.3 | (x) | 1.3 | 0 | 10 | \(par.q3d==1\) |
{table-plus}
h3. Roller parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| roller | \- | (/) | (x) | | Turn on \(1\) or off\(0\) roller model | (x) | 1 | 0 | 1 | |
| beta | \- | (/) | (x) | | Breaker slope coefficient in roller model | (x) | 0.1 | 0.05 | 0.3 | |
| rfb | \- | (/) | (x) | | If rfb = 1 then maximum wave surface slope is feeded back in roller energy balance; else rfb = par%Beta | (x) | 0 | 0 | 1 | |
{table-plus}
h3. Sediment transport numerics parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| thetanum | \- | (/) | (x) | | Coefficient determining whether upwind \(1\) or central scheme \(0.5\) is used. | (x) | 1 | 0.5 | 1 | \(par.sedtrans==1\) |
| sourcesink | \- | (/) | (x) | | In suspended transport use source\-sink terms to calculate bed level change \(1\) or sus transport gradients \(0\) | (x) | 0 | 0 | 1 | \(par.sedtrans==1\) |
{table-plus}
h3. Sediment transport parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| waveform | \- | (x) | (x) | | Option for waveshape model: 1 = Ruessink & Van Rijn, 2 = Van Thiel de Vries, 2009 | (x) | vanthiel | | | \(par.sedtrans==1\) |
| form | \- | (x) | (x) | | Equilibrium sed. conc. formulation: 1 = Soulsby van Rijn, 1997, 2 = Van Rijn 2008 with modifications by Van Thiel | (x) | vanthiel_vanrijn | | | \(par.sedtrans==1\) |
| sws | \- | (/) | (x) | | 1 = short wave & roller stirring and undertow, 0 = no short wave & roller stirring and undertow | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| lws | \- | (/) | (x) | | 1 = long wave stirring, 0 = no long wave stirring | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| BRfac | \- | (/) | (x) | | Calibration factor surface slope | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| facsl | \- | (/) | (x) | | Factor bedslope effect | (x) | 1.6 | 0 | 1.6 | \(par.sedtrans==1\) |
| z0 | m | (/) | (x) | | Zero flow velocity level in Soulsby van Rijn \(1997\) sed.conc. expression | (x) | 0.006 | 0.0001 | 0.05 | \(par.sedtrans==1\) |
| smax | \- | (/) | (x) | | Being tested: maximum Shields parameter for ceq Diane Foster | (x) | \-1 | \-1 | 3 | \(par.sedtrans==1\) |
| tsfac | \- | (/) | (x) | | Coefficient determining Ts = tsfac * h/ws in sediment source term | (x) | 0.1 | 0.01 | 1 | \(par.sedtrans==1\) |
| facua | \- | (/) | (x) | facSk facAs | Calibration factor time averaged flows due to wave skewness and asymmetry | (x) | 0.1 | 0 | 1 | \(par.sedtrans==1\) |
| facSk | \- | (/) | (x) | | Calibration factor time averaged flows due to wave skewness | (x) | par.facua | 0 | 1 | \(par.sedtrans==1\) |
| facAs | \- | (/) | (x) | | Calibration factor time averaged flows due to wave asymmetry | (x) | par.facua | 0 | 1 | \(par.sedtrans==1\) |
| turb | \- | (/) | (x) | | Equlibrium sediment concentration is computed as function of:none = no turbulence, | (x) | bore_averaged | | | \(par.sedtrans==1\) |
| Tbfac | \- | (/) | (x) | | Calibration factor for bore interval Tbore: Tbore = Tbfac*Tbore | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| Tsmin | s | (/) | (x) | | Minimum adaptation time scale in advection diffusion equation sediment | (x) | 0.2 | 0.01 | 10 | \(par.sedtrans==1\) |
| lwt | \- | (/) | (x) | | Switch 0/1 long wave turbulence model | (x) | 0 | 0 | 1 | \(par.sedtrans==1\) |
| betad | \- | (/) | (x) | | Dissipation parameter long wave breaking turbulence | (x) | 1 | 0 | 10 | \(par.sedtrans==1\) |
| sus | \- | (/) | (x) | | Calibration factor for suspensions transports \[0..1\] | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| bed | \- | (/) | (x) | | Calibration factor for bed transports \[0..1\] | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
| bulk | \- | (/) | (x) | | Option to compute bedload and suspended load seperately; 0 = seperately, 1 = bulk \(as in previous versions\) | (x) | 1 | 0 | 1 | \(par.sedtrans==1\) |
{table-plus}
h3. Tide boundary conditions
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| zs0file | \- | (x) | (x) | | Name of tide boundary condition series | (x) | | | | \(par.tideloc>0\) |
| tideloc | \- | (x) | (x) | zs0 zs0file paulrevere | Number of corner points on which a tide time series is specified | (x) | 0 | 0 | 4 | |
| paulrevere | \- | (x) | (x) | | 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 | (x) | land | | | \(par.tideloc>0\) & \(par.tideloc==2\) |
{table-plus}
h3. Wave boundary condition parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| instat | \- | (x) | (x) | 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 | (x) | (x) | | Spin\-up time of wave boundary conditions, in morphological time | (x) | 100 | 0 | 1000 | |
| Hrms | m | (x) | (x) | | Hrms wave height for instat = 0,1,2,3 | (x) | 1 | 0 | 10 | \(\(par.instat\)=='stat'\) |
| | | | | | | (x) | 1 | 0 | 10 | \(par.instat\)=='bichrom' |
| | | | | | | (x) | 1 | 0 | 10 | \(par.instat\)=='ts_1' \| \(par.instat\)=='ts_2' |
| Tm01 | s | (x) | (/) | Trep | Old name for Trep | (x) | 10 | 1 | 20 | \(\(par.instat\)=='stat'\) |
| | | | | | | (x) | 10 | 1 | 20 | \(par.instat\)=='bichrom' |
| | | | | | | (x) | 10 | 1 | 20 | \(par.instat\)=='ts_1' \| \(par.instat\)=='ts_2' |
| Trep | s | (x) | (x) | | Representative wave period for instat = 0,1,2,3 | (x) | par.Tm01 | 1 | 20 | \(\(par.instat\)=='stat'\) |
| | | | | | | (x) | par.Tm01 | 1 | 20 | \(par.instat\)=='bichrom' |
| | | | | | | (x) | par.Tm01 | 1 | 20 | \(par.instat\)=='ts_1' \| \(par.instat\)=='ts_2' |
| Tlong | s | (x) | (x) | | Wave group period for case instat = 1 | (x) | 80 | 20 | 300 | \(par.instat\)=='bichrom' |
| dir0 | deg | (x) | (x) | | Mean wave direction \(Nautical convention\) for instat = 0,1,2,3 | (x) | 270 | 180 | 360 | \(\(par.instat\)=='stat'\) |
| | | | | | | (x) | 270 | 180 | 360 | \(par.instat\)=='bichrom' |
| | | | | | | (x) | 270 | 180 | 360 | \(par.instat\)=='ts_1' \| \(par.instat\)=='ts_2' |
| nmax | \- | (/) | (x) | | maximum ratio of cg/c fro computing long wave boundary conditions | (x) | 0.8 | 0.5 | 1 | |
| m | \- | (x) | (x) | | Power in cos^m directional distribution for instat = 0,1,2,3 | (x) | 10 | 2 | 128 | \(\(par.instat\)=='stat'\) |
| | | | | | | (x) | 10 | 2 | 128 | \(par.instat\)=='bichrom' |
| | | | | | | (x) | 10 | 2 | 128 | \(par.instat\)=='ts_1' \| \(par.instat\)=='ts_2' |
| leftwave | \- | (x) | (x) | | old name for lateralwave | (x) | neumann | | | |
| rightwave | \- | (x) | (x) | | old name for lateralwave | (x) | neumann | | | |
{table-plus}
h3. Wave breaking parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| break | \- | (x) | (x) | gamma2 | Type of breaker formulation \(1=roelvink, 2=baldock, 3=roelvink adapted, 4=roelvink on/off breaking\) | (x) | roelvink2 | | | |
| gamma | \- | (x) | (x) | | Breaker parameter in Baldock or Roelvink formulation | (x) | 0.55 | 0.4 | 0.9 | |
| gamma2 | \- | (x) | (x) | | End of breaking parameter in break = 4 formulation | (x) | 0.3 | 0 | 0.5 | \(\(par.break\)=='roelvink_daly'\) |
| alpha | \- | (/) | (x) | | Wave dissipation coefficient in Roelvink formulation | (x) | 1 | 0.5 | 2 | |
| n | \- | (/) | (x) | | Power in Roelvink dissipation model | (x) | 10 | 5 | 20 | |
| gammax | \- | (/) | (x) | | Maximum ratio wave height to water depth | (x) | 2 | 0.4 | 5 | |
| delta | \- | (/) | (x) | | Fraction of wave height to add to water depth | (x) | 0 | 0 | 1 | |
| fw | \- | (/) | (x) | | Bed friction factor | (x) | 0 | 0 | 1 | |
| breakerdelay | \- | (/) | (x) | | Turn on \(1\) or off \(0\) breaker delay model | (x) | 1 | 0 | 1 | |
{table-plus}
h3. Wave numerics parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| scheme | \- | (/) | (x) | | Use first\-order upwind \(upwind_1\), second order upwind \(upwind_2\) or Lax\-Wendroff \(lax_wendroff\)for wave propagation | (x) | upwind_2 | | | |
| wavint | s | (x) | (x) | | Interval between wave module calls \(only in stationary wave mode\) | (x) | 60 | 1 | 3600 | \(\(par.instat\)=='stat' \| \(par.instat\)=='stat_table'\) |
| maxerror | m | (/) | (x) | | Maximum wave height error in wave stationary iteration | (x) | 5e\-005 | 1e\-005 | 0.001 | \(\(par.instat\)=='stat' \| \(par.instat\)=='stat_table'\) |
| maxiter | \- | (/) | (x) | | Maximum number of iterations in wave stationary | (x) | 500 | 2 | 1000 | \(\(par.instat\)=='stat' \| \(par.instat\)=='stat_table'\) |
{table-plus}
h3. Wave\-current interaction parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| wci | \- | (x) | (x) | | Turns on \(1\) or off \(0\) wave\-current interaction | (x) | 0 | 0 | 1 | |
| hwci | m | (/) | (x) | | Minimum depth until which wave\-current interaction is used | (x) | 0.1 | 0.001 | 1 | |
| cats | Trep | (/) | (x) | | Current averaging time scale for wci, in terms of mean wave periods | (x) | 4 | 1 | 50 | |
{table-plus}
h3. Wave\-spectrum boundary condition parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| bcfile | \- | (x) | (x) | | Name of spectrum file | (x) | | | | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='stat_table' \| \(par.instat\)=='jons_table'\) |
| random | \- | (/) | (x) | | Random seed on \(1\) or off \(0\) for instat = 4,5,6 boundary conditions | (x) | 1 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| fcutoff | Hz | (/) | (x) | | Low\-freq cutoff frequency for instat = 4,5,6 boundary conditions | (x) | 0 | 0 | 40 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| nspr | \- | (/) | (x) | | nspr = 1 long wave direction forced into centres of short wave bins, nspr = 0 regular long wave spreadin | (x) | 0 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| trepfac | \- | (/) | (x) | | Compute mean wave period over energy band: par%trepfac*maxval\(Sf\) for instat 4,5,6; converges to Tm01 for trepfac = 0.0 and | (x) | 0.01 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| sprdthr | \- | (/) | (x) | | Threshold ratio to maxval of S above which spec dens are read in \(default 0.08*maxval\) | (x) | 0.08 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| oldwbc | \- | (/) | (x) | | \(1\) Use old version wave boundary conditions for instat 4,5,6 | (x) | 0 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| correctHm0 | \- | (/) | (x) | | Turn off or on Hm0 correction | (x) | 1 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| oldnyq | \- | (/) | (x) | | Turn off or on old nyquist switch | (x) | 0 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| Tm01switch | \- | (/) | (x) | | Turn off or on Tm01 or Tm\-10 switch | (x) | 0 | 0 | 1 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) |
| rt | s | (x) | (x) | | Duration of wave spectrum at offshore boundary, in morphological time | (x) | 3600 | 1200 | 7200 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) & \(filetype==0\) |
| dtbc | s | (/) | (x) | | Timestep used to describe time series of wave energy and long wave flux at offshore boundary \(not affected by morfac\) | (x) | 0.5 | 0.1 | 2 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) & \(filetype==0\) |
| dthetaS_XB | deg | (/) | (x) | | If SWAN input is not in nautical degrees, dthetaS_XB is the angle from SWAN x\-axis to XBeach x\-axis in cathesian degrees | (x) | 0 | \-360 | 360 | \(\(par.instat\)=='jons' \| \(par.instat\)=='swan' \| \(par.instat\)=='vardens' \| \(par.instat\)=='jons_table'\) & \(\(par.instat\)=='swan'\) |
{table-plus}
h3. Wind parameters
{table-plus:width=1200}
|| Name || Units || Advanced || Deprecated || Affects || Description || Required || Default || Min || Max || Condition ||
| rhoa | kgm^\-3 | (/) | (x) | | Air density | (x) | 1.25 | 1 | 2 | |
| Cd | \- | (/) | (x) | | Wind drag coefficient | (x) | 0.002 | 0.0001 | 0.01 | |
| windv | ms^\-1 | (x) | (x) | | Wind velocity, in case of stationary wind | (x) | 0 | 0 | 200 | \(par.windfile==''\) |
| windth | deg | (x) | (x) | | Nautical wind direction, in case of stationary wind | (x) | 270 | \-360 | 360 | \(par.windfile==''\) |
| windfile | \- | (x) | (x) | windv windth | Name of file with non\-stationary wind data | (x) | | | | |
{table-plus}
{hide-if} |
Page History
Overview
Content Tools