Gridsets and grids#

parcels.gridset module#

class parcels.gridset.GridSet[source]#

Bases: object

GridSet class that holds the Grids on which the Fields are defined.

Attributes:
size

Methods

dimrange(dim)

Returns maximum value of a dimension (lon, lat, depth or time) on 'left' side and minimum value on 'right' side for all grids in a gridset.

add_grid
dimrange(dim)[source]#

Returns maximum value of a dimension (lon, lat, depth or time) on ‘left’ side and minimum value on ‘right’ side for all grids in a gridset. Useful for finding e.g. longitude range that overlaps on all grids in a gridset.

parcels.grid module#

class parcels.grid.CGrid[source]#

Bases: Structure

Attributes:
grid
gtype
class parcels.grid.CurvilinearSGrid(lon: ndarray[tuple[Any, ...], dtype[_ScalarT]], lat: ndarray[tuple[Any, ...], dtype[_ScalarT]], depth: ndarray[tuple[Any, ...], dtype[_ScalarT]], time: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None, time_origin: TimeConverter | None = None, mesh: Literal['spherical', 'flat'] = 'flat')[source]#

Bases: CurvilinearGrid

Curvilinear S Grid.

Parameters:

  • lon – 2D array containing the longitude coordinates of the grid

  • lat – 2D array containing the latitude coordinates of the grid

  • depth – 4D (time-evolving) or 3D (time-independent) array containing the vertical coordinates of the grid, which are s-coordinates. s-coordinates can be terrain-following (sigma) or iso-density (rho) layers, or any generalised vertical discretisation. The depth of each node depends then on the horizontal position (lon, lat), the number of the layer and the time is depth is a 4D array. depth array is either a 4D array[xdim][ydim][zdim][tdim] or a 3D array[xdim][ydim[zdim].

  • time – Vector containing the time coordinates of the grid

  • time_origin (parcels.tools.converters.TimeConverter) – Time origin of the time axis

  • mesh (str) –

    String indicating the type of mesh coordinates and units used during velocity interpolation:

    1. spherical (default): Lat and lon in degree, with a correction for zonal velocity U near the poles.

    2. flat: No conversion, lat/lon are assumed to be in m.

Attributes:
cell_edge_sizes
cgrid

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

child_ctypes_struct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_deprecated

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded_touched

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loading_requested

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_not_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

cstruct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

ctypes_struct
defer_load
depth
gtype

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lat
lat_flipped

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

load_chunk

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lon
lonlat_minmax
meridional_halo
mesh
ti

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

time_origin
update_status

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

xdim
ydim
z4d

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

zdim
zonal_halo
zonal_periodic

Methods

add_Sdepth_periodic_halo(*args, **kwargs)

add_periodic_halo(zonal, meridional[, halosize])

Add a 'halo' to the Grid, through extending the Grid (and lon/lat) similarly to the halo created for the Fields

check_zonal_periodic(*args, **kwargs)

computeTimeChunk(*args, **kwargs)

negate_depth()

Method to flip the sign of the depth dimension of a Grid.

create_grid
class parcels.grid.CurvilinearZGrid(lon: ndarray[tuple[Any, ...], dtype[_ScalarT]], lat: ndarray[tuple[Any, ...], dtype[_ScalarT]], depth: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None, time: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None, time_origin: TimeConverter | None = None, mesh: Literal['spherical', 'flat'] = 'flat')[source]#

Bases: CurvilinearGrid

Curvilinear Z Grid.

Parameters:

  • lon – 2D array containing the longitude coordinates of the grid

  • lat – 2D array containing the latitude coordinates of the grid

  • depth – Vector containing the vertical coordinates of the grid, which are z-coordinates. The depth of the different layers is thus constant.

  • time – Vector containing the time coordinates of the grid

  • time_origin (parcels.tools.converters.TimeConverter) – Time origin of the time axis

  • mesh (str) –

    String indicating the type of mesh coordinates and units used during velocity interpolation:

    1. spherical (default): Lat and lon in degree, with a correction for zonal velocity U near the poles.

    2. flat: No conversion, lat/lon are assumed to be in m.

Attributes:
cell_edge_sizes
cgrid

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

child_ctypes_struct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_deprecated

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded_touched

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loading_requested

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_not_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

cstruct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

ctypes_struct
defer_load
depth
gtype

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lat
lat_flipped

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

load_chunk

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lon
lonlat_minmax
meridional_halo
mesh
ti

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

time_origin
update_status

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

xdim
ydim
z4d

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

zdim
zonal_halo
zonal_periodic

Methods

add_Sdepth_periodic_halo(*args, **kwargs)

add_periodic_halo(zonal, meridional[, halosize])

Add a 'halo' to the Grid, through extending the Grid (and lon/lat) similarly to the halo created for the Fields

check_zonal_periodic(*args, **kwargs)

computeTimeChunk(*args, **kwargs)

negate_depth()

Method to flip the sign of the depth dimension of a Grid.

create_grid
class parcels.grid.Grid(lon: ndarray[tuple[Any, ...], dtype[_ScalarT]], lat: ndarray[tuple[Any, ...], dtype[_ScalarT]], time: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None, time_origin: TimeConverter | None, mesh: Literal['spherical', 'flat'])[source]#

Bases: object

Grid class that defines a (spatial and temporal) grid on which Fields are defined.

Attributes:
cell_edge_sizes
cgrid

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

child_ctypes_struct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_deprecated

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded_touched

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loading_requested

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_not_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

cstruct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

ctypes_struct
defer_load
depth
gtype

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lat
lat_flipped

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

load_chunk

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lon
lonlat_minmax
meridional_halo
mesh
ti

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

time_origin
update_status

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

z4d

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

zonal_halo
zonal_periodic

Methods

add_Sdepth_periodic_halo(*args, **kwargs)

check_zonal_periodic(*args, **kwargs)

computeTimeChunk(*args, **kwargs)

negate_depth()

Method to flip the sign of the depth dimension of a Grid.

create_grid
add_Sdepth_periodic_halo(*args, **kwargs)[source]#

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

property cgrid[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

check_zonal_periodic(*args, **kwargs)[source]#

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

property child_ctypes_struct[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property chunk_deprecated[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property chunk_loaded[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property chunk_loaded_touched[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property chunk_loading_requested[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property chunk_not_loaded[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

computeTimeChunk(*args, **kwargs)[source]#

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

property cstruct[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property gtype[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property lat_flipped[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property load_chunk[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

negate_depth()[source]#

Method to flip the sign of the depth dimension of a Grid. Note that this method does _not_ change the direction of the vertical velocity; for that users need to add a fieldset.W.set_scaling_factor(-1.0)

property ti[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property update_status[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

property z4d[source]#

//github.com/OceanParcels/Parcels/issues/1695.

Type:

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at https

parcels.grid.GridCode[source]#

alias of GridType

class parcels.grid.GridType(*values)[source]#

Bases: IntEnum

Attributes:
denominator

the denominator of a rational number in lowest terms

imag

the imaginary part of a complex number

numerator

the numerator of a rational number in lowest terms

real

the real part of a complex number

Methods

as_integer_ratio(/)

Return a pair of integers, whose ratio is equal to the original int.

bit_count(/)

Number of ones in the binary representation of the absolute value of self.

bit_length(/)

Number of bits necessary to represent self in binary.

conjugate(/)

Returns self, the complex conjugate of any int.

from_bytes(/, bytes[, byteorder, signed])

Return the integer represented by the given array of bytes.

is_integer(/)

Returns True.

to_bytes(/[, length, byteorder, signed])

Return an array of bytes representing an integer.
class parcels.grid.RectilinearSGrid(lon: ndarray[tuple[Any, ...], dtype[_ScalarT]], lat: ndarray[tuple[Any, ...], dtype[_ScalarT]], depth: ndarray[tuple[Any, ...], dtype[_ScalarT]], time: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None, time_origin: TimeConverter | None = None, mesh: Literal['spherical', 'flat'] = 'flat')[source]#

Bases: RectilinearGrid

Rectilinear S Grid. Same horizontal discretisation as a rectilinear z grid,

but with s vertical coordinates

Parameters:

  • lon – Vector containing the longitude coordinates of the grid

  • lat – Vector containing the latitude coordinates of the grid

  • depth – 4D (time-evolving) or 3D (time-independent) array containing the vertical coordinates of the grid, which are s-coordinates. s-coordinates can be terrain-following (sigma) or iso-density (rho) layers, or any generalised vertical discretisation. The depth of each node depends then on the horizontal position (lon, lat), the number of the layer and the time is depth is a 4D array. depth array is either a 4D array[xdim][ydim][zdim][tdim] or a 3D array[xdim][ydim[zdim].

  • time – Vector containing the time coordinates of the grid

  • time_origin (parcels.tools.converters.TimeConverter) – Time origin of the time axis

  • mesh (str) –

    String indicating the type of mesh coordinates and units used during velocity interpolation:

    1. spherical (default): Lat and lon in degree, with a correction for zonal velocity U near the poles.

    2. flat: No conversion, lat/lon are assumed to be in m.

Attributes:
cell_edge_sizes
cgrid

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

child_ctypes_struct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_deprecated

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded_touched

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loading_requested

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_not_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

cstruct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

ctypes_struct
defer_load
depth
gtype

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lat
lat_flipped

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

load_chunk

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lon
lonlat_minmax
meridional_halo
mesh
ti

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

time_origin
update_status

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

xdim
ydim
z4d

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

zdim
zonal_halo
zonal_periodic

Methods

add_Sdepth_periodic_halo(*args, **kwargs)

add_periodic_halo(zonal, meridional[, halosize])

Add a 'halo' to the Grid, through extending the Grid (and lon/lat) similarly to the halo created for the Fields

check_zonal_periodic(*args, **kwargs)

computeTimeChunk(*args, **kwargs)

negate_depth()

Method to flip the sign of the depth dimension of a Grid.

create_grid
class parcels.grid.RectilinearZGrid(lon, lat, depth=None, time=None, time_origin=None, mesh: Literal['spherical', 'flat'] = 'flat')[source]#

Bases: RectilinearGrid

Rectilinear Z Grid.

Parameters:

  • lon – Vector containing the longitude coordinates of the grid

  • lat – Vector containing the latitude coordinates of the grid

  • depth – Vector containing the vertical coordinates of the grid, which are z-coordinates. The depth of the different layers is thus constant.

  • time – Vector containing the time coordinates of the grid

  • time_origin (parcels.tools.converters.TimeConverter) – Time origin of the time axis

  • mesh (str) –

    String indicating the type of mesh coordinates and units used during velocity interpolation:

    1. spherical (default): Lat and lon in degree, with a correction for zonal velocity U near the poles.

    2. flat: No conversion, lat/lon are assumed to be in m.

Attributes:
cell_edge_sizes
cgrid

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

child_ctypes_struct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_deprecated

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loaded_touched

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_loading_requested

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

chunk_not_loaded

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

cstruct

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

ctypes_struct
defer_load
depth
gtype

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lat
lat_flipped

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

load_chunk

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

lon
lonlat_minmax
meridional_halo
mesh
ti

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

time_origin
update_status

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

xdim
ydim
z4d

Deprecated since version It: has moved to the internal API as it is not expected to be directly used by the end-user. If you feel that you use this code directly in your scripts, please comment on our tracking issue at OceanParcels/Parcels#1695.

zdim
zonal_halo
zonal_periodic

Methods

add_Sdepth_periodic_halo(*args, **kwargs)

add_periodic_halo(zonal, meridional[, halosize])

Add a 'halo' to the Grid, through extending the Grid (and lon/lat) similarly to the halo created for the Fields

check_zonal_periodic(*args, **kwargs)

computeTimeChunk(*args, **kwargs)

negate_depth()

Method to flip the sign of the depth dimension of a Grid.

create_grid