polaris.tasks.e3sm.init.component_inputs.maps.base_to_culled_maps

polaris.tasks.e3sm.init.component_inputs.maps.base_to_culled_maps(ds_maps_culled_to_base: dict[str, Dataset], sizes: dict[str, int]) → Dataset[source]

All nine base-to-culled index maps, one per culled mesh and element type.

Parameters:

ds_maps_culled_to_base (dict of {str: xarray.Dataset}) – The cull step’s forward maps, keyed by culled-mesh prefix. Must cover every prefix in CULLED_MESH_SUFFIXES.
sizes (dict of {str: int}) – The nCells, nEdges and nVertices of the base mesh.

Returns:

xarray.Dataset – The nine mapBaseTo{Ocean,OceanNoCavities,Land}{Cell,Edge,Vertex} fields.

Raises:

ValueError – If a prefix is missing, or if a forward map fails the checks described in map_base_to_culled().