RiverFlow2D Release Notes
RiverFlow2D Release Notes
Bug fixes
• Fix an error f reference to copy centroids file when creating a new scenario
• Fix an error of reference to select mouse pointer when changed to select method
in crossSection tool
This is a major upgrade that includes the new tools and improvements for RiverFlow2D,
OilFlow2D and HydroBID Flood models.
Bug fixes
• Removed limitation that was blocking HMIN greater and equal to 0.01 m.
• Corrected unit conversion for maxdepths when using the ST and MT models in
English Units
• Corrected calculation of MaxWSE maps.
• Corrected calculation of MaxWSE for dry cells that was not writing -9999 (-
10000)
• Fixed assignment of inflow WSE and Cv boundary condition when using the ST-
SS model. BCType was being set to 17 instead of 18.
• Fix the problem of reference to pressure drop curve during valve closure to make
the decay of the output flow more gradual in this period.
• Fix the problem of reference to negative flows and negative pressures in the
spills.
• Fix the error of reference to local mesh
• Minor fix for maxWSE with imperial units (ST models)
Version [08.13.02]
RiverFlow2D-OilFlow2D Exes Build [20/DEC/2023]
Bug fixes:
Sediment Transport ST module
• Multiple fixes for suspended+bedload transport compatibility with both fixed-
fractions and active-layer models in both CPU-GPU versions.
• Fix for bedload+suspended sediment inlet/outlet definition and integration in both
CPU-GPU versions.
Culvert Component
• Fix to ST and PL solute and suspended sediment transfer in culverts with initial
dry conditions.
OilFlow2D on Water
• If the shoreline switch was 0 shore and beach trapping were being turned off
regardless.
OilFlow2D on Land
• Fix for sources (loading and updating) in module OilFlow2D-HT without heat
transport (old setup files) in both CPU-GPU versions.
• Fix the error of reference to Output time tag in video export in the OilFlow2D on
land model.
• Fix the problems of reference to Output interval parameter considered in particle
animations was corrected, now it is read from .OILW file.
• Fix the error of reference to the method that checks the names of the new
scenarios and an error that occurred when generating the auxiliary drainage
polygons.
ALL, ALL-GPU
• Minor fix for allowing to set the user defined number of integrations points in x-
section.
Version [08.12.04]
RiverFlow2D-OilFlow2D Exes Build [18/SEP/2023]
Bug fixes:
Version [08.12.03]
RiverFlow2D-OilFlow2D Exes Build [09/AUG/2023]
Bug fixes:
Version [8.12.02]
RiverFlow2D-OilFlow2D Exes Build [09/AUG/2023]
Bug fixes:
• Fixes an error that prevented copying the .INITIALSTATE file to scenario folders
• Fixes an error that prevented copying the .initconc auxiliary files to scenario
folders
• Fixes an error that prevented copying the .initfrac files to scenario folders
• Fixes error that prevented copying to scenario folders the auxiliary files defined in
the .OILW data file
• A warning message was included when the user selects a tool prior to loading a
valid model project.
• Fixes an error that forced THE MT module was calling the hydrodynamic model
instead of the MT when selecting Bed Fraction Evolution.
• Fixes error reading the auxiliary file that defines the initial material concentrations
and supernatant water entered in the InitialConcentration QGIS layer
• Fixes error with BCType 1 being assign in MT-VD instead of BCType = 18.
• Removed error message when trying to copy non required .OILP auxiliary files
when the Heat Transfer model is selected. Files not checked are are: density,
density, viscosity, and yield stress.
Version [8.12]
RiverFlow2D-OilFlow2D Exes Build [09/AUG/2023]
New features in version 8.12:
QGIS plugins
• New hazard map Equivalent Clear Water Hazard Map (ECWHM) and new maps
for the concentrations of suspended material and fractions of material in the
bottom, the D50 for projects that contemplate transport of suspended sediments
and tailings transport
• OilPipeline Break Module Update.
• Generate spill maps from multiple scenarios in a single layer.
• New Integrated Sources/Spills layers for Maximum Result and Time to Depth
maps in OF2D plugin
• Enabled the option to use multiple DEMs in the OilPipeline break model, and a
new message warning the user to manually delete the folder containing the files
of a deleted scenario.
• New option for animation of vector fields that allows you to choose between
using the value of all times or the current time for rendering for RF2D, OF2D and
HBF plugins
• New option for animation of vector fields that allows choosing between using the
value of all times or the current time for rendering in RF2D plugin
• The velocity vector layer now saves the "Natural Breaks (Jenks)" classification
mode in RF2D plugin.
• New .OBC and .OBCP file formats in RF2D, OF2D and HBF plugins and 3th
version of Oil pipeline break model tool in OF2D.
OilFlow2D
-On Land
• New “oil rainfall” blowout component
• New infiltration (Green-Ampt) and evaporation components.
• Adaptation to run old file version cases with evaporation.
• New wind shear stress oil flow component.
-On Water
• The model now will generate a CreateMP4ParticleAnimation.bat file. Double-
clicking on that file after the model finalizes running will create a
ParticleAnimation.mp4 file that animates the oil particle trajectories
• Improved emulsification calculations
• Improved dissolution method.
Simplified 1D/2D
• New simplified1D (rills) hydrodynamic component (BETA)
* ALL
• New Open boundary condition ID labels reported in .ROUT
• New format for boundary conditions OBCP file. File version 202307 and later
includes boundary condition ID tag.
Bug fixes
• Corrections for English Units System in extremes files and cell_time files.
• Corrected minimum depth reported in extremes files.
Version [8.11]
RiverFlow2D-OilFlow2D Exes Build [09/JUN/2023]
New features in version 8.11:
QGIS plugins
• New support for QGIS v3.28.5
• This is a major upgrade that includes the new Multiple Scenario Management
Tool for RiverFlow2D, OilFlow2D and HydroBID Flood Plugins
• New progress bar displayed while migrating from a single-scenario project to a
• multi-scenario
• Oil Pipeline Model plugin update
• New option that allows defining the initial concentration values of sediments and
contaminants
• Several general improvements
• New RiverFlow2D MT Tutorial
• New RiverFlow2D PL Tutorial
• New OilFlow2D overland flow Tutorial
* ST
• New active bed layer model for suspended sediment transport
• Wind shear stress component added to ST module in both CPU and GPU
versions.
* ALL
• New weir-type outlet BC (Beta)
• New BCs: (Beta) upstream modelled reservoir (inlet BC) and downstream
modelled reservoir (outlet BC).
Bug fixes
• Fix in the extremes.out writing function when using imperial units
• Fix of Max WSE computation in extremes.
• Fix in the declaration of number of columns in cell_mt files.
• Fix of working CPU threads in GPU simulations.
• Fix in dt estimation for initial dry domains
• Fix for allowing an user defined depth variation in the computation of the arrival
time computation in CPU versions.
Version [8.10]
RiverFlow2D-OilFlow2D Exes Build [09/MAR/2023]
All Modules
• New culverts model added considering several inlet and outlet cells. This helps to
reduce oscillations that were encountered when the culvert diameter was much
larger than the cell size.
• New and more efficient extreme variables memory management.
• New extremes.out file version 202302, with unified columns order for all the
modules.
• New experimental internal boundary condition to update the 1D network of rills.
• New experimental bridge type added and .BRIDGES file format is also updated.
MT Module
• New active layer model for the non-uniform bed exchange. The module now
considers the evolution of grain size distribution (fractions) based on the material
exchange between terrain and flowing material.
• New supernatant pond initial condition for tailings dam simulation. When
using this option defined in the initial concentration file (InitialConcentration QGIS
layer), the model will mix the water on the pond with the tailings under it and
consider the new concentrations for each material class as the new initial
conditions.
• Max/min flow density output added to extremes file.
ST Module
• Piping/erosive DAMBREACHH component implemented for ST and ST-GPU
modules.
UD Module
• Manholes with several cells implemented in the GPU version.
• User-given exchange discharge rating table for manholes acting as sinks.
• Hydraulic formula chosen by the user for manholes acting as sinks.
OilFlow2D
• WEIRE and WEIRI files are now written.
• New and more efficient extreme memory management.
• New culverts model added considering several inlet and outlet cells.
• Compatibility with OF (old libraries) added for OFHT module (only CPU).
Bug fixes
• Fix to initialize breach enlargement with overestimated erosion contributions.
• Fin for writing correctly the new DAMBREACHH file.
• Fix for writing the velocity magnitude at probes in .OBS file.
• Fix for data range estimation at bitmap view WIN-GUI.
• Fix regarding gates component.
• Fix in first dt computation for dry initial condition in CPU OilFlow2D HT which
gave different simulation evolutions depending on dtVolc.
• Fix of some bugs that provoked high temperatures in extremes file.
• Fix of some bugs in the interface that still provoked high temperatures in
extremes file.
• Several fixes made to prevent evaporation in dry cells.
• Minor fixes in extreme file (changes in the extreme column order to improve
uniformity between modules).
Version [8.04]
RiverFlow2D-OilFlow2D Exes Build [19/SEP/2022]
QGIS GUI
• New support for QGIS v3.22.10
• New Hydro Economic Flood Damage Assessment Tool (HEEF). Allows creating
damage cost maps based on polygon vulnerability functions and RiverFlow2D
model results.
• New HEEF Vulnerability Database
MT Module
• Piping/overtopping erosive dam breach component implemented for Plus-GPU
and MT-GPU modules
• New table-specified mode for concentration-depending viscosity and yield stress
in MT and MT-GPU modules.
OilFlow2D
• Weirs implemented in OilFlow2D with heat transfer for CPU and GPU
• Optimized particle-tracking searching algorithm allows 100x improvement in
model performance.
• Output .png graphic files with particle trajectory during simulations.
• New oil volume per unit area maps and animation.
• New maximum oil volume per unit area map.
Bug fixes
• Extreme values calculation updated in order to take into account hotstart
simulations.
• Fixes to enable double visualization of variables in model run graphic window.
• Minor fixes in piping/erosive dam breach component.
• QGIS fixes for maximum value maps.
*UD, UD-GPU
• Maximum number of SWMM manholes extended to 4096.
Bug fixes
• Incompatibility of source and sinks file reading with 202103 release fixed.
• PL, PL-GPU, ST, ST-GPU, MT, MT-GPU Compatibility fix for release 202103.
• Fix for dambreach file reading with release 202103.
Bug fixes
ST, ST-GPU
• Fix for the sediment flux computation at internal-boundary cells.
• Full deposition for flow depth lower than minDepth is avoided.
MT, MT-GPU
• Fix for mass/volume conservation problems at internal-boundary cells when
sedimentation exists.
• Fix for mass/volume conservation problems at inlet cells when sedimentation
exists.
• Full deposition for flow depth lower than minDepth is avoided.
ALL, ALL-GPU
• - Minor fix for inlet reading without sediment/solute concentration.\
• Correction of the solute, sediment and mud mass balance at the open
boundaries.
OL
• Minor fix regarding source component
ALL
• Output file headers updated
Hydrodynamic
• Minor fix in dam breach component for the sake of compatibility with the former
input file format
QGIS Plugins
• Change the layer rendering classify mode, from Natural Breaks to Equal Interval
for all plugin
• Change the layer rendering classify mode, from Natural Breaks to Equal Interval
for RF2D plugin
• Update .DAT file when OILW file is exported
• Setting the variables QSED, Conc_X and CvTotal of cross sections results in
scientific notation
• The value of the MINERELE variable in the FED0 file was increased to 5 digits
• Correction of the flow direction in the cross sections (the OF2D and HBF had to
be updated),
• Message to catch the error when generating the .qgisunits file if the project does
not have a projected CRS and
• Error with the message in the check of mesh cells with internal angles less than 5
degrees (in the case of the HBF).
• Change in the direction of the calculation of the sine and cosine of the director
angle of the velocity to correct the error when the direction of the flow is reversed
in the transverse sections.
•
Pre-Post Version [7.51]
RiverFlow2D Exes Build [11/OCT/2021]
-Bug fixes
• Corrected output of extremes.out when using the ST module.
-QGIS plugin Bug fixes
• Updates The MIN EROSION ELEV variable in the .FED file was increased to 5
digits.
• Correction of the flow direction in the cross sections.
• Message added to catch the error when generating the .qgisunits file if the
project does not have a projected CRS and
• Updated the error capture with message in the check of mesh cells with internal
angles less than 5 degrees.
• Changed the direction of the calculation of the sine and cosine of the director
angle of the velocity to correct the error when the direction of the flow is reversed
in the transverse sections.
• Bug fixed related to export shape map from animation, and compare raster tool.
-Fixed Bugs
• Minor fix regarding .inp amd .lswmm file reading.
• Bug fix related to load CrossSection data
• Fixed encoding used for opening swmm file
• Bug fixed: related to boundary conditions label translation in the HydroBID Flood
plugin
-Fixed Bugs
• Minor fix regarding .inp amd .lswmm file reading.
• Bug fix related to load CrossSection data
• Fixed encoding used for opening swmm file
• Bug fixed: related to boundary conditions label translation in the HydroBID Flood
plugin
Fixed bugs:
• Solved incompatibility of .inp SWWM file due to characters in some language that
required different encoding.
• Corrected label translation the Boundary Condition dialog of the the HydroBID
Flood plugin.
-DIP
• Corrected version number.
-MT
• Some updates and optimizations to the MT-GPU solver.
-UD-SWMM
• Several updates in UD-CPU module: distributed exchange with the surface and
boundary cells avoiding (for single cell exchange)
OilFlow2D QGIS
• New option to create Oil spill XSection.
• New option to select animation output time range.
• Bugs fix to multiple sources batch run for OilFlow2D on land model.
•
-ALL
• Maximum values component and extremes.out file writing implemented.
-RiverFlow2D QGIS
• Migration to QGIS 3.14.0
• New InitialBedFractions layer allows entering polygons with different bed material
fractions in the MT variable property module.
• Bugs fixed: related to generating TriMesh Layer with elevation,
• Bug fixes when creating animations.
• Now the bridge component take elevation from TriMesh layer if is available
• New tools to create singles hydrograph files from a Multiple hydrograph file
• Now the export project plugin creates a default .OBCP File.
-RiverFlow2D QGIS
• Updated to QGIS 3.12.3
• New maps and animations for the Mud and Tailings Flow MT module:
o Volumetric concentration of each size fraction
o Volumetric concentration of the fluid sediment mixture
o Viscosity
o Density
o Yield stress
-RiverFlow2D QGIS
• Migration to QGIS 3.12.2
• New Export dialog
-UD SWMM
• Several features of UD module were updated. New function to write a .ini file for
graphic representation of the numerical results. File extension in binary files
changed from BIN to OUT to ensure compatibility with EPA-SWMM. File INP
reading updated in order to skip some comment lines. Filter of RULE_STEP not
supported in SWMM 5.1.12
-STGPU,ST,VDMUD
• - New formulation for the bed exchange flux with multiple sediment fractions.
-RiverFlow2D QGIS
• Bug fixed related to the generation of the .MannN2 file with complex polygons.
• Bug fixed related to export of Manning n values.
-RiverFlow2D QGIS
• New MaximumFloodArea graphic layer. The model determines the polygon that
represent the maximum area affected by the flooding or overland spill.
• To improve post processing times, now *.*AllTimes are no longer generated. The
cross sections and animations that required these files in previous versions will
be generated from the cell_time*.textout files
• bugs fixed: related to sample element elevation
-MD Module
• New module for variable properties mud flow (BETA)
• Bed fractions for erosion-deposition term in VDMUD-CPU module.
• New .ROUT file in VDMUD-CPU module.
• New .MUD input file in VDMUD-CPU module.
• Corrections for boundary condition in VDMUD-CPU.
- ST Module
• Zhang's formula for the suspended capacity concentration in STCPU and MD
modules.
-DIP
• New output interval for components that allow specifying the output interval for
culverts, bridges, weirs, gates, dam breaches, cross sections, profiles, and
observation points.
• Various fixes to the Oil spill on water panel
-ALL
• Output file header date updated according to the present year
• Output .XSECH file written in scientific notation in all modules.
• "extremes.out" file writing for all modules (CPU versions).
-ST, STGPU
• New numerical solver for bedload transport which improves the efficiency.
• New mathematical formulation for suspended load transport, generating a new
coupled model between the sediment+water flow and the bed layer. This
formulation fixed an inconsistency that caused an incorrect increase of WSE in
stagnant conditions.
• Improved and consistent reporting of inlets, outlets in report files
massBalance.out, *.ROUT, t_qin_out.out. Now all the solid volumes are reported
without porosity. Due to the new mathematical formulation, an additional term
accounting for the net exchange flux between the bed and the flow is reported in
"massBalance.out".
• The decimal precision has been augmented in .ROUT file.
• .ROUT file is now written in GPU version.
* ALL
- New local time step cell marker has been included in order to provide the
possibility of analyzing the quality of the mesh (both CPU and GPU versions).
This has been included in the VTK graphical output files.
- RiverFlow2D SMS
- Fix a bug writing HDF5 maximum result files where some variables were not being
displayed.
* ALL
- New DIP panel for scour calculations for piers, abutments and pressure flow.
- New Water Quality Module based on the EPA-WASP formulation
- Fix to the Australia hazard method that was assigning H1 levels to dry cells.
Build [23/04/2018 - ]
- New release 201804 launched 6.10.01
* DATA INPUT PROGRAM
- Is no available in English and Spanish
- Mud and Debris Flow panel has been redesigned and enhanced with formula
database for Yield, viscosity and density computation.
- Model selection (CPU, GPU) is now possible in the front panel.
-ST panel now allows entering dispersion coefficients for SS.
-ST for bed load transport allows setting coupled or uncoupled options.
* ALL MODULES
- Suspended sediment longitudinal and transversal coefficient corrected for reading just
one instead of the number of suspended sediments
- New functionality called QSUS (Quasi Steady Uncoupled Sediment) implemented. It is
enabled with a 1 at the end of the *.SEDB file from this release
- New interpolation procedure cells to nodes for *.exp files for sediments. deltaz is
computed as the difference between interpolated z and the original elevation.
- New diffusion-dispersion terms for ST-SS
- Mudflow and OilFlow modules have been revised, corrected and accelerated.
- Oilflow2D and OilflowGPU are able to run with Full Bingham, Simplified Bingham and
Quadratic formulas.
Build [22/02/2018 - ]
* ALL
- New interpolation procedure of cells to nodes for *.exp files
- The interpolation of nodal elevations from cells is now changed to the original
algorithm. The cell elevations remain interpolated but the nodal elevations are left the
same as in the .2dm file.
- Changed Copyright 2009-2017 by Copyright 2009-2018.
- Release (4.2.1 and 4.3) has been corrected in output files as well as 1D2D message
* OilFlow2D
- Release of OilFlow2D GPU (libraries of2gpu.dll, of2gpu.lib and pk2_manizales.dll)
Build [24/01/2018 - ]
* ALL
- New release 201801
- Source type format only considered for release 201801
Build [12/01/2018 - ]
* ALL
- h+z(t) BC has been restored as before (BCTYPE 1)
- New BCTYPE 17 implemented consisting in imposing h+z(t) as well as orienting the
flow according to the outflow normal direction
Build [19/12/2017 - ]
* ST
- exp files are now written in concordance with the Plus module
- Note that for the MDGPU module, the file "zscalebw.png" is required inside the img
folder
Build [27/11/2017 - ]
* ALL
- massBalance.out file includes the header modification
- sources/sinks rating table feature added
Build [13/11/2017 - ]
* ALL
- massBalance.out file includes the header
- Change for the water depth BC according to the mesh orientation
- Compiled for CUDA 9.0
Build [03/10/2017 - ]
* PLUS,GPU
- Local Inf and local rain log messages has been corrected (minor mistakes)
*ST
- ROUT file now writes the solid discharge without multiplying by the porosity of each
material. However, the massBalance.out file still computes the total volume of sediment
(already multiplied by the porosity of each material)
Build [25/09/2017 - ]
* PLUS,GPU
- Local Inf and local rain log messages has been reduced
*ALL
- Mass balance implemented with hotstart
Build [22/09/2017 - ]
* PLUS,GPU
- Search algorithm for local rain and local inf improved and optimized
- Rain volume and infiltration volume corrected for hotstart
*ALL
- Mass balance implemented with its corresponding flag
*ST
Solid discharges written correctly in ROUT files
New stateqs.out created for QGIS interface
Build [29/08/2017 - ]
* ST
- Erosion-deposition terms have been corrected for the SS module.
- The minus sign for the input solid discharges in the ROUT file has been removed.
- Integration in the boundaries is done according to the porosity for each suspended
sediment.
* ALL
- New file massBalance.out has been implemented to check the total integrated mass.
- The minus sign for the output discharges (liquid and solid) in the ROUT file has been
removed.
Build [25/08/2017 - ]
* ALL
- LocalRain implemented to be read from LRAIN file instead of providing one file per
storm or zone. A negative number in the number of zones (or points) is necessary to
enable this component.
Build [26/07/2017 - ]
* ALL
- Corrected log file. Now PL module is working
* PLUSGPU, STGPU, MDGPU
-Compilation flags for all GPU cards downgrade to the original version.
Build [20/07/2017 - ]
* ALL
- Log file implemented
- Interpolate z on cells to nodes to be consistent with cell elevations. In the .FED file the
nodal elevations were directly obtained from the .2dm file elevations. Since the model
uses the cell elevations these nodal elevations are interpolated to the cell centroids. In
this version the interpolated cell elevations are used to determine adjusted nodal
elevations.
* PLUS, PLUSGPU
- Dambreach restrictions when 'touching' either width or bottom limits implemented. An
additional file called $NAME_MOD.dat is written where $NAME is the name of the
breach.
* PLUSGPU, STGPU, MDGPU
-Compilation flags for all GPU cards implemented. It has to be tested.
Build [17/04/2017 - ]
* ALL
- Changed maxero for ST-SS modules. Problems with machine accuracy have been
solved
Build [30/03/2017 - ]
* ALL
- Changed interpolation from cells to nodes in exp files. It has to be tested
Build [15/03/2017 - ]
* ALL
- ERRORS have been replaced by WARNS for local rain, evap, infiltration, wind... when
a polygon does not contain any cell
* ST
- Tolerance for maximum erodible layer in ST CPU corrected and is the same as in
GPU
Build [14/03/2017 - ]
* GPU ST
- Minor fix related to the solid discharge output generation at ROUT file
Build [06/03/2017 - ]
* ST,GPU ST
- Finite depth sediment layer has been corrected. Also some mistakes related to
suspended sediments formulas.
- Gates and weirs now consider sediments
- Rain implemented for this module
* PL
- Rain implemented for this module
* PLUS, PLUSGPU
- Culverts now include the possibility of dealing with solutes
Build [06/03/2017 - ]
* GPU ST
- First commit of the Riverflow2D ST GPU module
Build [01/03/2017 - ]
* GPU MD
- First commit of the Riverflow2D MD GPU module
- A new scale (zscalebw.png) is now included at img/ folder