uxarray.UxDataArray.data_mapping

uxarray.UxDataArray.data_mapping#

property UxDataArray.data_mapping#

Returns which grid element a data variable is mapped to.

The mapping is inferred from the grid dimension present in the data variable:

  • "faces" if the data contains the n_face dimension

  • "edges" if the data contains the n_edge dimension

  • "nodes" if the data contains the n_node dimension

  • None if the data is not mapped to the grid

Notes

Additional locations described in the UGRID/spectral-element ecosystem (e.g. "face_average", "edge_orthogonal", "edge_parallel", "cgll", "dgll") cannot be inferred from a data variable’s dimensions alone and are not currently distinguished here.

Returns:

One of "faces", "edges", "nodes", or None.

Return type:

str or None