polaris.tasks.ocean.realistic_global.mesh_info.estimate_ocean_cell_count

polaris.tasks.ocean.realistic_global.mesh_info.estimate_ocean_cell_count(mesh_name, config=None)[source]

Return an approximate cell count for the ocean + sea-ice culled mesh that the ocean model actually runs, or None if it cannot be determined.

This is the appropriate size for ocean-model resources, since the full mesh includes finer land and river-channel refinement that is culled away before the ocean model runs. It is read from the culled_ocean_cell_count option in the [realistic_global_mesh] section when set; otherwise it falls back to estimate_cell_count() (the full mesh estimate).

Parameters:

  • mesh_name (str) – The MPAS mesh name.

  • config (polaris.config.PolarisConfigParser, optional) – A config that already includes the per-mesh options for mesh_name. Callers that have one should pass it so that user overrides of culled_ocean_cell_count are honored. If it is not given, the per-mesh config file is read directly from the package instead.

Returns:

int or None