polaris.tasks.e3sm.init.topo.cull.land_locked.find_dead_end_cells

polaris.tasks.e3sm.init.topo.cull.land_locked.find_dead_end_cells(ds_mesh, ocean_mask)[source]

Find the dead ends of a candidate ocean domain: the cells that the C-grid criterion removes, either because they have fewer than two active edges or because removing their neighbors leaves them so.

Dead ends form cul-de-sacs, so removing them never disconnects one part of the ocean from another.

Parameters:

ds_mesh (xarray.Dataset) – An MPAS mesh with cellsOnCell and nEdgesOnCell
ocean_mask (numpy.ndarray) – A boolean mask on cells, True for the candidate ocean domain

Returns:

dead_end_mask (numpy.ndarray) – A boolean mask on cells, True for the dead ends of the domain