Input parameters

Different parameters for model input and output of SFINCS can be changed in sfincs.inp, see below.

Traditionally SFINCS neglects the advection term in the SFINCS-LIE version (‘advection = 0’). For super-critical flow conditions or modelling waves, the SFINCS-SSWE version can be used (‘advection = 1’ for 1D modelling and ‘advection = 2’ for 2D modelling) for better performance.

Parameters for model input

More parameters for model input (only for advanced users)

bndtype
description:

Boundary type for interpretation of ‘sfincs.bzs’ time-series. bndtype=1 is for water levels, bndtype=2 is for horizontal velocities (in m/s) and bndtype=3 for horizontal discharges (in m2/s).

units:
default:

1

min:

1

max:

3

rhoa
description:

Density of the air

units:
default:

1.25

min:
max:
rhow
description:

Density of the water

units:
default:

1024

min:
max:
stopdepth
description:Water depth anywhere in the domain after which the simulation is classified as unstable and stopped
units:m
default:100
min:0
max:Inf
advlim
description:

Advection limiter when advection>0 to limit the magnitude of the advection term when calculating fluxes between cells.

units:
default:

9999

min:

0

max:

9999

dtmax
description:Maximum internal time step to be used
units:s
default:60
min:1.0e-3
max:Inf
dtmin
description:Minimum internal time step to be used
units:s
default:1.0e-3
min:1.0e-3
max:Inf
tspinup
description:Duration of internal spinup period before tstart
units:s
default:0
min:0
max:Inf

Drag coefficients:

cdnrb
description:

Number of specified break points

units:
default:

3

min:

2

max:
cdwnd
description:

Wind speed break points (including 0)

units:
default:

0 28 50

min:

2 values

max:
description:

Drag coefficient brak points

units:
default:

0.001 0.0025 0.0015

min:

2 values

max:

Different parameters influencing the given output by SFINCS can be changed, see below.

Parameters for model output

tref
description:

Reference date in ‘yyyymmdd HHMMSS’

units:
default:

20000101 000000

tstart
description:

Start date in ‘yyyymmdd HHMMSS’

units:
default:

20000101 000000

tstop
description:Stop date in ‘yyyymmdd HHMMSS’
units:m
default:20000101 000000
dtout
description:Time-step global map output.
units:s
default:0
dthisout
description:Time-step observation points output.
units:s
default:600
dtmaxout
description:Time-step interval of global map output of maximum water level. If dtmaxout=0, no maximum water level output is given by SFINCS
units:s
default:0
min:0
max:‘tstop - start in seconds’
dtwnd
description:Time-interval wind update (only for spiderweb)
units:s
default:1800
outputformat
description:

Choice whether the SFINCS model output is given in binary ‘bin’, ascii ‘asc’ or netcdf files ‘net’ (default). In case of netcdf output, global output is given in ‘sfincs_map.nc’, point output in ‘sfincs_his.nc’ in case observation points are specified.

units:
default:

net

restartfile = sfincs.restart
description:Specify a filename for ‘restartfile’ to get an ascii output file with water levels at the last time step, that can be forced as inifile.
units:string
default:off

Input files

SFINCS consists of many different input files, this overview gives a description, whether they are required or not, unit and format (bin = binary, asc = ascii and net = netcdf).

_images/SFINCS_documentation_figure1.png

Fig. 19 Overview of input file of SFINCS with indication whther they are required or not

Domain

sfincs.inp
description:General input file of SFINCS describing all model settings, the domain, forcing and structures.
required:yes
format:asc
depfile = sfincs.dep
description:Elevation (bathymetry and topography) at grid cell centres above a reference level.
units:m above reference level
required:yes
format:bin or asc
mskfile = sfincs.msk
description:

This mask indicates for every cell whether it is an inactive cell (msk=0), active cell (msk=1), boundary cell (msk=2) or outflow boundary cell msk=3).

units:
required:

yes

format:

bin or asc

indexfile = sfincs.ind
description:

file describing the indices of active grid cells within the overall grid

units:
required:

Only if ‘inputformat = bin’

format:

bin

mskfile = sfincs.msk
description:

This mask indicates for every cell whether it is an inactive cell (msk=0), active cell (msk=1), boundary cell (msk=2) or outflow boundary cell msk=3).

units:
required:

yes

format:

bin or asc

manningfile = sfincs.man
description:For spatially varying friction values per cell use the manningfile option, with the same grid based input as the depfile using a binary file.
units:s/m^(1/3)
required:no
format:bin
qinffile = sfincs.qinf
description:For spatially varying constant in time infiltration values per cell use the qinffile option, with the same grid based input as the depfile using a binary file.
units:mm/hr
required:no
format:bin
scsfile = sfincs.scs
description:

For spatially varying infiltration values per cell using the Curve Number method use the scsfile option, with the same grid based input as the depfile using a binary file.

units:
required:

no

format:

bin

sbgfile = sfincs.sbg
description:

Using subgrid tables with the sbgfile is an advanced option.

units:
required:

Only for running SFINCS in subgrid mode

format:

bin

obsfile = sfincs.obs
description:To get output time-series at individual point locations, observations points have to be specified.
units:m in projected UTM zone
required:no (only if point output is wanted)
format:asc
inifile = sfincs.ini
description:For spatially varying initial water level per cell, with the same grid based input as the depfile using a ascii file.
units:m above reference level
required:no
format:asc

Forcing - Water levels and waves

bndfile = sfincs.bnd
description:To specify water-level time-series to the boundary cells (msk=2), first the input locations have to be specified in ‘sfincs.bnd’.
units:m in projected UTM zone
required:Only when specifying water levels and waves.
format:asc
bzsfile = sfincs.bzs
description:In the file ‘sfincs.bzs’ the (slowly varying) water level time-series are specified per input location.
units:m above reference level
required:Only when specifying water levels.
format:asc
bzifile = sfincs.bzi
description:Tn the file ‘sfincs.bzi’ the quickly varying water level time-series due to incoming waves are specified per input location. Do note that the input timestep should be the same in both the bzs and bzi files!
units:m around mean water level of bzsfile
required:Only when specifying waves.
format:asc
netbndbbzsbzifile = sfincs_netbndbzsbzifile.nc
description:To specify all bnd, bzs (and bzi) input in 1 FEWS compatible netcdf input file. Specify either the netcdf version or ascii, not both.
units:m in projected UTM zone, m above reference level & m around mean water level of bzsfile
required:Only when specifying water levels and waves using netcdf input file.
format:net

Forcing - Discharges

srcfile = sfincs.src
description:To specify discharge points, first the input locations have to be specified in ‘sfincs.src’.
units:m in projected UTM zone
required:Only when specifying discharges.
format:asc
disfile = sfincs.dis
description:In the file ‘sfincs.dis’ the discharge time-series are specified per input location.
units:m^3/s
required:Only when specifying discharges.
format:asc

Forcing - Meteo

spwfile = sfincs.spw
description:Spiderweb file including wind speed, direction, pressure (and possibly rainfall).
units:coordinates: m in projected UTM zone, data: m/s, wind_from_direction in degrees, p_drop in Pa (and precipitation in mm/hr).
required:no
format:asc
amufile = sfincs.amu
description:Delft3D-meteo ascii type input of wind speed in x-direction.
units:coordinates: m in projected UTM zone, data: m/s
required:no
format:asc
amvfile = sfincs.amv
description:Delft3D-meteo ascii type input of wind speed in y-direction.
units:coordinates: m in projected UTM zone, data: m/s
required:no
format:asc
amprfile = sfincs.amp
description:Delft3D-meteo ascii type input of atmospheric pressure.
units:coordinates: m in projected UTM zone, data: Pa
required:no
format:asc
amprfile = sfincs.ampr
description:Delft3D-meteo ascii type input of precipitation intensity.
units:coordinates: m in projected UTM zone, data: mm/hr
required:no
format:asc
wndfile = sfincs.wnd
description:Spatially uniform wind
units:wind speed in m/s, wind direction in nautical from where the wind is coming
required:no
format:asc
precipfile = sfincs.prcp
description:Spatially uniform precipitation
units:mm/hr
required:no
format:asc
netamuamvfile = sfincs_netamuamvfile.nc
description:FEWS type netcdf meteo input with wind speed in both x-&y-direction in m/s.
units:coordinates: m in projected UTM zone, data: m/s
required:no
format:net
netamprfile = sfincs_netamprfile.nc
description:FEWS type netcdf meteo input with precipitation in mm/hr.
units:coordinates: m in projected UTM zone, data: mm/hr
required:no
format:net

Structures

thdfile = sfincs.thd
description:With a thin dam flow through certain grid cells is completely blocked (i.e. an infinitely high wall).
units:coordinates: m in projected UTM zone.
required:no
format:asc
weirfile = sfincs.weir
description:Weirs are in principle the same as a thin dam, but then with a certain height (levee).
units:coordinates: m in projected UTM zone, elevation in m above reference level, weir formula coefficient in [-]
required:no
format:asc
drnfile = sfincs.drn
description:Drainage pumps and culverts are both specified using the same format file, put with a different indication of the type (type=1 is drainage pump, type=2 is culvert).
units:coordinates: m in projected UTM zone, discharges in m^3/s.
required:no
format:asc