- class esmpy.api.field.Field(grid, name=None, typekind=None, staggerloc=None, meshloc=None, ndbounds=None)¶
Fieldclass is a Python wrapper object for the ESMF Field. The individual values of all data arrays are referenced to those of the underlying Fortran ESMF object.
Fieldrepresents a physical field, such as temperature. The
Fieldclass contains distributed and discretized field data, a reference to its associated grid, and metadata. The
Fieldclass stores the grid staggering for that physical field. This is the relationship of how the data array of a field maps onto a grid (e.g. one item per cell located at the cell center, one item per cell located at the NW corner, one item per cell vertex, etc.). This means that different
Fieldswhich are on the same underlying
Gridbut have different staggerings can share the same
Gridobject without needing to replicate it multiple times.
Refer to the Field Class of the ESMF Reference Manual for more information.
ndbounds (tuple) – The number of entries in an extra
Fielddimension. This is represented as a single value, a list or a tuple containing the number of entries for each desired extra dimension of the
Field. The time dimension must be last, following Fortran indexing conventions.
- property grid¶
- property staggerloc¶
- read(filename, variable, timeslice=None)¶
Read data into an existing
Fieldfrom a CF-compliant NetCDF file.
This interface is not supported when ESMF is built with
This interface does not currently support reading ungridded dimensions.
timeslice (int) – The number of timeslices to read.