Changeset 371 for trunk/SRC/Grid


Ignore:
Timestamp:
08/07/08 11:32:02 (16 years ago)
Author:
pinsard
Message:

improvements of headers (alignments of IDL prompt in examples)

Location:
trunk/SRC/Grid
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Grid/changemsk.pro

    r327 r371  
    1818; 
    1919; @examples 
    20 ; IDL> a = changemsk(tmask[*,*,0]) 
     20; 
     21;   IDL> a = changemsk(tmask[*,*,0]) 
     22; 
    2123;  to add ocean points 
    22 ; IDL> a = 1 - changemsk(1 - tmask[*,*,0]) 
     24;   IDL> a = 1 - changemsk(1 - tmask[*,*,0]) 
    2325; 
    2426; @history 

  • trunk/SRC/Grid/computegrid.pro

    r327 r371  
    222222; 
    223223; @uses 
    224 ; cm_4mesh 
    225 ; cm_4data 
    226 ; cm_4cal 
     224; <pro>cm_4mesh</pro> 
     225; <pro>cm_4data</pro> 
     226; <pro>cm_4cal</pro> 
    227227; 
    228228 
    229229; @restrictions 
    230230; if the grid has x/y periodicity overlap and/or if 
    231 ;    the mask has 0 everywhere at the border (like a closed sea) and 
    232 ;    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
    233 ;    ymaxmesh keywords are defined to their default values), we redefine 
    234 ;    xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
    235 ;    overlapping part and/or to open the domain (avoid it be forced 
    236 ;    to use cell_fill = 1). 
     231; the mask has 0 everywhere at the border (like a closed sea) and 
     232; if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
     233; ymaxmesh keywords are defined to their default values), we redefine 
     234; xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
     235; overlapping part and/or to open the domain (avoid it be forced 
     236; to use cell_fill = 1). 
    237237; 
    238238; FUV points definition is not exact if the grid is irregular 
    … …  
    241241; Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    242242;                      2000-04-20 
    243 ;  Sept 2004, several bug fix to suit C grid type... 
    244 ;  Aug 2005, rewritte almost everything... 
     243; Sept 2004, several bug fix to suit C grid type... 
     244; Aug 2005, rewritte almost everything... 
    245245; 
    246246; @version 

  • trunk/SRC/Grid/micromeshmask.pro

    r327 r371  
    5252; 
    5353; @examples 
    54 ; IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    55 ; IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
     54; 
     55;   IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
     56;   IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    5657; 
    5758;- 

  • trunk/SRC/Grid/n128gaussian.pro

    r325 r371  
    99; 
    1010; @examples 
    11 ; IDL> lat=n128gaussian() 
     11; 
     12;   IDL> lat=n128gaussian() 
    1213; 
    1314; @returns 

  • trunk/SRC/Grid/n160gaussian.pro

    r325 r371  
    99; 
    1010; @examples 
    11 ; IDL> lat=n160gaussian() 
     11; 
     12;   IDL> lat=n160gaussian() 
    1213; 
    1314; @returns 

  • trunk/SRC/Grid/n256gaussian.pro

    r325 r371  
    99; 
    1010; @examples 
    11 ; IDL> lat=n256gaussian() 
     11; 
     12;   IDL> lat=n256gaussian() 
    1213; 
    1314; @returns 

  • trunk/SRC/Grid/n48gaussian.pro

    r325 r371  
    99; 
    1010; @examples 
    11 ; IDL> lat=n48gaussian() 
     11; 
     12;   IDL> lat=n48gaussian() 
    1213; 
    1314; @returns 

  • trunk/SRC/Grid/n80gaussian.pro

    r325 r371  
    99; 
    1010; @examples 
    11 ; IDL> lat=n80gaussian() 
     11; 
     12;   IDL> lat=n80gaussian() 
    1213; 
    1314; @returns 

  • trunk/SRC/Grid/ncdf_meshread.pro

    r359 r371  
    88; 
    99; @examples 
    10 ; IDL> ncdf_meshread [,' filename'] 
     10; 
     11;   IDL> ncdf_meshread [,' filename'] 
    1112; 
    1213; @param filename {in}{optional}{default='meshmask.nc'}{type=scalar string} 
    … …  
    5960; 
    6061; @uses 
    61 ; cm_4mesh 
    62 ; cm_4data 
    63 ; cm_4cal 
     62; <pro>cm_4mesh</pro> 
     63; <pro>cm_4data</pro> 
     64; <pro>cm_4cal</pro> 
    6465; 
    6566; @restrictions 

  • trunk/SRC/Grid/ncdf_meshroms.pro

    r327 r371  
    88; 
    99; @examples 
    10 ; IDL> ncdf_meshroms [,' filename'] 
     10; 
     11;   IDL> ncdf_meshroms [,' filename'] 
    1112; 
    1213; @param filename {in}{optional}{default='roms_grd.nc'}{type=scalar string} 
    … …  
    6061; 
    6162; @uses 
    62 ; cm_4mesh 
    63 ; cm_4data 
    64 ; cm_4cal 
     63; <pro>cm_4mesh</pro> 
     64; <pro>cm_4data</pro> 
     65; <pro>cm_4cal</pro> 
    6566; 
    6667; @restrictions 

  • trunk/SRC/Grid/restoreboxparam.pro

    r325 r371  
    99; 
    1010; @uses 
    11 ; cm_4mesh (and cm_demomode_used if we are in demo mode) 
     11; <pro>cm_4mesh</pro> (and <pro>cm_demomode</pro> if we are in demo mode) 
    1212; 
    1313; @restrictions 
    … …  
    1616; 
    1717; @examples 
    18 ; IDL> restoreboxparam, filename 
     18; 
     19;   IDL> restoreboxparam, filename 
    1920; 
    2021; @history 

  • trunk/SRC/Grid/saveboxparam.pro

    r325 r371  
    1010; 
    1111; @uses 
    12 ; cm_4mesh (and cm_demomode_used if we are in demo mode) 
     12; <pro>cm_4mesh</pro> (and <pro>cm_demomode</pro> if we are in demo mode) 
    1313; 
    1414; @restrictions 
    … …  
    1717; 
    1818; @examples 
    19 ; IDL> saveboxparam, filename 
     19; 
     20;   IDL> saveboxparam, filename 
    2021; 
    2122; @history 

  • trunk/SRC/Grid/smallmeshmask.pro

    r327 r371  
    5252; 
    5353; @examples 
    54 ; IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
    55 ; IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
     54; 
     55;   IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/' 
     56;   IDL> smallmeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir 
    5657; 
    5758; @categories 
Note: See TracChangeset for help on using the changeset viewer.