hydromt_delft3dfm.workflows.links1d2d_add_links_1d_to_2d#

hydromt_delft3dfm.workflows.links1d2d_add_links_1d_to_2d(mesh: UgridDataset, branchids: List[str] = None, within: Polygon | MultiPolygon = None, max_length: float = inf) → Dataset[source]#

Generate 1d2d links to network from 1d to 2d.

Branchids can be specified for 1d branches that need to be linked. A (Multi)Polygon can be provided were links should be made.

Note: The boundary nodes of Mesh1d (those sharing only one Mesh1d edge) are not connected to any Mesh2d face.

Parameters:

• mesh (xu.UgridDataset) – Network in which the connections are made

• branchids (List[str], optional) – List of branchid’s to connect. If None, all branches are connected. Defaults to None.

• within (Union[Polygon, MultiPolygon], optional) – Area within which connections are made. Defaults to None.

• max_length (float, optional) – Max edge length. Defaults to None.

Returns:

link1d2d – Link1d2d Dataset.

Return type:

xr.Dataset