hydromt_delft3dfm.workflows.compute_forcing_values_polygon#

hydromt_delft3dfm.workflows.compute_forcing_values_polygon(gdf: ~geopandas.geodataframe.GeoDataFrame, da: ~xarray.core.dataarray.DataArray = None, forcing_value: float = 0.0, forcing_type: str = 'waterlevelbnd', forcing_unit: str = 'm', logger=<Logger hydromt_delft3dfm.workflows.boundaries (WARNING)>)[source]#

Compute 1d forcing values.

Used for 1D lateral polygon locations.

Parameters:

  • gdf (gpd.GeoDataFrame) –

    GeoDataFrame of polygons to add 1D forcing data.

    • Required variables: [‘geometry’]

  • da (xr.DataArray, optional) –

    xr.DataArray containing the forcing timeseries values. If None, uses a constant forcing_value for all forcings.

    • Required variables: [‘forcing_type’]

  • forcing_value (float, optional) – Constant value to use for all forcings if da is None and to fill in missing data. By default 0.0 forcing_unit

  • forcing_type ({'lateral_discharge'}) – Type of forcing to use. For now only support ‘lateral_discharge’. By default ‘lateral_discharge’

  • forcing_unit ({'m3/s'}) – Unit corresponding to forcing_type. By default ‘m3/s’

  • logger – Logger to log messages.