hydromt_sfincs.components.forcing.SfincsRivers#

class hydromt_sfincs.components.forcing.SfincsRivers(model: SfincsModel)[source]#

This class contains functions to create and manage river inflow/outflow points in the SFINCS model. The methods in this class change the model mask and add discharge points where rivers enter the model domain. The rivers themselves are not used by the SFINCS model, but useful for visualization.

__init__(model: SfincsModel)[source]#

Methods

__init__(model)

close()

Clean up all open datasets.

create_river_inflow([rivers, hydrography, ...])

Setup discharge (src) points where a river enters the model domain.

finish_write()

Finish the write functionality after cleanup was called for all components in the model.

read()

Read the file(s) into the component.

test_equal(other)

Test if two components are equal.

write()

Write the river inflow data to a gis-file.

Attributes

data

River geometry data.

data_catalog

Return the data catalog of the model this component is associated with.

model

Return the model object this component is associated with.

name_in_model

Find the name of the component in the parent model components.

root

Return the root of the model this component is associated with.