Changeset 142 for trunk/SRC/ToBeReviewed/CALCULS/div.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/div.pro (modified) (14 diffs)

trunk/SRC/ToBeReviewed/CALCULS/div.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:div
-;
-; PURPOSE:calcule la divergence d'un champ 2D
-;
-; CATEGORY:calcule sur les matrices
-;
-; CALLING SEQUENCE:res=div(u,v)
-;
-; INPUTS:
-;       u et v deux matrices representant les coordonnes d''un
-;       champ de vecteur
-;
-; KEYWORD PARAMETERS:
-;
-; OUTPUTS:res: une matrice 2d
-;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-; les matrices u et v peuvent de 2 a 4 dimensions.
-; attention pour distinger les differents configurations de u et v
-; (xy, xyz, xyt, xyzt), on regarde la variable du common 
-;        -time qui contient le calendrier en jour julien d''IDL auquel
-;        se rapportent u et v ansi que la variable 
-;        -jpt qui est le nombre de pas de temps a considerer ds time.
-; les tableaux u et v sont decoupes sur le meme domaine
-; geographique. A cause du decalage des grilles T, U, V et F il est
-; possiible que ces 2 tableaux n''aient pas la meme taille et se
-; repportent a des indices differents. Si tel est le cas les tableaux
-; sont redecoupes sur les indices qu'ils ont en commun et le dommaine
-; est redefinit pour qu'il colle a ces indices communs.
-; pour eviter ces redecoupes utiliser le mot cles /memeindice ds
-; domdef.pro
-;
-; les points sur le bord du dessin sont mis a !values.f_nan
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Guillaume Roullet (grlod@ipsl.jussieu.fr)
+;
+; @file_comments
+; calculation of the divergence of a 2d field
+;
+; @categories
+; Calculation on matrixes
+;
+; @param UU 
+; Matrix representing coordinates of a field of vectors
+;
+; @param VV 
+; Matrix representing coordinates of a field of vectors
+;
+; @returns RES
+; A 2d matrix
+;
+; @uses
+; common.pro
+;
+; @restrictions
+; U and V matrixes can be 2 or 4d.
+; Beware, to discern differents configuration of U and V (xy, xyz, xyt, xyzt), 
+; we look at the variable of the common 
+;        -time which contain the calendar in IDL julian days to which U and 
+; V refered to, in the same way as the variable 
+;        -jpt which is the number of time's step to consider in time.
+; U and V arrays ae cut in the same geographic domain. Because of the gap of 
+; T, U, V and F grids, it is possible that these two arrays hase not the same 
+; size and refered to different indexes. In this case, arrays are recut on 
+; common indexesand the domain is redifined to match with these common 
+; indexes. To avoid these recuts, use the keyword /memeindice in domdef.pro
+;
+;
+; Points on the drawing edge are at !values.f_nan 
+;
+;
+; @history
+; Guillaume Roullet (grlod@ipsl.jussieu.fr)
 ;                      Creation : printemps 1998
 ;                      Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      adaptation pour marcher avec un domaine reduit
-;                      12/1/2000
+;                      12/1/2000;
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -57 +57 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; For key_performance
 @common
 ;
@@ -72 +72 @@
 
 ;------------------------------------------------------------
-; on trouve les points que u et v ont en communs
+; We find common points between U and V
 ;------------------------------------------------------------
    indicexu = (lindgen(jpi))[firstxu:firstxu+nxu-1]
@@ -91 +91 @@
       (size(u))[0] EQ 3 AND date1 EQ date2 :BEGIN 
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of U and V on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -139 +139 @@
           *tmask[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1, firstzt:lastzt]
 ;------------------------------------------------------------
-; mise a !values.f_nan de la bordure
+; Edging put at !values.f_nan
 ;------------------------------------------------------------
          if  NOT keyword_set(key_periodic) OR nx NE jpi then begin
@@ -154 +154 @@
          if terre[0] NE -1 then zdiv[temporary(terre)] = valmask
 ;------------------------------------------------------------
-; pour le trace graphique
+; For the graphic drawing
 ;------------------------------------------------------------
          vargrid = 'T'
@@ -169 +169 @@
       date1 NE date2 AND (size(u))[0] EQ 3 :BEGIN 
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of U and V on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -191 +191 @@
          endcase
 ;------------------------------------------------------------
-; calcul de la divergence
+; Calculation of the divergence
 ;------------------------------------------------------------
          zu = e2u[indice2d]*(umask())[indice2d+jpi*jpj*firstzt]
@@ -213 +213 @@
          zdiv = temporary(zdiv)*(zu-shift(zu, 1, 0, 0)+zv-shift(zv, 0, 1, 0))
 ;------------------------------------------------------------
-; mise a !values.f_nan de la bordure
+; Edging put at !values.f_nan
 ;------------------------------------------------------------
          if  NOT keyword_set(key_periodic) OR nx NE jpi then begin
@@ -225 +225 @@
          if terre[0] NE -1 then zdiv[temporary(terre)] = valmask
 ;------------------------------------------------------------
-; pour le trace graphique
+; for the graphic drawing
 ;------------------------------------------------------------
          vargrid = 'T'
@@ -250 +250 @@
          indice3d = indice3d[indicex[0]:indicex[0]+nx-1,indicey[0]:indicey[0]+ny-1, firstzt]
 ;------------------------------------------------------------
-; extraction de u et v sur le domaine qui convient
+; extraction of U and V on the appropriated domain
 ;------------------------------------------------------------
          case 1 of
@@ -275 +275 @@
          endcase
 ;------------------------------------------------------------
-; calcul de la divergence
+; Calculation of the divergence
 ;------------------------------------------------------------
          zu = temporary(u)*e2u[indice2d]*(umask())[indice3d]
@@ -286 +286 @@
          zdiv = temporary(zdiv)*tmask[indice3d]/(e1t[indice2d]*e2t[indice2d])
 ;------------------------------------------------------------
-; mise a !values.f_nan de la bordure
+; Edging put at !values.f_nan
 ;------------------------------------------------------------
          if  NOT keyword_set(key_periodic) OR nx NE jpi then begin
@@ -301 +301 @@
          if terre[0] NE -1 then zdiv[temporary(terre)] = valmask
 ;------------------------------------------------------------
-; pour le trace graphique
+; for the graphic drawing
 ;------------------------------------------------------------
          vargrid = 'T'