Changeset 142 for trunk/SRC/ToBeReviewed/GRILLE/domdef.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/GRILLE/domdef.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/GRILLE/domdef.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: DOMDEF
-;
-; PURPOSE:permet d'extraire un sous domaine d'etude en fournissant les
-; parametres necessaires pour les traces. (cf. outputs)
-;
-; CATEGORY:
-;
-; CALLING SEQUENCE:domdef [,lon1, lon2, lat1, lat2[,vert1,vert2]] ou
-;             bien domdef,vecteur
-;
-; INPUTS:(facultatif), [vecteur a] 2, 4 ou 6 elements:;
-; sans l''utilisation des mots cles index,xindex,yindex,zindex:
-; *vert1, vert2: pour un domaine 3D dont la partie horizontale couvre tout
-;  glam et gphi
-; *lon1, lon2, lat1, lat2:
-; definissant les longitudes min. max et les latitudes min, max du  domaine a
-; etudier (tous les niveaux sont selectiones)
-; *lon1,lon2,lat1,lat2,vert1,vert2 pour specifier les profondeurs.
-;
-; KEYWORD PARAMETERS:
-;
-;       ENDPOINTS: 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
-;
-;       FINDALWAYS:oblige a redefinir une boite meme qd auqun point
-;       n''est trouve ds la boite. dans ce cas on selectionne toute la
-;       grille.
-;
-;       GRIDTYPE:un string ou un vecteur de string contennant le nom des
-;       grilles (determinees uniquement par : 'T','U','V','W','F') pour
-;       lesquelles le calcul doit etre fait. par
-;       ex :'T' ou ['T','U']
-;
-;       /MEMEINDICES: il se peut que les points t,u,v et F correspondant a
-;       une meme boite geographique ne concernent pas les memes
-;       indices des tableaux. Ceci pose parfois de pb (ou du moins de
-;       serieuses complications) ds les programmes ou plusieurs types
-;       de grilles interviennent (cf.: norme, curl...). Activer
-;       MEMEINDICES pour forcer domdef a prendre les memes indices -ceux
-;       de la grille T- pour toutes les autres grilles.
-;
-;       /INDEX: activer si on veut specifier que tous les elements
-;       passes en entree de domdef se rapportent aux indices des
-;       tableaux glam, gphi et gdep plutot qu'aux valeurs de ces
-;       tableaux
-;
-;       /xindex: activer si on veut que les elements passes en entrre
-;       de domdef et concernant la dimension en x se rapportent aux
-;       indices des tableaux glam qu'aux valeurs de ces tableaux.
-;
-;       /yindex: cf xindex mais pour y et les gphi
-;
-;       /zindex: cf xindex mais pour z et les gdep
+;
+; @file_comments 
+; Allows to extract a subdomain of study by providing parameters 
+; needed for drawings (see outputs)
+;
+; @categories
+;
+; @param Z1 {in}{optional}
+; For a 3d domain whose the horizontal part cover all glam
+; 
+; @param Z2 {in}{optional}
+; For a 3d domain whose the horizontal part cover all gphi
+;
+; @param X1 {in}{optional}
+; Define the minimum longitude. (All levels are selected)
+;
+; @param X2 {in}{optional}
+; Define the maximum longitude. (All levels are selected)
+;
+; @param Y1 {in}{optional}
+; Define the minimum latitude. (All levels are selected)
+;
+; @param Y2 {in}{optional}
+; Define the maximum latitude. (All levels are selected)
+;
+; @keyword ENDPOINTS
+; 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
+;
+; @keyword FINDALWAYS
+; Force to redefine a box even when none point is find in the box. 
+; In this case, we select all the grid.
+;
+; @keyword GRIDTYPE
+; It is a string or a vector of strings containing the grids's name 
+; (Only determinated by 'T','U','V','W','F') for which the calculation 
+; must be done. 
+;  For example: 'T' ou ['T','U']
+;
+; @keyword 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 interven (see norme, curl...). Activate MEMEINDICE to
+; force domdef to take same indexes -those of the grid T- for all other
+; grids.
+;
+; @keyword 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.
+;
+; @keyword 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.
+;
+; @keyword 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.
+; 
+; @keyword 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.
 ;
 ; OUTPUTS:on recupere pour les 4 grilles t,u,v,f
@@ -82 +95 @@
 ;   suivant z
 ;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @uses
+; common.pro
+;
+;
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       8/2/98
 ; rewrite everything, debug and spee-up Sebastien Masson April 2005
+;
+; @version
+; $Id$
+;
+; @todo seb: output pas clair/ pas d'input required?
 ;-
 ;------------------------------------------------------------
@@ -114 +128 @@
   ENDIF
 ;---------------------
-  tempsun = systime(1)          ; pour key_performance
+  tempsun = systime(1)          ; For key_performance
 ;
   CASE N_PARAMS() OF