hydromt_delft3dfm.DFlowFMModel.setup_1dlateral_from_polygons#

DFlowFMModel.setup_1dlateral_from_polygons(laterals_geodataset_fn: str = None, lateral_value: float = -2.5)[source]#

Prepare the 1D lateral discharge from geodataset of polygons.

E.g. ‘1’ m3/s for all lateral locations.

Use laterals_geodataset_fn to set the lateral values from a geodatasets of polygons. Support also geodataframe of polygons in combination of lateral_value.

The discharge can either be a constant using lateral_value (default) or a timeseries read from laterals_geodataset_fn. If the timeseries has missing values, constant lateral_value will be used.

The timeseries are clipped to the model time based on the model config tstart and tstop entries.

Adds/Updates model layers:
  • ** lateral1d_polygons** forcing: DataArray with polygon coordinates.

Parameters:
  • laterals_geodataset_fn (str, Path) – Path or data source name for geospatial point location file. * Required variables if geodataset is provided [‘lateral_discharge’] NOTE: Require equidistant time series

  • lateral_value (float, optional) – Constant value, used if laterals_geodataset_fn is a geodataframe, or for filling in missing data. By default 0 [m3/s].