oceanspy.compute.curl

oceanspy.compute.curl(od, iName=None, jName=None, kName=None, aliased=True)[source]

Compute curl of a vector field.

\[\nabla \times {\bf F} = \left( \frac{\partial F_z}{\partial y} - \frac{\partial F_y}{\partial z} \right)\mathbf{\hat{x}} + \left( \frac{\partial F_x}{\partial z} - \frac{\partial F_z}{\partial x} \right)\mathbf{\hat{y}} + \left( \frac{\partial F_y}{\partial x} - \frac{\partial F_x}{\partial y} \right)\mathbf{\hat{z}}\]

Parameters:

od: OceanDataset: oceandataset used to compute.
iName: str or None: Name of variable corresponding to i-component.
jName: str or None: Name of variable corresponding to j-component.
kName: str or None: Name of variable corresponding to k-component.
aliased: bool: Set it False when working with private ds and grid.

Returns:

ds: xarray.Dataset: d[jName]_dX-d[iName]_dY

d[kName]_dY-d[jName]_dZ

d[iName]_dZ-d[kName]_dX