imod.msw.Sprinkling.from_imod5_data#

classmethod Sprinkling.from_imod5_data(imod5_data: Imod5DataDict) → Sprinkling[source]#

Import sprinkling data from imod5 data. Abstraction data for sprinkling is defined in iMOD5 either with grids (IDF) or points (IPF) combined with a grid. Depending on the type, the method does different conversions:

  • grids (IDF)

    The "artifical_recharge_layer" variable was defined as grid (IDF), this grid defines in which layer a groundwater abstraction well should be placed. The "artificial_recharge" grid contains types which point to the type of abstraction:

    • 0: no abstraction

    • 1: groundwater abstraction

    • 2: surfacewater abstraction

    The "artificial_recharge_capacity" grid/constant defines the capacity of each groundwater or surfacewater abstraction. This is an 1:1 mapping: Each grid cell maps to a separate well.

  • points with grid (IPF & IDF)

    The "artifical_recharge_layer" variable was defined as point data (IPF), this table contains wellids with an abstraction capacity and layer. The "artificial_recharge" grid contains a mapping of grid cells to wellids in the point data. The "artificial_recharge_capacity" is ignored as the abstraction capacity is already defined in the point data. This is an n:1 mapping: multiple grid cells can map to one well.

Parameters:

imod5_data (dict[str, dict[str, GridDataArray]]) – dictionary containing the arrays mentioned in the project file as xarray datasets, under the key of the package type to which it belongs, as returned by imod.formats.prj.open_projectfile_data().

Return type:

Sprinkling package