ESMF representations of UGRID meshes.
- class esmf_regrid.experimental.unstructured_regrid.MeshInfo(node_coords, face_node_connectivity, node_start_index, elem_start_index=0, areas=None, elem_coords=None, location='face')[source]#
Class for handling unstructured meshes.
This class holds information about Meshes in a form similar to UGRID. It contains methods for translating this information into
ESMFobjects. In particular, there are methods for representing as an
ESMF.api.mesh.Meshand as an
Mesh. This ESMF
Fieldis designed to contain enough information for area weighted regridding and may be inappropriate for other
MeshInfoobject describing a UGRID-like mesh.
ArrayLike) – An
Nx2array describing the location of the nodes of the mesh.
node_coords[:,0]describes the longitudes in degrees and
node_coords[:,1]describes the latitudes in degrees.
ArrayLike) – A masked array describing the face node connectivity of the mesh. The unmasked points of
face_node_connectivity[i]describe which nodes are connected to the
node_start_index (int) – A value which, appearing in the
face_node_connectivityarray, indicates the first node in the
node_coordsarray. UGRID supports both
1based indexing, so both must be accounted for here: https://ugrid-conventions.github.io/ugrid-conventions/#zero-or-one
elem_start_index (int, default=0) – Describes what index should be considered by
ESMFto be the start index for describing its elements. This makes no difference to the regridding calculation and will only affect the intermediate
ESMFobjects, should the user need access to them.
ArrayLike, optional) – Array describing the areas associated with each face. If
ESMFwill use its own calculated areas.
ArrayLike, optional) – An
Nx2array describing the location of the face centers of the mesh.
elem_coords[:,0]describes the longitudes in degrees and
elem_coords[:,1]describes the latitudes in degrees.
location (str, default="face") – Either “face” or “node”. Describes the location for data on the mesh.