Skip to content

Welcome to the BG_Flood documentation !

BG-Flood is a Shallow Water Equation (SWE) model based on the St Venant formulation of Basilisk but applied to a Block Uniform Quadtree memory structure on the GPU (based on Vacondio et al.).

The model is designed to simulate flood/inundation caused by tsunami, river, rain, tide or storm surge (from wind stress or atmospherique pressure differential) or any combination of these. The model does not (yet) include the effect of wind waves. The model is not restricted to simulating inundation hazard and can also be used for depth averaged circulation simulation.

Info

This wiki is to help users getting started on using the model. This is work in progress... If you have any issue/question post it on the issue board. While the model is fairly user friendly, it was designed for users with a basic understanding of hydrodynamics and some experience in modelling. The wiki (and the model) expect that users have some experience in basic file manipulations and are comfortable with handling NetCDF files for input and output.

This code is an open-source shallow water solver. Designed to be fast, it run on GPUs and generate its own adaptative mesh. It is mainly used in a context of flooding:

  • fresh water flooding (fluvial and pluvial)
  • tsunami propagation and run-off

Tsunami Nadi

Model development stage

BG-Flood has now reach the first release stage but some further development are already ongoing or planned.

The master branch is at stage 4 of development with 5 stage planned as below:

  • Block Uniform formulation at constant level with masked blocks (with a full swing of user friendly capabilities)
  • Static Block uniform Quad-tree formulation (i.e. adapted mesh at the first step only), grid self-generated
  • Set of core solvers:
    • Reimann
    • Kurganov
  • Multi-forcings
    • River input
    • Tidal forcing (complex polygon and forcing maps to allow nesting)
    • Rain-on-grid
    • Atmospheric pressure and wind forcing
    • Bottom friction
    • Ground infiltration (basic ILCL model)
    • Ground deformation (along the simulation but not flow induced)

Future developments:

  • Multi-layer solver (on-going)
  • Flood structures modelling (on-going)
  • Wave forcing / storm surge
  • fully adaptive Block uniform Quad-tree formulation (i.e. basilisk style wavelet refine)

License: GPL v3

Testing CI test (development branch):Test