Model methods and components#

The HydroMT-Delft3D FM plugin helps you preparing or updating several methods of a Delft3D FM model such as model topology, map data and forcing. The main interactions are available from the HydroMT Command Line Interface and allow you to configure HydroMT in order to build or update Delft3D FM models.

When building or updating a model from command line a model setup configuration (.yml file) with model methods and options and, optionally, a data sources (.yml) file should be prepared.

Model setup methods#

An overview of the available Delft3D FM model setup methods is provided in the table below. When using HydroMT from the command line only the setup methods are exposed. Click on a specific method see its documentation.

Method

Explanation

setup_config()

Update config with a dictionary

setup_rivers()

This component sets the 1D river branches with parameters.

setup_channels()

This component sets the 1D channel branches with parameters.

setup_rivers_from_dem()

This component sets the 1D river branches with parameters derived from hydrography.

setup_pipes()

This component sets the 1D pipe branches with parameters.

setup_manholes()

This component adds manholes with parameters to 1D pipes.

setup_bridges()

This component adds bridges with parameters to 1D branches.

setup_culverts()

This component adds culverts with parameters to 1D branches.

setup_mesh2d()

This component sets a 2D mesh.

setup_mesh2d_refine()

This component refines the 2D mesh.

setup_link1d2d()

This component sets 1d2d links that link the 1D branchs to the 2D mesh.

setup_maps_from_rasterdataset()

This component adds parameter maps to the 2D mesh.

setup_maps_from_raster_reclass()

This component adds parameter maps that are derived by reclass existing maps to the 2D mesh.

setup_1dboundary()

Setup a 1D boundary forcing to the 1D branches.

setup_2dboundary()

Setup a 2D boundary forcing to the 2D mesh.

setup_rainfall_from_constant()

Setup a constant precipitation forcing to the 2D mesh.

setup_rainfall_from_uniform_timeseries()

Setup a spatial uniform precipitation forcing to the 2D mesh.

Model components#

The following table provides an overview of which DFlowFMModel component contains which Delft3DFM in- and output files. The files are read and written with the associated read- and write- methods, i.e. read_config() and write_config() for the config component.

DFlowFMModel component

Delft3DFM files, saved in dflowfm folder.

config

DFlowFM.mdu, saved in dflowfm folder.

geoms

1D model geometries, saved in the geoms folder.

maps

2D model data on regular grid, saved in the maps folder

mesh

unstructured mesh schematisation and data, saved in the dflowfm folder

forcing

1D and 2D forcing, saved in dflowfm folder.