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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/GRILLE/grille.pro (modified) (14 diffs)

trunk/SRC/ToBeReviewed/GRILLE/grille.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:grille
-;
-; PURPOSE: choisit la grille qui doit etre utilisee pour faire le graphe en
-; fonction de vargrid et renvoie les parametres correspondants calcules ds
-; domdef.pro et reduit au domaine definit par domdef (contrairement a
-; grandegrille.pro)
-;
-; CATEGORY:
-;
-; CALLING SEQUENCE:
-;  grille,mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz,lastx,lasty,lastz,e1,e2,e3
-;
-; INPUTS:rien. ATTENTION les choix de la grille se fait a partir de la
-; valeur de la variable globale vargrid, qui peut etre egale a 'T',
-; 'U', 'V', 'W' ou 'F'.
-;
-; KEYWORD PARAMETERS:
-;         TRI si ce mot clef sert a obtenir grace a grille la
-;         triangulation qui se rapporte a la grille mais uniquement
-;         sur la partie du zoom. ce tableau de triangulation reduit
-;         est passe ds la variable que l''on a egalee a tri.par ex:
-;         grille,...,tri=triangulation_reduite. ne mot clef est
-;         utilise dans plt.pro
-;
-;         /FORPLT: ds plt on veut que sur les points terres, glam et
-;         gphi soit egale a glamt et gphit quelle que soit la grille.
-;
-;         /NOTRI: utile seulement qd TRI est active. dans ce cas
-;         grille retourne -1 ds la variable tri meme si la variable du
-;         common triangles_list est definie et differente de -1
-;
-;         /WDEPTH: to specify that the field is at W depth instad of T 
-;         depth (automatically activated if vargrid eq 'W')
-;
-; OUTPUTS:mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz,
-;         lastx,lasty,lastz,e1,e2,e3
-;
-;         pour leur definition cf domdef et la gestion des sous
-;         domaines sur le web
-;
-;         Rq: ces outputs sont optionnels, si je veux recuperer que
-;         mask, glam et gphi il suffit de taper grille, mask, glam, gphi
-;
-; COMMON BLOCKS: cm_4mesh and cm_4data
-;
-; SIDE EFFECTS: utilise la variable globale vargird
-;
-; RESTRICTIONS: vargrid doit etre 'T', 'W', 'U', 'V' ou 'F'
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; @file_comments
+; Choose the grid which must be used to do the graph in function of
+; vargrid and send back corresponding parameters calculated in
+; domdef.pro and reduced at the domain defined by domdef (contrarily
+; to grandegrille.pro)
+; BEWARE!! The choice of the grid is made from the value of the 
+; global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
+;
+; @categories
+;
+; @keyword TRI 
+; This keyword serve to obtain, thanks to grille, the triangulation which
+; refer to the grid but only on the part of the zoom. This of triangulation
+; is passed in the variable we have equate at TRI.
+; For example: grille,...,tri=triangulation_reduite.
+; This keyword is used in plt.pro
+;
+; @keyword WDEPTH
+; To specify that the field is at W depth instad of T 
+; depth (automatically activated if vargrid eq 'W')
+; 
+; @keyword FORPLT
+; In plt, we want that land points, glam and gphi, be equal to glamt and 
+; gphit regardless of the grid.
+;
+; @keyword NOTRI
+; Useful only when TRI is activated. In this case, grill send back -1 in the 
+; variable tri even if the variable of the common triangles_list is defined 
+; and different of-1
+; 
+; @keyword _EXTRA 
+; Used to pass your keywords
+;
+; @keyword TOUT
+;
+; @param MASK {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  GLAM {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  GPHI {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  GDEP {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  NX {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  NY {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  NZ {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  FIRSTX {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  FIRSTY {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  FIRSTZ {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+;         
+; @param LASTX {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  LASTY {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  LASTZ {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  E1 {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+;
+; @param  E2 {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+; 
+; @param  E3 {out}{optional}
+; For the definition, see domdef and the management of subdomains on the web.
+;
+; @uses
+; cm_4mesh 
+; cm_4data
+;
+; @restrictions 
+; Use the variable vargrid
+;
+; @restrictions
+; Vargrid must be 'T', 'W', 'U', 'V' ou 'F'
+;
+; @history
+;  Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       12/2/1999
 ;                       10/11/1999 /forplt
+;
+; @version
+; $Id$ 
+;
+; @todo Comment ecrire la remarque sur les inputs?
+; 
 ;-
 ;------------------------------------------------------------
@@ -73 +123 @@
   ENDIF
 ;---------------------
-  tempsun = systime(1)          ; pour key_performance
+  tempsun = systime(1)          ; For key_performance
 ;------------------------------------------------------------
   vargrid = strupcase(strmid(vargrid,0,/reverse_offset))
@@ -83 +133 @@
     domdef, gridtype = vargrid, _EXTRA = ex
   endif
-  tempdeux = systime(1)         ; pour key_performance =2
+  tempdeux = systime(1)         ; For key_performance =2
 ;------------------------------------------------------------
 ;------------------------------------------------------------
@@ -99 +149 @@
   CASE 1 OF 
 ;------------------------------------------------------------
-; grille T and W
+; grid T and W
 ;------------------------------------------------------------
     vargrid eq 'T' OR vargrid eq 'W' : begin
-;scalaires
+;scalars
       nx = nxt
       ny = nyt
@@ -109 +159 @@
       lastx = lastxt
       lasty = lastyt
-;vecteurs 2d
+;2d vectors
       IF arg_present(glam) THEN glam = glamt[firstx:lastx, firsty:lasty]
       IF arg_present(gphi) THEN gphi = gphit[firstx:lastx, firsty:lasty]
       IF arg_present(e1) THEN e1 = e1t[firstx:lastx, firsty:lasty]
       IF arg_present(e2) THEN e2 = e2t[firstx:lastx, firsty:lasty]
-;vecteurs 3d
+;3d vectors 
       IF keyword_set(forplt) THEN mask = tmask[firstx:lastx, firsty:lasty, firstz] $
       ELSE IF arg_present(mask) THEN mask = tmask[firstx:lastx, firsty:lasty, firstz:lastz]
     end
 ;------------------------------------------------------------
-; grille U
+; grid U
 ;------------------------------------------------------------
     vargrid eq 'U': begin
-;scalaires
+;scalars
       nx = nxu
       ny = nyu
@@ -129 +179 @@
       lastx = lastxu
       lasty = lastyu
-;vecteurs 2d
+;2d vectors
       IF arg_present(glam) THEN glam = glamu[firstx:lastx, firsty:lasty]
       IF arg_present(gphi) THEN gphi = gphiu[firstx:lastx, firsty:lasty]
@@ -163 +213 @@
       IF arg_present(e1) THEN e1  = e1u[firstx:lastx, firsty:lasty]
       IF arg_present(e2) THEN e2  = e2u[firstx:lastx, firsty:lasty]
-;vecteurs 3d
+;3d vectors
       IF keyword_set(forplt) THEN mask = (umask())[firstx:lastx, firsty:lasty, firstz] $
       ELSE IF arg_present(mask) THEN mask = (umask())[firstx:lastx, firsty:lasty, firstz:lastz]
     end
 ;------------------------------------------------------------
-; grille V
+; grid V
 ;------------------------------------------------------------
     vargrid eq 'OPAPTDHV' or vargrid eq 'OPAPT3DV' $
       or vargrid eq 'V': begin
-;scalaires
+;scalars
       nx = nxv
       ny = nyv
@@ -179 +229 @@
       lastx = lastxv
       lasty = lastyv
-;vecteurs 2d
+;2d vectors
       IF arg_present(glam) THEN glam = glamv[firstx:lastx, firsty:lasty]
       IF arg_present(gphi) THEN gphi = gphiv[firstx:lastx, firsty:lasty]
@@ -213 +263 @@
       IF arg_present(e1) THEN e1  = e1v[firstx:lastx, firsty:lasty]
       IF arg_present(e2) THEN e2  = e2v[firstx:lastx, firsty:lasty]
-;vecteurs 3d
+;3d vecteurs
       IF keyword_set(forplt) THEN mask = (vmask())[firstx:lastx, firsty:lasty, firstz] $
       ELSE IF arg_present(mask) THEN mask = (vmask())[firstx:lastx, firsty:lasty, firstz:lastz]
     end
 ;------------------------------------------------------------
-; grille F
+; grid F
 ;------------------------------------------------------------
     vargrid eq 'OPAPTDHF' or vargrid eq 'OPAPT3DF' $ 
       or vargrid eq 'F': begin
-;scalaires
+;scalars
       nx = nxf
       ny = nyf
@@ -229 +279 @@
       lastx = lastxf
       lasty = lastyf
-;vecteurs 2d
+;2d vectors
       IF arg_present(glam) THEN glam = glamf[firstx:lastx, firsty:lasty]
       IF arg_present(gphi) THEN gphi = gphif[firstx:lastx, firsty:lasty]
@@ -273 +323 @@
       IF arg_present(e1) THEN e1  = e1f[firstx:lastx, firsty:lasty]
       IF arg_present(e2) THEN e2  = e2f[firstx:lastx, firsty:lasty]
-;vecteurs 3d
+;3d vectors 
       IF keyword_set(forplt) THEN mask = (fmask())[firstx:lastx, firsty:lasty, firstz] $
       ELSE IF arg_present(mask) THEN mask = (fmask())[firstx:lastx, firsty:lasty, firstz:lastz]
@@ -289 +339 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-; Variables se rapportant a la dimension verticale
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-;
-;
-  tempdeux = systime(1)         ; pour key_performance =2
+; Variables refering to the vertical dimension
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;
+;
+  tempdeux = systime(1)         ; For key_performance =2
   if keyword_set(wdepth) then begin
     gdep = gdepw[firstz:lastz]
@@ -340 +390 @@
     print, 'temps grille: Variables se rapportant a la dimension verticale ', systime(1)-tempdeux
 ;------------------------------------------------------------
-; vecteur triangulation Qd TRI est active
+; Triangulation vector when TRI is activated.
 ;------------------------------------------------------------
   if arg_present(TRI) then $
@@ -356 +406 @@
   ENDELSE
 ;------------------------------------------------------------------
-; pour s'assurer qu'il n'y a pas de dimension degenerees (=1)
-;-------------------------------------------------------------------
+; To make sure there is not any degenerated dimension (=1)
+;------------------------------------------------------------------
 ;    mask=reform(mask, /over)
 ;    glam=reform(glam, /over)