hydromt_sfincs.SfincsModel.setup_river_outflow

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

Setup open boundary cells (mask=3) where a river flows out of the model domain.

Outflow locations are based on a minimal upstream area threshold. Locations within half river_width of a discharge source point or waterlevel boundary cells are omitted.

NOTE: this method requires the either hydrography_fn input or setup_river_hydrography to be run first. NOTE: best to run after setup_mask, setup_bounds and setup_river_inflow

Adds / edits model layers:

  • msk map: edited by adding outflow points (msk=3)

  • river_out 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_width (int, optional) – The width [m] of the open boundary cells in the SFINCS msk file. By default 2km, i.e.: 1km to each side of the outflow location.

  • 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 1000 m.

  • append_bounds (bool, optional) – If True, write new outflow boundary cells on top of existing. If False (default), first reset existing outflow boundary cells to normal active cells.

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