Grid/
ncdf_meshread.pro
read NetCDF meshmask file created by OPA
ncdf_meshread
Grid
ncdf_meshread[, filename], GLAMBOUNDARY=GLAMBOUNDARY, CHECKDAT=CHECKDAT, ONEARTH=ONEARTH, GETDIMENSIONS=GETDIMENSIONS, PERIODIC=PERIODIC, SHIFT=SHIFT, STRIDE=STRIDE, STRCALLING=string, _EXTRA=_EXTRA
Parameters
filename
in
optional
default: meshmask.nc
the name of the meshmask file to read.
if this name does not contain any "/" and if
iodirectory keyword is not specify, then the common variable
iodir will be use to define the mesh file path.
Keywords
GLAMBOUNDARY
a 2 elements vector, [lon1,lon2], the longitude
boundaries that should be used to visualize the data.
lon2 > lon1
lon2 - lon1 le 360
key_shift will be automatically defined according to GLAMBOUNDARY.
CHECKDAT
Suppressed. Use micromeshmask.pro to create an
appropriate meshmask.
ONEARTH
default: key_onearth
= 0 or 1 to force the manual definition of
key_onearth (to specify if the data are on earth -> use longitude
/latitude etc...).
note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is
cancelling GLAMBOUNDARY
GETDIMENSIONS
Activate this keywords if you only want to know the dimension
of the domain stored in the mesh file. This dimensions will be
defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
PERIODIC
default: key_periodic is automatically computed by using the first line of glamt
= 0 or 1 to force the manual definition of
key_periodic.
SHIFT
default: key_shift is automatically computed according to the glamboundary
to force the manual definition of key_shift. By
default, key_shift is automatically computed according to the
glamboundary (when defined) by using the first line of glamt. if
key_periodic=0 then in any case key_shift = 0.
STRIDE
default: key_stride
a 3 elements vector to specify the stride in x, y, z direction.
The resulting value will be stored in the common (cm_4mesh) variable
key_stride
STRCALLING
type: string
a string containing the calling command used to call
computegrid (this is used by xxx.pro)
_EXTRA
used to pass your keywords to the created function.
Examples
IDL> ncdf_meshread [,' filename']
Version history
Version
$Id: ncdf_meshread.pro 163 2006-08-29 12:59:46Z navarro $
History
Sebastien Masson (smasson@lodyc.jussieu.fr)
12/1999
July 2004, Sebastien Masson: Several modifications (micromeshmask,
clean partial steps, clean use of key_stride, automatic definition
of key_shift, ...)
Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT
Aug. 2005, Sebastien Masson: some cleaning + english
Known issues
Restrictions
define and/or use common variables from
cm_4mesh, cm_4data, cm_4cal
ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
be defined before calling ncdf_meshread. if some of those value
are equal to -1 they will be automatically defined
Other attributes
Uses routines
cm_4mesh cm_4data cm_4cal
Produced by IDLdoc 2.0 on Wed Sep 6 12:27:18 2006.