hydromt_sfincs.components.geometries.SfincsWeirs

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

SFINCS weir geometry component.

This component handles reading, writing, and creating weir geometries for SFINCS models. Weirs can be used to represent flow control structures, dikes, and levees, and are represented as LineString geometries (with elevation) in a GeoDataFrame.

__init__(model: SfincsModel)

Methods

__init__(model)
clear()	Clean GeoDataFrame with weirs.
close()	Clean up all open datasets.
create(locations[, dep, buffer, dz, merge])	Create model weir lines (old name: setup_structures).
delete(index)	Remove one or more weir, based on index.
determine_weir_elevation(gdf[, dep, buffer, dz])	Determine z values for weir structures.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
list_names()	Give list of names of cross sections.
read([filename])	Read SFINCS weir (.weir) file.
set(gdf[, merge])	Set SFINCS weir lines.
snap_to_grid()	Returns GeoDataFrame with weirs snapped to model grid.
test_equal(other)	Test if two components are equal.
write([filename])	Write SFINCS weir (.weir) file, and set weirfile in config (if it was not already set).

Attributes

data	Weirs lines 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.