polaris.mesh.connectivity.transport_link_mask

polaris.mesh.connectivity.transport_link_mask(ds_mesh, cell_mask)[source]

Find the active edges across which a B-grid can move sea ice.

The velocity used to move ice across an edge is built from the velocities at the edge’s two vertices, so an edge whose vertices are both inactive carries no flux and does not connect the cells it separates, even though they share an edge.

Parameters:

ds_mesh (xarray.Dataset) – An MPAS mesh with cellsOnCell and nEdgesOnCell
cell_mask (numpy.ndarray or xarray.DataArray) – A boolean mask on cells that is True for cells in the domain

Returns:

link_mask (numpy.ndarray) – A boolean array of shape (nCells, maxEdges) that is True for active edges with at least one active vertex