SFINCS - SFINCS v2.2.0 col d'Eze Release 2025.01

v2.2.0 col d'Eze release

The first official 2025 release of SFINCS, the v2.2.0 col d'Eze release, 'Easing over bumps in fast compound flood modelling together', is now available!

This contains open access to the source code from Github: https://github.com/Deltares/SFINCS/releases/tag/v2.2.0_col_dEze_release.

As pre-compiled Windows executable:

https://download.deltares.nl/en/sfincs/

As Docker container:

docker pull deltares/sfincs-cpu:sfincs-v2.2.0-col-dEze-Release

Changes:

The code consists of all functionality of the v2.1.1 release, with the following major changes/additions:

• Improvements on numerical stability. Achieved through additions of uvmax, hmin_cfl, uvlim, slopelim, advlim (see below) to replace the old stability criteria using 'stopdepth' with square root of gh (removed, see below). Impacts both regular gridded as subgrid model simulations.
• Improvements subgrid mode through added checks on input file, subgrid mode consistent with SFINCS subgrid paper: van Ormondt et al. (2025): https://doi.org/10.5194/gmd-18-843-2025.
• Addition of automatic creation of a 'sfincs.log' output file. Implemented so that only a shortened output is send to screen (or in 'sfincs_log.txt' as in our examples using 'run.bat' batchfile), and a longer more elaborate version to the 'sfincs.log' file.
  NOTE - in the run.bat batchfile you can therefore not specify '/sfincs.exe>sfincs.log' anymore, since that conflicts with the automatically generated file. Any other name (as sfincs_log.txt in our examples) will do, or don't specify an output file for the messages to the screen at all!
• Added more clear overview of what parameters are turned on or off by displaying a summarizing table in the log file and to screen messages (e.g. coriolis, also see below).
• Added option to set how frequent to show progress of SFINCS in terms of % and time remaining in sfincs.inp using percentage_done (default = 5%). So can also be said to e.g. every 1%, or 10%.
• Update of the integrated SnapWave solver to be consistent with the Roelvink et al. 2025 version (https://doi.org/10.5194/egusphere-2025-492).
• New Python setup tools HydroMT-SFINCS release > highly recommended to use this new version instead of the last release (v1.1.0)!
• Update of executable license from 'Deltares free trial copy' to 'Deltares freeware license', to be accepted upon downloading from portal (same as before). For details always read the full license (LICENSING CONDITIONS DELTARES FREEWARE EXECUTABLE.txt).

Detailed overview additions/changes:

• stopdepth - REMOVED in SFINCS v2.2.0, replaced by 'uvmax' to determine possible instabilities based on flow velocities rather than maximum water depth!
• uvmax - possibility to set maximum flux velocity (default 1000 m/s), used to determine minimum timestep, below which simulation is classified as unstable and stopped. Replaces 'stopdepth'.
• hmin_cfl - possibility to set minimum water depth to determine maximum timestep using CFL-conditions.
• uvlim - possibility to limit flux velocity (default 10 m/s).
• slopelim - possibility to apply slope limiter to dzdx (turned off by default, by setting to 9999.9).
• advlim - updated use of the advection limiter, new default is 1.0, whereby limiter is turned on by default.
• coriolis - clarification of use in model and logfile: for projected coordinate systems only turned on if a latitude is provided other than 0 (default, latitude = 0.0, means no coriolis terms used in momentum equation). For large scale applications on spherical grid, the coriolis term is turned on by default.
• waterlevel 'zs' and volume 'z_volume' internal variables in SFINCS kernel are now stored as double precision.

Bugfixes:

• Bugfix structures (pump, culvert, valve) so they cannot fall dry to NaNs in case the sink term cell becomes fully dry.
• Bugfix advection scheme. Influence on real world application cases in our testbed is small/negligible.

Advanced user options - currently as alpha/beta functionality:

• NOTE - please contact Deltares-SFINCS group in case you want to use any of this functionality.

• Upgraded BMI implementation to be complient with that of XMI (BMI + extensions - Hughes et al. 2022), to be used with 'xmipy' (https://github.com/Deltares/xmipy) and related functions (https://deltares.github.io/xmipy/xmipy.html).

• Nonhydrostatic pressure correction (for tsunami wave modelling), keywords nonh = yes (default no) and 'nh_tstop', 'nh_fnudge', 'nh_tol', 'nh_itermax'. Also added option to specify 'nonh_mask' to turn on nonh correction only in part of the domain.

• Added lookup table for h^(7/3) term in momentum equation. Potentially faster. Keyword h73table = 1/yes/true (default: false).

• Added option to store subgrid hmean (rather than zs - z_zmin), keyword storehmean = yes (default no)

Climate Change - Natural Hazard and Storm - Fortran
Published by Leynse 14 days ago

SFINCS - SFINCS v2.1.1 Dollerup Release 2024.01

v2.1.1 Dollerup release

The first official 2024 release of SFINCS, the v2.1.1 Dollerup release, 'Conquering challenges in compound flood modelling together', is now available!

This contains open access to the source code from Github: https://github.com/Deltares/SFINCS/releases/tag/v2.1.1_Dollerup_release.

As pre-compiled Windows executable:

https://download.deltares.nl/en/sfincs/

As Docker container:

docker pull deltares/sfincs-cpu:sfincs-v2.1.1-Dollerup-Release

Changes:

The code consists of all functionality of the v2.0.3 release, with the following major changes/additions:

Added functionality:

• New advection scheme 'advection_scheme = upw1' > new default! Old implementation still available as 'advection_scheme = original'.
• Option to include 2D component of friction term 'friction2d = true' > new default! Old implementation still available as 'friction2d = false'.
• New Python setup tools HydroMT-SFINCS release v1.1.0 > highly recommended to use this new version!
• New subgrid methodology including wet fraction as in Van Ormondt et al. (2024, in review), only available through net netcdf input file through new HydroMT-SFINCS version, recommended! Old implementation still available when providing the original binary file, then all wet fractions are assumed to be 1.
• Upgraded coupled and integrated stationary wave solver 'SnapWave' including Infragravity wave energy balance following Leijnse et al. (2024).
• New recommended default combination that with new advection scheme: alpha=0.50, theta=1.0, advection=1 (is now always 2D), viscosity=1.

Other changes:

• Improved stability for cell that from being dry becomes wet.
• Extra output variable to netcdf output files 'status', for easy checking whether a batch of simulations have all run succesfully: a value of 0 means no error
• Added option to specify in case of a 1 layer model (either quadtree input, or original input), whether you want the output as mesh quadtree netcdf (1), or regular gridded netcdf (0, default). Keyword: regular_output_on_mesh (0, default, =logical)
• netspwfile input for precipitation should be absolute atmospheric pressure, not the pressure drop.
• Upgrade Windows compiler to IFX 2024.
• Upgraded Netcdf version to newer native versions of Unidata: netCDF 4.9.2 & netcdf-fortran-4.6.1
• Updated documentation.
• Added tests in skillbed report.

Climate Change - Natural Hazard and Storm - Fortran
Published by Leynse 8 months ago

SFINCS - SFINCS v2.0.3 Cauberg Release Q2 2023

2.0.3 Cauberg release

The last official 2023 release of SFINCS for Q4, the v2.0.3 Cauberg release, 'Climbing hills of challenges in compound flood modelling', is now available!

This contains open access to the source code from Github:
https://github.com/Deltares/SFINCS/releases/tag/v2.0.3_Cauberg_release.

As pre-compiled Windows executable:

https://download.deltares.nl/en/sfincs/

As Docker container:

docker pull deltares/sfincs-cpu:sfincs-v2.0.3-Cauberg

Changes:

The code consists of all functionality of the v2.0.2 release, with the following changes/additions:

Added functionality:

• Netcdf4 compliant output, for reduced file sizes
• Green & Ampt infiltration method
• Horton infiltration method
• Restartfiles including infiltration state, for the case of Curve Number with Recovery, Green&Ampt and Horton
• Netcdf Spiderweb input option
• Netcdf src+dis input option

Other changes:

• Improved culvert and drainage pipe formulations
• Updated documentation
• Added tests in skillbed report
• Compliance with new Python setup tools HydroMT-SFINCS release v1.0.2

Known issues:

• BMI implementation is up to date with openearth/bmi-python, which is however not up to date with the latests CSDMS standard BMI implementation
• The combination of netspwfile with large difference in reference time between the spiderweb and the SFINCS simulation itself, might not run correctly in the Docker version. Use the ascii spwfile input or the Windows build executable which work correctly.

Climate Change - Natural Hazard and Storm - Fortran
Published by Leynse over 1 year ago

SFINCS - SFINCS v2.0.2 Blockhaus Release Q2 2023

2.0.2 Blockhaus release

The first official 2023 release of SFINCS for Q2, the v2.0.2 Blockhaus release, 'Smoothly cycling over challenges in compound flood modelling', is now available!

This contains open access to the source code from Github: https://github.com/Deltares/SFINCS/releases/tag/v2.0.2_Blockhaus_release.

As Windows executable:

https://download.deltares.nl/en/download/sfincs/

As Docker container:

docker pull deltares/sfincs-cpu:sfincs-v2.0.2-Blockhaus-Release-Q2-2023

Changes:

The code consists of all functionality of the v2.0.0 release, with the following changes/additions:

Major changes:

• Potentially breaking change: flipped x&y coordinates in Netcdf map output to be Sgrid compliant. Note; might impact Matlab/Python post-processing scripts (fixed in new HydroMT-SFINCS release v1.1.0)
• Improved 2D component of advection scheme
• Option to include viscosity term in the momentum equation

Added functionality:

• Option to not use rainfall in spiderweb, keyword: usespwprecip = 0
• The x&y-coordinates of input weirfiles as snapped on grid internally in SFINCS are now written to the sfincs_his.nc file; structure_x, structure_y & structure_height
• Option to include viscosity, enabling running on theta=1.0, with viscosity = 1. The values 'nuvisc' will be automatically determined based on your grid resolution, and written to the log screen. Value can still be overruled by specifying 'nuvisc = value' directly, or increased with e.g. a factor 2 using 'nuviscdim = 2'.
• Save maximum velocity proxy (in m/s) on 'dtmaxout' interval: storevelmax = 1
• Save maximum flux (h * U in m^2/s) on 'dtmaxout' interval: storefluxmax = 1
• Save maximum discharge through drainage strucuture from 'drnfile' input on 'dthisout' interval: storeqdrain = 1

Other changes:

• Bugfix in weir formulation
• Updated documentation
• Added tests in skillbed report
• Compliance with new Python setup tools HydroMT-SFINCS release v1.1

Climate Change - Natural Hazard and Storm - Fortran
Published by Leynse almost 2 years ago

SFINCS - SFINCS v2.0.0 Alpe D'Huez Release 2022

First open source release of SFINCS: SFINCS v2.0.0 Alpe D'Huez Release 2022

Climate Change - Natural Hazard and Storm - Fortran
Published by Leynse over 2 years ago