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

CullMaskStep.refine_ocean_cull_mask(ds_base_mesh, ds_topo, cull_mask)

Refine the mask for culling land and (optionally) grounded ice from the ocean. Subclasses can override this method to first refine the mask and then call the base class method to handle critical transects and land-locked cells.

The base class applies the critical transects, removes the cells with fewer than two active edges, through which a C-grid cannot circulate, and discards whatever is left unconnected to the open ocean. The sea-ice criteria are not applied here; they belong to the ocean without ice-shelf cavities and are applied when the two domains are refined together. See the land_locked_cells design document.

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