imod.select.get_upper_active_layer_number

imod.select.get_upper_active_layer_number(active: DataArray | UgridDataArray) → DataArray | UgridDataArray

Returns planar grid of integers with the layer number of the lower most active cell.

Parameters:

active ({xr.DataArray, xu.UgridDataArray}) – Grid of booleans (…, layer, y, x) designating active cell.

Returns:

upper_active_layer – planar grid of integers (…, y, x) with the layer number of the uppermost active cell.

Return type:

{xr.DataArray, xu.UgridDataArray}

Examples

To get the layer numbers of the uppermost active cells for an idomain grid:

>>> active = idomain > 0
>>> upper_active_layer = get_upper_active_layer_number(active)

To get the layer numbers of the uppermost active cells for a data grid with floats, where np.nan indicates inactive cells:

>>> active = data.notnull()
>>> upper_active_layer = get_upper_active_layer_number(active)