uxarray.UxDataArray.data_location

uxarray.UxDataArray.data_location#

property UxDataArray.data_location#

Returns where on the grid the data variable is stored.

The location is inferred from the grid dimension present in the data variable, using UGRID-style names:

  • "face_centered" if the data contains the n_face dimension

  • "node_centered" if the data contains the n_node dimension

  • "edge_centered" if the data contains the n_edge 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 "face_centered", "node_centered", "edge_centered", or None.

Return type:

str or None