<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

Grid/

ncdf_meshread.pro

read NetCDF meshmask file created by OPA

topncdf_meshread Grid

ncdf_meshread[, filename], GLAMBOUNDARY=2 elements vector, CHECKDAT=CHECKDAT, ONEARTH=scalar: 0 or 1, GETDIMENSIONS=scalar: 0 or 1, PERIODIC=scalar: 0 or 1, SHIFT=scalar, STRIDE=3 elements vector, STRCALLING=scalar string, _EXTRA=_EXTRA

Parameters

filename        in optional type: scalar string default: 'meshmask.nc'

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        type: 2 elements vector default: those defined in the file

Longitude boundaries that should be used to visualize the data. lon2 > lon1 lon2 - lon1 le 360 By default, the common (cm_4mesh) variable key_shift will be automatically defined according to GLAMBOUNDARY.

CHECKDAT       

Suppressed. Use micromeshmask.pro to create an appropriate meshmask.

ONEARTH        type: scalar: 0 or 1 default: 1

Force the manual definition of data localization on the earth or not 0) if the data are not on the earth 1) if the data are on earth (in that case we can for example use the labels 'longitude', 'latitude' in plots). The resulting value will be stored in the common (cm_4mesh) variable key_onearth ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY

GETDIMENSIONS        type: scalar: 0 or 1 default: 0

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        type: scalar: 0 or 1 default: computed by using the first line of glamt

Force the manual definition of the grid zonal periodicity. The resulting value will be stored in the common (cm_4mesh) variable key_periodic PERIODIC = 0 forces SHIFT = 0

SHIFT        type: scalar default: computed according to glamboundary

Force the manual definition of the zonal shift that must be apply to the data. The resulting value will be stored in the common (cm_4mesh) variable key_shift Note that if key_periodic=0 then in any case key_shift = 0.

STRIDE        type: 3 elements vector default: [1, 1, 1]

Specify the stride in x, y and z direction. The resulting value will be stored in the common (cm_4mesh) variable key_stride

STRCALLING        type: scalar string

the calling command used to call computegrid (this is used by xxx.pro)

_EXTRA       

used to pass isafile keywords

Examples

IDL> ncdf_meshread [,' filename']

Version history

Version

$Id: ncdf_meshread.pro 172 2006-09-11 07:11:26Z smasson $

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

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

Statistics

McCabe cyclic 94
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.