hydromt_sfincs.components.geometries.SfincsThinDams

class hydromt_sfincs.components.geometries.SfincsThinDams(model: SfincsModel)

SFINCS thin dams geometry component.

This component handles reading, writing, and creating thin dam geometries for SFINCS models. Thin dams are infinitely high walls represented as LineString geometries in a GeoDataFrame.

__init__(model: SfincsModel)

Methods

__init__(model)
clear()	Clean GeoDataFrame with thin dams.
close()	Clean up all open datasets.
create(locations[, merge])	Create model thin dams (old name: setup_structures).
delete(index)	Remove one or more thin dams.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
list_names()	Give list of names of thin dams.
read([filename])	Read SFINCS thin dams (.thd) file.
set(gdf[, merge])	Set SFINCS thin dams.
snap_to_grid()	Returns GeoDataFrame with thin dams snapped to model grid.
test_equal(other)	Test if two components are equal.
write([filename])	Write SFINCS thin dams (.thd) file, and set thdfile in config (if it was not already set)

Attributes

data	Thin dam data, returned as a GeoDataFrame.
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.