hydromt_wflow.WflowSedimentModel.setup_riverbedsed#

WflowSedimentModel.setup_riverbedsed(bedsed_mapping_fn: str | Path | DataFrame | None = None, strord_name: str = 'meta_streamorder', output_names: Dict = {'river_bottom-and-bank_clay__mass_fraction': 'river_bed_clay_fraction', 'river_bottom-and-bank_gravel__mass_fraction': 'river_bed_gravel_fraction', 'river_bottom-and-bank_sand__mass_fraction': 'river_bed_sand_fraction', 'river_bottom-and-bank_sediment__median_diameter': 'river_bed_sediment_d50', 'river_bottom-and-bank_silt__mass_fraction': 'river_bed_silt_fraction', 'river_water_sediment__kodatie_transport_capacity_a-coefficient': 'river_kodatie_a', 'river_water_sediment__kodatie_transport_capacity_b-coefficient': 'river_kodatie_b', 'river_water_sediment__kodatie_transport_capacity_c-coefficient': 'river_kodatie_c', 'river_water_sediment__kodatie_transport_capacity_d-coefficient': 'river_kodatie_d'})[source]#

Generate sediments based river bed characteristics maps.

Kodatie transport capacity coefficients can also be derived from such mapping table based on the mean sediment diameter of the river bed.

Adds model layers:

  • river_bed_sediment_d50 map: median sediment diameter of the river bed [mm]

  • river_bed_clay_fraction map: fraction of clay material in the river bed [-]

  • river_bed_silt_fraction map: fraction of silt material in the river bed [-]

  • river_bed_sand_fraction map: fraction of sand material in the river bed [-]

  • river_bed_gravel_fraction map: fraction of gravel material in the river bed [-]

  • river_kodatie_a map: Kodatie transport capacity coefficient a [-]

  • river_kodatie_b map: Kodatie transport capacity coefficient b [-]

  • river_kodatie_c map: Kodatie transport capacity coefficient c [-]

  • river_kodatie_d map: Kodatie transport capacity coefficient d [-]

Parameters:
  • bedsed_mapping_fn (str) –

    Path to a mapping csv file from streamorder to river bed particles characteristics. If None reverts to default values.

    • Required variable: [‘strord’,’river_bed_sediment_d50’, ‘river_bed_clay_fraction’, ‘river_bed_silt_fraction’, ‘river_bed_sand_fraction’, ‘river_bed_gravel_fraction’]

    • Optional variable: [‘river_kodatie_a’, ‘river_kodatie_b’, ‘river_kodatie_c’, ‘river_kodatie_d’]

  • strord_name (str, optional) – Name of the stream order map in the grid, by default ‘meta_streamorder’.

  • output_names (dict, optional) – Dictionary with output names that will be used in the model netcdf input files. Users should provide the Wflow.jl variable name followed by the name in the netcdf file.