hydromt_sfincs.SfincsModel.setup_structures#
- SfincsModel.setup_structures(structures: str | Path | GeoDataFrame, stype: str, dep: str | Path | DataArray = None, buffer: float = None, dz: float = None, merge: bool = True, **kwargs)[source]#
Setup thin dam or weir structures.
Adds model layer (depending on stype):
thd geom: thin dam
weir geom: weir / levee
- Parameters:
structures (str, Path) – Path, data source name, or geopandas object to structure line geometry file. The “name” (for thd and weir), “z” and “par1” (for weir only) variables are optional. For weirs: dz must be provided if gdf has no “z” column or ZLineString; “par1” defaults to 0.6 if gdf has no “par1” column.
stype ({'thd', 'weir'}) – Structure type.
dep (str, Path, xr.DataArray, optional) – Path, data source name, or xarray raster object (‘elevtn’) describing the depth in an alternative resolution which is used for sampling the weir.
buffer (float, optional) – If provided, describes the distance from the centerline to the foot of the structure. This distance is supplied to the raster.sample as the window (wdw).
merge (bool, optional) – If True, merge with existing’stype’ structures, by default True.
dz (float, optional) – If provided, for weir structures the z value is calculated from the model elevation (dep) plus dz.