Computation/
curl.pro
Calculate the vertical component of the curl of a field of horizontal vectors
curl
Calculation
result = curl(uu, vv, DIREC=scalar string)
Return value
the vertical component of the curl of the input data (with the same size)
Parameters
uu
Matrix representing the zonal coordinates (U point) of a field of vectors
A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
Note that the dimension of the array must suit the domain dimension.
vv
Matrix representing the meridional coordinates (V point) of a field of vectors
A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
Note that the dimension of the array must suit the domain dimension.
Keywords
DIREC
type: scalar string
Use if you want to call moyenne or
grossemoyenne after the div computation
with a mean done in the DIREC direction
Examples
IDL> @tst_initorca2
IDL> plt, curl(dist(jpi,jpj), dist(jpi,jpj))
Version history
Version
$Id: curl.pro 248 2007-05-29 08:59:39Z smasson $
History
Guillaume Roullet (grlod@ipsl.jussieu.fr)
Sebastien Masson (smasson@lodyc.jussieu.fr)
adaptation to work with a reduce domain
21/5/1999: missing values at !values.f_nan
Known issues
Todo items
code the 4D case
Restrictions
- Works only for Arakawa C-grid.
- UU must be on U grid, VV must be on V grid
- 4D case is not coded yet
- the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
- U and V arrays are cut in the same geographic domain. Because of the shift between
T, U, V and F grids, it is possible that these two arrays do not have the same
size and refer to different indexes. In this case, arrays are re-cut on
common indexes. To avoid these re-cuts, use the keyword /memeindice in
domdef
- When computing the divergence, we update, vargrid, varname, varunits and the
grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf).
- points that cannot be computed (domain boundaries, coastline) are set to NaN
Other attributes
Uses routines
cm_4cal
cm_4data
cm_4mmesh
Produced by IDLdoc 2.0.