hydromt_delft3dfm.workflows.mesh1d_add_branch#

hydromt_delft3dfm.workflows.mesh1d_add_branch(network: Network, branches: LineString | MultiLineString | List[LineString | MultiLineString], node_distance: float | int, branch_names: str | List[str] = None, branch_orders: float | int | List[float | int] = -1) → List[str][source]#

Add branch to 1d mesh, from a (list of) (Multi)LineString geometry.

The branch is discretized with the given node distance. if node distance is given as infinity, no discretization will be performed at mid point of the branch, #TODO, if minimum node distance is given, no discretization will be performed at mid point of the branch i.e. branch is treated as a pipe

Parameters:

  • network (Network) – Network to which the branch is added

  • LineString (branches (Union[)

  • MultiLineString

  • List[Union[LineString

:param : :param MultiLineString]] ]): Geometry object(s) for which the branch is created :param node_distance: Preferred node distance between branch nodes :type node_distance: Union[float, int] :param branch_names: Branch names to be used in the mesh1d :type branch_names: Union[str, list[str]] :param object branch_orders: Branch orders :type object branch_orders: Union[float, int, list[Union[float, int]]] :param to be used in the mesh1d object.:

Returns:

  • Network (Network with added branches)

  • List[str] (List of names of added branches)