polaris.tasks.e3sm.init.component_inputs.names.ocean_grid_name
- polaris.tasks.e3sm.init.component_inputs.names.ocean_grid_name(short_name: str) str[source]
E3SM’s name for the ocean and sea-ice grid of a mesh.
E3SM splits a unified mesh into an
ocnicegrid and a land and river grid, named for the ID and the matching half of the short name:u02-oi30andu02-lr10foru02-oi30-lr10. The ocean and sea-ice directories and initial conditions are named for theocnicegrid. A short name with no land part, as an override might give for an ocean-only mesh, is the grid name as it stands.- Parameters:
short_name (str) – The E3SM short name of the mesh.
- Returns:
str – E3SM’s name for the ocean and sea-ice grid.