polaris.tasks.ocean.horiz_press_grad.metrics.get_internal_edge

polaris.tasks.ocean.horiz_press_grad.metrics.get_internal_edge(ds_mesh: Dataset) → tuple[int, tuple[int, int]][source]

Determine the edge that connects the two valid cells in the two-column mesh.

Parameters:

ds_mesh (xarray.Dataset) – The culled horizontal mesh, which must contain cellsOnEdge.

Returns:

  • edge_index (int) – The zero-based index of the single internal edge.

  • cells_on_edge (tuple of int) – The zero-based indices of the two cells bounding that edge.