hydromt_delft3dfm.DFlowFMModel.setup_manholes#

DFlowFMModel.setup_manholes(manholes_fn: str = None, manholes_defaults_fn: str = 'manholes_defaults', bedlevel_shift: float = -0.5, dem_fn: str = None, snap_offset: float = 0.001)[source]#

Prepare the 1D manholes to pipes or tunnels.

Can only be used after all branches are setup.

The manholes are generated based on a set of standards specified in manholes_defaults_fn (default) and can be overwritten with manholes read from manholes_fn.

Use manholes_fn to set the manholes from a dataset of point locations. Only locations within the model region are selected. They are snapped to the model network nodes locations within a max distance defined in snap_offset.

Manhole attributes [“area”, “streetstoragearea”, “storagetype”, “streetlevel”] are either taken from manholes_fn or filled in using defaults in manholes_defaults_fn. Manhole attribute [“bedlevel”] is always generated from invert levels of the pipe/tunnel network plus a shift defined in bedlevel_shift. This is needed for numerical stability. Manhole attribute [“streetlevel”] can also be overwriten with values dervied from “dem_fn”.

#TODO probably needs another parameter to apply different sampling method for the manholes, e.g. min within 2 m radius.

Adds/Updates model layers:

  • manholes geom: 1D manholes vector

Parameters:

  • manholes_fn (str Path, optional) –

    Path or data source name for manholes see data/data_sources.yml. Note only the points that are within the region polygon will be used.

    • Optional variables: [“area”, “streetstoragearea”, “storagetype”,

    ”streetlevel”]

  • manholes_defaults_fn (str Path, optional) –

    Path to a csv file containing all defaults values per “branchtype”. Use multiple rows to apply defaults per [“shape”, “diameter”/”width”] pairs. By default hydrolib.hydromt_delft3dfm.data.manholes.manholes_defaults.csv is used.

    • Allowed variables: [“area”, “streetlevel”, “streeStorageArea”,

    ”storagetype”]

  • dem_fn (str, optional) –

    Name of data source for dem data. Used to derive default invert levels values (DEM - pipes_depth - pipes diameter/height).

    • Required variables: [elevtn]

  • bedlevel_shift (float, optional) – Shift applied to lowest pipe invert levels to derive manhole bedlevels [m] (default -0.5 m, meaning bedlevel = pipe invert - 0.5m).

  • snap_offset (float, optional) – Snapping tolenrance to automatically connecting manholes to network nodes. By default 0.001. Use a higher value if large number of user manholes are missing.