imod.mf6.Well.to_mf6_pkg#

Well.to_mf6_pkg(active: DataArray | UgridDataArray, top: DataArray | UgridDataArray, bottom: DataArray | UgridDataArray, k: DataArray | UgridDataArray, validate: bool = False, strict_well_validation: bool = True) → Mf6Wel#

Write package to Modflow 6 package.

Based on the model grid and top and bottoms, cellids are determined. When well screens hit multiple layers, groundwater extractions are distributed based on layer transmissivities. Wells located in inactive cells are removed.

Note

The well distribution based on transmissivities assumes confined aquifers. If wells fall dry (and the rate distribution has to be recomputed at runtime), it is better to use the Multi-Aquifer Well package.

Parameters:

  • active ({xarry.DataArray, xugrid.UgridDataArray}) – Grid with active cells.

  • top ({xarry.DataArray, xugrid.UgridDataArray}) – Grid with top of model layers.

  • bottom ({xarry.DataArray, xugrid.UgridDataArray}) – Grid with bottom of model layers.

  • k ({xarry.DataArray, xugrid.UgridDataArray}) – Grid with hydraulic conductivities.

  • validate (bool, default True) – Run validation before converting

  • strict_well_validation (bool, default True) – Set well validation strict: Throw error if well is removed entirely during its assignment to layers.

Returns:

Object with wells as list based input.

Return type:

Mf6Wel