polaris.ocean.mesh.spherical.add_spherical_base_mesh_step

polaris.ocean.mesh.spherical.add_spherical_base_mesh_step(component, resolution, icosahedral)[source]

Add a shared step for creating spherical base mesh with the given resolution to the ocean component (if one has not already been added)

Parameters

  • component (polaris.Component) – The ocean component that the step will be added to

  • resolution (float) – The resolution in km of the mesh

  • icosahedral (bool) – Whether the mesh is a subdivided icosahedral mesh, as opposed to

Returns

  • base_mesh (polaris.Step) – The base mesh step

  • mesh_name (str) – The name of the mesh (e.g. ‘240km’)