hydromt_sfincs.components.grid.SfincsInfiltration#

class hydromt_sfincs.components.grid.SfincsInfiltration(model: SfincsModel)[source]#

SFINCS Infiltration Component.

This component contains methods to add infiltration data to the SFINCS model on regular grids. Various infiltration parameterizations can be used, including spatially varying constant infiltration rates and curve number based methods.

Note

The infiltration data is stored in the model grid’s data dataset under the keys “qinf”, “scs”, “smax”, “seff” and “ks”.

See also

SfincsGrid

__init__(model: SfincsModel)[source]#

Methods

__init__(model)

close()

Clean up all open datasets.

create_cn(cn[, antecedent_moisture, ...])

Create model potential maximum soil moisture retention map (scsfile) from gridded curve number map.

create_cn_with_recovery(lulc, hsg, ksat, ...)

Create model the Soil Conservation Service (SCS) Curve Number (CN) files for SFINCS including recovery term based on the soil saturation

create_constant([qinf, lulc, reclass_table, ...])

Create spatially varying constant infiltration rate (qinffile).

finish_write()

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

read()

Not implemented, infiltration data is read when the grid is read.

test_equal(other)

Test if two components are equal.

write()

Not implemented, infiltration 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.