Ignore:
Timestamp:
03/19/07 18:15:51 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers

Location:
trunk/SRC/ToBeReviewed/CALCULS
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/ToBeReviewed/CALCULS/depth2floatlevel.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
     2; 
    53; @file_comments 
    64; Rather comparable to depth2level but here, the calculated level is in float. 
    … …  
    4038; 
    4139;- 
    42 ;------------------------------------------------------------ 
    43 ;------------------------------------------------------------ 
    44 ;------------------------------------------------------------ 
     40; 
    4541FUNCTION depth2floatlevel, tab, NOMASK = nomask 
    4642; 

  • trunk/SRC/ToBeReviewed/CALCULS/depth2level.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    4441; $Id$ 
    4542;- 
    46 ;------------------------------------------------------------ 
    47 ;------------------------------------------------------------ 
    48 ;------------------------------------------------------------ 
     43; 
    4944FUNCTION depth2level, tab, LOWER = lower, UPPER = upper, CLOSER = closer $ 
    5045                      , NOMASK = nomask, _extra = ex 

  • trunk/SRC/ToBeReviewed/CALCULS/depth2mask.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    1512; 
    1613; @keyword _EXTRA 
    17 ; used to pass your keywords 
     14; Used to pass keywords 
    1815; 
    1916; @returns 
    20 ; It is a 3d array containing the mas associated to the 2d sill depth array 
     17; It is a 3d array containing the mask associated to the 2d sill depth array 
    2118; 
    2219; @uses 
    … …  
    3128; 
    3229;- 
    33 ;------------------------------------------------------------ 
    34 ;------------------------------------------------------------ 
    35 ;------------------------------------------------------------ 
    3630FUNCTION depth2mask, tab, _extra = ex 
    37 ;------------------------------------------------------------ 
    3831; 
    3932  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/CALCULS/determ3.pro

    r163 r231  
    2424; defined by in10 = z2ds[1, 0, *] 
    2525; 
    26 ; 
    2726; @param IN11 {in}{required} 
    2827; It is an n element array 
    2928; defined by in11 = z2ds[1, 1, *] 
    30 ; 
    3129; 
    3230; @param IN12 {in}{required} 
    … …  
    3432; defined by in12 = z2ds[1, 2, *] 
    3533; 
    36 ; 
    3734; @param IN20 {in}{required} 
    3835; It is an n element array 
    3936; defined by in20 = z2ds[2, 0, *] 
    40 ; 
    4137; 
    4238; @param IN21 {in}{required} 
    … …  
    4440; defined by in21 = z2ds[2, 1, *] 
    4541; 
    46 ; 
    4742; @param IN22 {in}{required} 
    4843; It is an n element array 
    4944; defined by in22 = z2ds[2, 2, *] 
    5045; 
    51 ; @returns  
     46; @returns 
    5247; n elements array, the determinant of each 3*3 arrays 
    5348; 

  • trunk/SRC/ToBeReviewed/CALCULS/floatlevel2depth.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    63; @file_comments 
    7 ; Rather comparable to level2depth. It is the invert function of depth2floatlevel 
     4; Rather comparable to <pro>level2depth<pro>. 
     5; It is the invert function of <pro>depth2floatlevel</pro>. 
    86; 
    97; @categories 
    … …  
    3634; 
    3735;- 
    38 ;------------------------------------------------------------ 
    39 ;------------------------------------------------------------ 
    40 ;------------------------------------------------------------ 
    4136FUNCTION floatlevel2depth, tab, NOMASK = nomask 
    4237; 

  • trunk/SRC/ToBeReviewed/CALCULS/fsfzpt.pro

    r163 r231  
    22; @file_comments 
    33; 
    4 ; 
    54; @categories 
    6 ; 
    75; 
    86; @param PFS 
    97; 
    10 ; 
    118; @param PFP 
    12 ; 
    139; 
    1410; @returns 
    1511; 
    16 ; 
    1712; @uses 
    18 ; 
    1913; 
    2014; @restrictions 
    2115; 
    22 ; 
    2316; @examples 
    24 ; 
    2517; 
    2618; @history 
    … …  
    4537; 
    4638;- 
     39; 
    4740FUNCTION fsfzpt, pfs, pfp 
    4841; 

  • trunk/SRC/ToBeReviewed/CALCULS/grossemoyenne.pro

    r223 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    8077; $Id$ 
    8178;- 
    82  
     79; 
    8380function grossemoyenne, tab, direc, BOXZOOM = boxzoom, INTEGRATION = integration $ 
    8481                        , NAN = nan, NODOMDEF = nodomdef, WDEPTH = wdepth $ 

  • trunk/SRC/ToBeReviewed/CALCULS/hdyn.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    6865; 
    6966;- 
    70 ;------------------------------------------------------------ 
    71 ;------------------------------------------------------------ 
    72 ;------------------------------------------------------------ 
     67; 
    7368FUNCTION hdyn, tabsn, tabtn, TREF = tref, SREF = sref, PROFREF = profref, LEVEL = level, GILL = gill, SURFACE_LEVEL = surface_level 
    7469; 

  • trunk/SRC/ToBeReviewed/CALCULS/level2depth.pro

    r226 r231  
    1 ; 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    4 ;------------------------------------------------------------ 
    51;+ 
    62; 
    … …  
    3228; 
    3329;- 
    34 ;------------------------------------------------------------ 
    35 ;------------------------------------------------------------ 
    36 ;------------------------------------------------------------ 
     30; 
    3731FUNCTION level2depth, tab, NOMASK = nomask 
    3832; 

  • trunk/SRC/ToBeReviewed/CALCULS/level2index.pro

    r163 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    6 ; @file_comments  
    7 ; We want, from a 3d matrix, to extract a 2d (x,y) array whose each element  
    8 ; has been extract from a level specified by the 2d level array (typically,  
     3; @file_comments 
     4; We want, from a 3d matrix, to extract a 2d (x,y) array whose each element 
     5; has been extract from a level specified by the 2d level array (typically, 
    96; we want to obtain the salinity along an isopycn we have repered by its level). 
    10 ; level2index is a function who give, in function of level, a 2d indexes array  
     7; level2index is a function who give, in function of level, a 2d indexes array 
    118; which will allow to extract the 2d array from the 3d array... 
    129; 
    … …  
    2825; 
    2926;- 
    30 ;------------------------------------------------------------ 
    31 ;------------------------------------------------------------ 
    32 ;------------------------------------------------------------ 
     27; 
    3328FUNCTION level2index, level 
    34 ; An element of 3d array (whose the two first dimensions are nx and ny) whose  
     29; An element of 3d array (whose the two first dimensions are nx and ny) whose 
    3530; coordinates are i, j and k have for index in the same 3d array i + j*nx + k*(nx*ny) 
    3631; level given, for  each point of level, we know i, j et k, 

  • trunk/SRC/ToBeReviewed/CALCULS/level2mask.pro

    r163 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    63; @file_comments 
    7 ; Allow to pass from a 2d sill level array to the 3d mask array with 1s in  
     4; Allow to pass from a 2d sill level array to the 3d mask array with 1s in 
    85; levels above the sill level and 0s below (and on it) 
    96; 
    10 ; @categories  
     7; @categories 
    118; Without loop 
    129; 
    … …  
    3229; 
    3330;- 
    34 ;------------------------------------------------------------ 
    35 ;------------------------------------------------------------ 
    36 ;------------------------------------------------------------ 
     31; 
    3732FUNCTION level2mask, tab 
    38 ;------------------------------------------------------------ 
    3933; 
    4034  compile_opt idl2, strictarrsubs 
    … …  
    6862;------------------------------------------------------------ 
    6963;------------------------------------------------------------ 
    70    if keyword_set(key_performance) THEN print, 'temps level2mask', systime(1)-tempsun  
     64   if keyword_set(key_performance) THEN print, 'temps level2mask', systime(1)-tempsun 
    7165   return, mask 
    7266end 

  • trunk/SRC/ToBeReviewed/CALCULS/moyenne.pro

    r223 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    6764; 
    6865;- 
    69  
     66; 
    7067function moyenne, tab, direc, BOXZOOM = boxzoom, INTEGRATION = integration $ 
    7168                  , NAN = nan, NODOMDEF = nodomdef, WDEPTH = wdepth $ 

  • trunk/SRC/ToBeReviewed/CALCULS/norme.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    129; temporal average because the average of the norm is not equal to the 
    1310; norm of averages 
    14  
    1511; 
    1612; @categories 
    … …  
    4844; a geographic domain on which fields U and V are extracted on same points 
    4945; 
    50 ; @restrictions 
    5146; To know what type of array we work with, we  test its size and dates 
    5247; gave by time[0] and time[jpt-1] to know if thee is a temporal dimension. 
    … …  
    6762; 
    6863;- 
    69 ;------------------------------------------------------------ 
    70 ;------------------------------------------------------------ 
    71 ;------------------------------------------------------------ 
     64; 
    7265FUNCTION norme, composanteu, composantev, BOXZOOM = boxzoom, DIREC = direc, _extra = ex 
    73 ;--------------------------------------------------------- 
    7466; 
    7567  compile_opt idl2, strictarrsubs 

  • trunk/SRC/ToBeReviewed/CALCULS/projectondepth.pro

    r226 r231  
    1 ;------------------------------------------------------------ 
    2 ;------------------------------------------------------------ 
    3 ;------------------------------------------------------------ 
    41;+ 
    52; 
    … …  
    4643; 
    4744;- 
    48 ;------------------------------------------------------------ 
    49 ;------------------------------------------------------------ 
    50 ;------------------------------------------------------------ 
     45; 
    5146FUNCTION projectondepth, arrayin, depthin 
    5247; 

  • trunk/SRC/ToBeReviewed/CALCULS/remplit.pro

    r226 r231  
    22; @file_comments 
    33; 
    4 ; 
    54; @categories 
    65; 
    7 ; 
    86; @param ZINPUT 
    97; 
    10 ; 
    118; @keyword NAN 
    129; 
    13 ; 
    1410; @keyword NITER 
    1511; 
    16 ; 
    1712; @keyword BASIQUE 
    1813; 
    19 ; 
    2014; @keyword MASK 
    2115; 
    22 ; 
    2316; @keyword FILLXDIR 
    2417; 
    25 ; 
    2618; @keyword FILLYDIR 
    2719; 
    28 ; 
    2920; @keyword FILLVAL 
    3021; 
    31 ; 
    3222; @keyword _EXTRA 
    33 ; Used to pass your keywords 
     23; Used to pass keywords 
    3424; 
    3525; @returns 
    3626; 
    37 ; 
    3827; @uses 
    3928; 
    40 ; 
    4129; @restrictions 
    4230; 
    43 ; 
    4431; @examples 
    4532; 
    46 ; 
    4733; @history 
    48 ; 
    4934; 
    5035; @version 
    … …  
    6853; 
    6954;- 
     55; 
    7056FUNCTION remplit, zinput, NAN = nan, NITER = niter, BASIQUE = basique, mask = mask, FILLXDIR = fillxdir, FILLYDIR = fillydir, FILLVAL = fillval, _extra = ex 
    7157; 

  • trunk/SRC/ToBeReviewed/CALCULS/rhon.pro

    r163 r231  
    22; @file_comments 
    33; 
    4 ; 
    54; @categories 
    6 ; 
    75; 
    86; @param SN 
    97; 
    10 ; 
    118; @param TN 
    12 ; 
    139; 
    1410; @keyword INSITU 
    1511; 
    16 ; 
    1712; @keyword SIGMA_N 
    18 ; 
    1913; 
    2014; @returns 
    2115; 
    22 ; 
    2316; @uses 
    24 ; 
    2517; 
    2618; @restrictions 
    2719; 
    28 ; 
    2920; @examples 
    3021; 
    31 ; 
    3222; @history 
    33 ; 
    3423; 
    3524; @version 
    3625; $Id$ 
    3726; 
    38    ;; 
    39    ;; Calcul de la fonction d'etat (issue de eos.F) 
    40    ;; 
    41    ;; Creation : 1997 / G. Roullet 
    42    ;; adaptation pour les tableaux z,zt,xyz,xyzt 
    43    ;; par seb. 
    44    ;; 
    45 ; 
     27;; 
     28;; Calcul de la fonction d'etat (issue de eos.F) 
     29;; 
     30;; Creation : 1997 / G. Roullet 
     31;; adaptation pour les tableaux z,zt,xyz,xyzt 
     32;; par seb. 
     33;; 
    4634; @todo seb 
    4735; 
    4836;- 
     37; 
    4938FUNCTION rhon, sn, tn, INSITU = insitu, SIGMA_N = sigma_n 
    5039; 
    … …  
    6453         zrhop=0d 
    6554         jkmax = 1 
    66       END  
     55      END 
    6756      1:BEGIN                   ;z 
    6857         zrhop=dblarr(taille[1]) 
    6958         jkmax = taille[1] 
    70       END  
     59      END 
    7160      2:BEGIN                   ;xy (jpt=1) ou zt 
    7261         zrhop=dblarr(taille[1],taille[2]) 
    7362         if jpt EQ 1 then jkmax = 1 ELSE jkmax = taille[1] 
    74       END  
     63      END 
    7564      3:BEGIN                   ;xyz (jpt=1) ou xyt 
    7665         zrhop=dblarr(taille[1],taille[2],taille[3]) 
    7766         if jpt EQ 1 then jkmax = taille[3] ELSE jkmax = 1 
    78       END  
     67      END 
    7968      4:BEGIN                   ;xyzt 
    8069         zrhop=dblarr(taille[1],taille[2],taille[3],taille[4] ) 
    8170         jkmax = taille[3] 
    82       END  
     71      END 
    8372   endcase 
    84     
     73 
    8574 
    8675 
    … …  
    9180            ztt = tn 
    9281            zs = sn 
    93          END  
     82         END 
    9483         1:BEGIN                ;z 
    9584            ztt = tn[jk] 
    96             zs = sn[jk]  
    97          END  
     85            zs = sn[jk] 
     86         END 
    9887         2:BEGIN                ;xy (jpt=1) ou zt 
    9988            if jpt EQ 1 then begin 
    … …  
    10291            ENDIF ELSE BEGIN 
    10392               ztt = tn[jk, *] 
    104                zs = sn[jk, *]  
     93               zs = sn[jk, *] 
    10594            ENDELSE 
    106          END  
     95         END 
    10796         3:BEGIN                ;xyz (jpt=1) ou xyt 
    10897            if jpt EQ 1 then begin 
    10998               ztt = tn[*, *, jk] 
    110                zs = sn[*, *,jk]  
     99               zs = sn[*, *,jk] 
    111100            endif ELSE BEGIN 
    112101               ztt = tn 
    113102               zs = sn 
    114103            ENDELSE 
    115          END  
     104         END 
    116105         4:BEGIN                ;xyzt 
    117106            ztt = tn[*, *, jk, *] 
    118             zs = sn[*, *,jk, *]  
    119          END  
     107            zs = sn[*, *,jk, *] 
     108         END 
    120109      endcase 
    121110      if n_elements(sigma_n) NE 0 then zh = 1000.*sigma_n ELSE zh = gdept[jk] 
    … …  
    133122         0: zrhop    = (zr4*zs + zr3*zsr + zr2)*zs + zr1 
    134123         1: zrhop[jk]= (zr4*zs + zr3*zsr + zr2)*zs + zr1 
    135          2:BEGIN  
     124         2:BEGIN 
    136125            if jpt EQ 1 then zrhop = (zr4*zs + zr3*zsr + zr2)*zs + zr1 $ 
    137126            ELSE zrhop[jk, *]= (zr4*zs + zr3*zsr + zr2)*zs + zr1 
    138127         END 
    139          3:BEGIN  
     128         3:BEGIN 
    140129            if jpt EQ 1 then zrhop[*, *,jk]= (zr4*zs + zr3*zsr + zr2)*zs + zr1 $ 
    141130             ELSE zrhop = (zr4*zs + zr3*zsr + zr2)*zs + zr1 
    … …  
    144133      endcase 
    145134 
    146       IF n_elements(insitu) EQ 1 THEN BEGIN  
     135      IF n_elements(insitu) EQ 1 THEN BEGIN 
    147136; ...   add the compression terms 
    148137         ze = (-3.508914e-8*ztt-1.248266e-8)*ztt-2.595994e-6 
    … …  
    164153            0: zrhop = zrhop / (1.0-zh/(zk0-zh*(za-zh*zb))) 
    165154            1: zrhop[jk] = zrhop[jk] / (1.0-zh/(zk0-zh*(za-zh*zb))) 
    166             2:BEGIN  
     155            2:BEGIN 
    167156               if jpt EQ 1 then zrhop = zrhop / (1.0-zh/(zk0-zh*(za-zh*zb))) $ 
    168157               ELSE zrhop[jk, *] = zrhop[jk, *] / (1.0-zh/(zk0-zh*(za-zh*zb))) 
    169158            END 
    170             3:BEGIN  
     159            3:BEGIN 
    171160               if jpt EQ 1 then zrhop[*, *,jk] = zrhop[*, *,jk] / (1.0-zh/(zk0-zh*(za-zh*zb))) $ 
    172161               ELSE zrhop = zrhop / (1.0-zh/(zk0-zh*(za-zh*zb))) 
    … …  
    174163            4: zrhop[*, *,jk, *] = zrhop[*, *,jk, *] / (1.0-zh/(zk0-zh*(za-zh*zb))) 
    175164         endcase 
    176           
    177       ENDIF  
    178    ENDFOR  
    179     
     165 
     166      ENDIF 
     167   ENDFOR 
     168 
    180169   terre = where(tn GE 1e6) 
    181170   if terre[0] NE -1 then zrhop[terre] = valmask 
    182171 
    183    if keyword_set(key_performance) THEN print, 'temps rhon', systime(1)-tempsun  
    184  
    185     
    186    return, zrhop 
    187 END  
     172   if keyword_set(key_performance) THEN print, 'temps rhon', systime(1)-tempsun 
    188173 
    189174 
     175   return, zrhop 
     176END 
Note: See TracChangeset for help on using the changeset viewer.