hydromt_sfincs.SfincsModel.setup_river_inflow

SfincsModel.setup_river_inflow(hydrography_fn=None, river_upa=25.0, river_len=1000.0, river_width=2000.0, keep_rivers_geom=False, buffer=10, **kwargs)[source]

Setup river inflow (source) points where a river enters the model domain.

NOTE: this method requires the either hydrography_fn or setup_river_hydrography to be run first. NOTE: best to run after setup_mask

Adds model layers:

  • src geoms: discharge boundary point locations

  • dis forcing: dummy discharge timeseries

  • mask map: SFINCS mask layer (only if river_width > 0)

  • rivers_in geoms: river centerline (if keep_rivers_geom; not used by SFINCS)

Parameters
  • hydrography_fn (str, Path, optional) –

    Path or data source name for hydrography raster data, by default ‘merit_hydro’.

    • Required layers: [‘uparea’, ‘flwdir’].

  • river_upa (float, optional) – Minimum upstream area threshold for rivers [km2], by default 25.0

  • river_len (float, optional) – Mimimum river length within the model domain threshhold [m], by default 1 km.

  • river_width (float, optional) – Estimated constant width [m] of the inflowing river. Boundary cells within half the width are forced to be closed (mask = 1) to avoid instabilities with nearby open or waterlevel boundary cells, by default 1 km.

  • keep_rivers_geom (bool, optional) – If True, keep a geometry of the rivers “rivers_in” in staticgeoms. By default False.

  • buffer (int, optional) – Buffer [no. of cells] around model domain, by default 10.