hydromt_sfincs.components.grid.SfincsStorageVolume

class hydromt_sfincs.components.grid.SfincsStorageVolume(model: SfincsModel)

SFINCS Storage Volume Component.

This component contains methods to add storage volume data to the SFINCS model on regular grids. Storage volume can be used to represent the effect of green- infrastructure in urban environments, such as retention basins or rain barrels.

Note

The storage volume data is stored in the model grid’s data dataset under the key “vol”.

See also

SfincsGrid

__init__(model: SfincsModel)

Methods

__init__(model)
close()	Clean up all open datasets.
create(storage_locs[, volume, height, merge])	Create storage volume.
finish_write()	Finish the write functionality after cleanup was called for all components in the model.
read()	Not implemented, storage volume data is read when the grid is read.
test_equal(other)	Test if two components are equal.
write()	Not implemented, storage volume data is written when the grid is written.

Attributes

data	Get the data from the model grid.
data_catalog	Return the data catalog of the model this component is associated with.
mask	Get an empty mask with the same shape as the model grid.
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.