imod.mf6.OutputControl.mask

OutputControl.mask(mask: DataArray | UgridDataArray) → Any

Mask values outside of domain.

Floating values outside of the condition are set to NaN (nodata). Integer values outside of the condition are set to 0 (inactive in MODFLOW terms).

Parameters:

mask (xr.DataArray, xu.UgridDataArray of ints) – idomain-like integer array. >0 sets cells to active, 0 sets cells to inactive, <0 sets cells to vertical passthrough

Returns:

masked – The package with part masked.

Return type:

Package

Examples

To mask a package with an idomain-like array. For example, to create a package with the first 10 rows and columns masked, create the mask first:

>>> mask = xr.ones_like(idomain, dtype=int)
>>> mask[0:10, 0:10] = 0

Then call mask:

>>> masked_pkg = pkg.mask(mask)