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

ToBeReviewed/GRILLE/

domdef.pro

Allows to extract a sub-domain of study by providing parameters needed for drawings (see outputs)

topdomdef Grid

domdef[, x1][, x2][, y1][, y2][, z1][, z2], FINDALWAYS=FINDALWAYS, GRIDTYPE=string or vector, MEMEINDICES=MEMEINDICES, XINDEX=XINDEX, YINDEX=YINDEX, ZINDEX=ZINDEX, ENDPOINTS=vector, TYPE=TYPE, INDEX=INDEX, _EXTRA=_EXTRA

Parameters

x1        in optional

Define the minimum longitude. (All levels are selected)

x2        in optional

Define the maximum longitude. (All levels are selected)

y1        in optional

Define the minimum latitude. (All levels are selected)

y2        in optional

Define the maximum latitude. (All levels are selected)

z1        in optional

For a 3d domain whose the horizontal part cover all glam

z2        in optional

For a 3d domain whose the horizontal part cover all gphi

Keywords

FINDALWAYS       

Force to redefine a box even when none point is find in the box. In this case, we select all the grid.

GRIDTYPE        type: string or vector

It is a string or a vector of strings containing the grids's name (Only determined by 'T','U','V','W','F') for which the calculation must be done. For example: 'T' or ['T','U']

MEMEINDICES       

It is possible that points T, U, V and F correspond to a same geographic box which do not concern the same array indexes. This is sometimes a problem (or at least serious complications) in programs where several type of grid intervene (see norme, curl...). Activate MEMEINDICES to force domdef to take same indexes - those of the grid T- for all other grids.

XINDEX       

We activate it if we want that all elements passed in input of domdef and concerning the X dimension refer to indexes of glam arrays rather than to values of these arrays.

YINDEX       

We activate it if we want that all elements passed in input of domdef and concerning the X dimension refer to indexes of gphi arrays rather than to values of these arrays.

ZINDEX       

We activate it if we want that all elements passed in input of domdef and concerning the X dimension refer to indexes of gdep arrays rather than to values of these arrays.

ENDPOINTS        type: vector

A four elements vector [x1,y1,x2,y2] used to specify that domdef must define the box used to make a plot (pltz, pltt, plt1d) done strictly along the line (that can have any direction) starting at (x1, y1) ending at (x2, y2). When defining endpoints, you must also define TYPE which define the type of plots ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used ENDPOINTS keywords

TYPE       

INDEX       

We activate it if we want that all elements passed in input of domdef refer to indexes of glam, gphi and gdep arrays rather than to values of these arrays.

_EXTRA       

Version history

Version

$Id: domdef.pro 327 2007-12-13 16:22:35Z pinsard $

History

Sebastien Masson (smasson@lodyc.jussieu.fr) 8/2/98 rewrite everything, debug and speed-up Sebastien Masson April 2005

Known issues

Todo items

seb: output pas clair/ pas d'input required?

Other attributes

Uses routines

common.pro

Statistics

McCabe cyclic 206
McCabe essential 2
McCabe modular design 1
Produced by IDLdoc 2.0.