hydromt_delft3dfm.workflows.prepare_default_friction_and_crosssection#

hydromt_delft3dfm.workflows.prepare_default_friction_and_crosssection(branches: ~geopandas.geodataframe.GeoDataFrame, br_type: ~typing.Literal['river', 'channel', 'pipe'], friction_type: str = 'Manning', friction_value: float = 0.023, crosssections_shape: ~typing.Literal['rectangle', 'circle'] = None, crosssections_value: ~typing.List[float] | float = None, logger: ~logging.Logger = <Logger hydromt_delft3dfm.workflows.crosssections (WARNING)>)[source]#

Prepare the default uniform friction and crosssection for branches.

Parameters:

  • branches (gpd.GeoDataFrame) – Branches to add frictions and crosssections.

  • br_type (str) – branches type. Either “river”, “channel”, “pipe”.

  • friction_type (str) – Type of friction to use. One of [“Manning”, “Chezy”, “wallLawNikuradse”, “WhiteColebrook”, “StricklerNikuradse”, “Strickler”, “deBosBijkerk”].

  • friction_value (float) – Value corresponding to ‘’friction_type’’. Units are [“Chézy C [m 1/2 /s]”, “Manning n [s/m 1/3 ]”, “Nikuradse k_n [m]”, “Nikuradse k_n [m]”, “Nikuradse k_n [m]”, “Strickler k_s [m 1/3 /s]”, “De Bos-Bijkerk γ [1/s]”]

  • crosssections_shape (str, optional) – Shape of branch crosssections to overwrite defaults. Either “circle” or “rectangle”.

  • crosssections_value (float or list of float, optional) – Crosssections parameter value to overwrite defaults. If crosssections_shape = “circle”, expects a diameter [m], used for br_type == “pipe”. If crosssections_shape = “rectangle”, expects a list with [width, height] (e.g. [1.0, 1.0]) [m]. used for br_type == “river” or “channel”.

  • logger (Logger, optional) – Logger.

Returns:

branches – Branches with frictions and crosssections added.

Return type:

gpd.GeoDataFrame