polaris.tasks.e3sm.init.topo.cull.CullMaskStep.refine_land_cull_mask

CullMaskStep.refine_land_cull_mask(ds_base_mesh, ds_topo, cull_mask)

Refine the mask for culling ocean from the land. The mask passed in is already the complement of the ocean without ice-shelf cavities, which the base class returns unaltered: someone is supposed to own every cell on the globe and no one is supposed to own it twice.

Subclasses can override this method to define a different land domain, but one that breaks the complementarity must also override CullMaskStep._check_mask_consistency(), which would otherwise reject the resulting masks.

Parameters:

• ds_base_mesh (xarray.Dataset) – The dataset containing the base mesh

• ds_topo (xarray.Dataset) – The dataset containing the unsmoothed topography

• cull_mask (xarray.DataArray) – The current cull mask to refine

Returns:

cull_mask (xarray.DataArray) – The refined cull mask