imod.mf6.GroundwaterFlowModel.mask_all_packages

GroundwaterFlowModel.mask_all_packages(mask: DataArray | UgridDataArray, ignore_time_purge_empty: bool = False)

This function applies a mask to all packages in a model. The mask must be presented as an idomain-like integer array that has 0 (inactive) or <0 (vertical passthrough) values in filtered cells and >0 in active cells. Masking will overwrite idomain with the mask where the mask is <=0. Where the mask is >0, the original value of idomain will be kept. Masking will update the packages accordingly, blanking their input where needed, and is therefore not a reversible operation.

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

• ignore_time_purge_empty (bool, default False) – Whether to ignore time dimension when purging empty packages. Can improve performance when masking models with many time steps.