hydromt_delft3dfm.DFlowFMModel.setup_1dlateral_from_points#
- DFlowFMModel.setup_1dlateral_from_points(laterals_geodataset_fn: str = None, lateral_value: float = 0.0, snap_offset: float = 1.0, branch_type: str = 'river')[source]#
Prepare the 1D lateral discharge from geodataset of point geometries.
E.g. ‘1’ m3/s for all lateral locations.
Use
laterals_geodataset_fn
to set the lateral values from a geodataset of point locations. Support also geodataframe of point locations in combination of lateral_value.Only locations that are snapped to the network of branch_type within a max distance defined in
snap_offset
are used.The discharge can either be a constant using
lateral_value
(default) or a timeseries read fromlaterals_geodataset_fn
. If the timeseries has missing values, constantlateral_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_points** forcing: DataArray with points 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].snap_offset (float, optional) – Snapping tolerance to snap boundaries to the correct network nodes. By default 0.1, a small snapping is applied to avoid precision errors.
branch_type (str, optional) – Type of branch to apply laterals on. One of [“river”, “pipe”]. If None, all branches are used. By defalt None.