compass.ocean.tests.isomip_plus.geom.interpolate_ocean_mask¶
- compass.ocean.tests.isomip_plus.geom.interpolate_ocean_mask(ds_mesh, ds_geom, min_ocean_fraction, thin_film_present)[source]¶
Interpolate the ocean mask from the original BISICLES grid to the MPAS mesh. This is handled separately from other fields because the ocean mask is needed to cull land cells from the MPAS mesh before interpolating the remaining fields.
- Parameters:
ds_mesh (xarray.Dataset) – An MPAS-Ocean mesh
ds_geom (xarray.Dataset) – Ice-sheet topography produced by
compass.ocean.tests.isomip_plus.process_geom.ProcessGeom
min_ocean_fraction (float) – The minimum ocean fraction after interpolation, below which the cell is masked as land (which is not distinguished from grounded ice)
thin_film_present (bool) – Whether domain contains a thin film below grounded ice
- Returns:
ds_mask (xarray.Dataset) – A dataset containing
regionCellMasks
, a field with the ocean mask that can be used to cull land cells from the mesh