hydromt_sfincs.components.geometries.SfincsDrainageStructures.create#

SfincsDrainageStructures.create(locations: str | Path | GeoDataFrame, stype: str = 'pump', discharge: float = 0.0, merge: bool = True, **kwargs)[source]#

Create drainage structures such as pumps, culverts, or valves (old name: setup_drainage_structures).

Adds model layer: * drn geom: drainage pump or culvert

Parameters:

  • locations (str, Path) – Path, data source name, or geopandas object to structure line geometry file. The line should consist of only 2 points (else first and last points are used), ordered from up to downstream. The “type” (1 for pump, 2 for culvert and 3 for valve), “par1” (“discharge” also accepted) variables are optional. If “type” or “par1” are not provided, they are based on stype or discharge Parameters.

  • stype ({'pump', 'culvert', 'valve'}, optional) – Structure type, by default “pump”. stype is converted to integer “type” to match with SFINCS expectations.

  • discharge (float, optional) – Discharge of the structure, by default 0.0. For culverts and one-way-valves, this is the maximum discharge, since actual discharge depends on waterlevel gradient

  • merge (bool, optional) – If True, merge with existing drainage locations, by default True.

On this page