Ignore:
Timestamp:
09/22/06 17:49:59 (18 years ago)
Author:
smasson
Message:

update doc and rm old pages

Location:
trunk/SRC/Documentation/idldoc_assistant_output
Files:
2 added
1 deleted
20 edited

Legend:

Unmodified
Added
Removed

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/computegrid.html

    r187 r195  
    6666 
    6767 domains sizes: 
     68 --------------- 
     69 jpi, jpj, jpk, jpiglo, jpjglo, jpkglo, jpidta, jpjdta, jpkdta 
     70 
     71 domains positions regarding to the original grid: 
     72 -------------------------------------------------- 
     73 ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh 
     74 ixmindta, ixmaxdta, iymindta, iymaxdta, izmindta, izmaxdta 
     75 
     76 horizontal parameters: 
     77 ---------------------- 
     78 glamt, glamf, gphit, gphit, e1t, e2t 
     79 
     80 additional horizontal parameters if FULLCGRID keyword is defined: 
     81 ----------------------------------------------------------------- 
     82 glamu, glamv, gphiu, gphiv, e1u, e1v, e1f, e2u, e2v, e2f 
     83 
     84 verticals parameters: 
     85 --------------------- 
     86 gdept, gdepw, e3t, e3w 
     87 
     88 masks: 
     89 ------ 
     90 tmask 
     91 
     92 additional masks if FULLCGRID keyword is defined: 
     93 ------------------------------------------------- 
     94 umaskred, vmaskred, fmaskredx, fmaskredy 
     95 
     96 triangles_list: 
     97 --------------- 
     98 triangulation 
     99 
     100 key_* variables: 
     101 ---------------- 
     102 key_onearth, key_periodic, key_shift, key_stride, key_partialstep, 
     103 key_yreverse, key_zreverse, key_gridtype 
     104 
     105 xxx related variables: 
     106 ---------------------- 
     107 ccmeshparameters, ccreadparameters 
     108 
    68109 
    69110     
    … …  
    72113      <a name="#_computegrid"></a> 
    73114 
    74       <h2>computegrid  </h2> 
    75  
    76       <p><font face="Courier">computegrid<i>, <a href="#_computegrid_keyword_startx">startx</a>, <a href="#_computegrid_keyword_starty">starty</a>, <a href="#_computegrid_keyword_stepxin">stepxin</a>, <a href="#_computegrid_keyword_stepyin">stepyin</a>, <a href="#_computegrid_keyword_nxin">nxin</a>, <a href="#_computegrid_keyword_nyin">nyin</a></i>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<i>XAXIS</i>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<i>YAXIS</i>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<i>ZAXIS</i>, <a href="#_computegrid_keyword_MASK">MASK</a>=<i>MASK</i>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>GLAMBOUNDARY</i>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<i>XMINMESH</i>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<i>XMAXMESH</i>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<i>YMINMESH</i>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<i>YMAXMESH</i>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<i>ZMINMESH</i>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<i>ZMAXMESH</i>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<i>ONEARTH</i>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<i>PERIODIC</i>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<i>PLAIN</i>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<i>SHIFT</i>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<i>STRIDE</i>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<i>FULLCGRID</i>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<i>STRCALLING</i>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<i>ROMSH</i>, <a href="#_computegrid_keyword__extra">_extra</a>=<i>_extra</i></font></p> 
     115      <h2>computegrid  <font size="-1" color="#006633">  
     116 Grid 
     117</font></h2> 
     118 
     119      <p><font face="Courier">computegrid<i>[, <a href="#_computegrid_keyword_startx">startx</a>][, <a href="#_computegrid_keyword_starty">starty</a>][, <a href="#_computegrid_keyword_stepxin">stepxin</a>][, <a href="#_computegrid_keyword_stepyin">stepyin</a>][, <a href="#_computegrid_keyword_nxin">nxin</a>][, <a href="#_computegrid_keyword_nyin">nyin</a>]</i>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<i>1D or 2D array</i>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<i>1D or 2D array</i>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<i>1D</i>, <a href="#_computegrid_keyword_MASK">MASK</a>=<i>2D or 3D array</i>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>2 elements vector</i>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<i>scalar</i>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<i>3 elements vector</i>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<i>scalar string</i>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<i>2D array</i>, <a href="#_computegrid_keyword__extra">_extra</a>=<i>_extra</i></font></p> 
    77120 
    78121     
    … …  
    87130    <a name="#_computegrid_keyword_startx"></a> 
    88131    <h4>startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    89        
    90        
    91        
    92        
    93        
    94        
    95        
    96        
    97     </h4> 
    98  
    99      
     132      <font size="-1" color="#006633">in</font> 
     133       
     134      <font size="-1" color="#006633">optional</font> 
     135       
     136       
     137      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     138       
     139       
     140    </h4> 
     141 
     142     
     143       x starting point, optional if [XY]AXIS keyword is used 
     144 
    100145     
    101146 
    102147    <a name="#_computegrid_keyword_starty"></a> 
    103148    <h4>starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    104        
    105        
    106        
    107        
    108        
    109        
    110        
    111        
    112     </h4> 
    113  
    114      
     149      <font size="-1" color="#006633">in</font> 
     150       
     151      <font size="-1" color="#006633">optional</font> 
     152       
     153       
     154      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     155       
     156       
     157    </h4> 
     158 
     159     
     160       y starting point, optional if [XY]AXIS keyword is used 
     161 
    115162     
    116163 
    117164    <a name="#_computegrid_keyword_stepxin"></a> 
    118165    <h4>stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    119        
    120        
    121        
    122        
    123        
    124        
    125        
    126        
    127     </h4> 
    128  
    129      
     166      <font size="-1" color="#006633">in</font> 
     167       
     168      <font size="-1" color="#006633">optional</font> 
     169       
     170       
     171      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar or vector</i></font> 
     172       
     173       
     174    </h4> 
     175 
     176     
     177       x direction step, optional if [XY]AXIS keyword is used, must be > 0 
     178       if stepxin is a vector nx is not used 
     179 
    130180     
    131181 
    132182    <a name="#_computegrid_keyword_stepyin"></a> 
    133183    <h4>stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    134        
    135        
    136        
    137        
    138        
    139        
    140        
    141        
    142     </h4> 
    143  
    144      
     184      <font size="-1" color="#006633">in</font> 
     185       
     186      <font size="-1" color="#006633">optional</font> 
     187       
     188       
     189      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar or vector</i></font> 
     190       
     191       
     192    </h4> 
     193 
     194     
     195       y direction step, optional if [XY]AXIS keyword is used, 
     196       could be > 0 (south to north) or < 0 (north to south) 
     197       if stepyin is a vector ny is not used 
     198 
    145199     
    146200 
    147201    <a name="#_computegrid_keyword_nxin"></a> 
    148202    <h4>nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    149        
    150        
    151        
    152        
    153        
    154        
    155        
    156        
    157     </h4> 
    158  
    159      
     203      <font size="-1" color="#006633">in</font> 
     204       
     205      <font size="-1" color="#006633">optional</font> 
     206       
     207       
     208      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     209       
     210       
     211    </h4> 
     212 
     213     
     214       number of points in x direction, 
     215       optional if [XY]AXIS keyword is used or stepxin is a vector 
     216 
    160217     
    161218 
    162219    <a name="#_computegrid_keyword_nyin"></a> 
    163220    <h4>nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    164        
    165        
    166        
    167        
    168        
    169        
    170        
    171        
    172     </h4> 
    173  
    174      
     221      <font size="-1" color="#006633">in</font> 
     222       
     223      <font size="-1" color="#006633">optional</font> 
     224       
     225       
     226      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     227       
     228       
     229    </h4> 
     230 
     231      
     232       number of points in y direction, 
     233       optional if [XY]AXIS keyword is used or stepyin is a vector 
     234 
    175235     
    176236     
    … …  
    187247       
    188248       
    189        
    190        
    191        
    192     </h4> 
    193  
    194      
     249      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font> 
     250       
     251       
     252    </h4> 
     253 
     254     
     255       Specify longitudes in this case startx, stepx and nx are not used but 
     256       could be necessary if the y axis is not defined with yaxis. It must be 
     257       possible to sort the first line of xaxis in the increasing order by 
     258       shifting its elements. 
     259 
    195260     
    196261    <a name="#_computegrid_keyword_YAXIS"></a> 
    … …  
    201266       
    202267       
    203        
    204        
    205        
    206     </h4> 
    207  
    208      
     268      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font> 
     269       
     270       
     271    </h4> 
     272 
     273     
     274       Specify latitudes in this case starty, stepy and ny are not used but 
     275       starty and stepy could be necessary if the x axis is not defined with 
     276       xaxis. It must be sorted in the increasing or deceasing order (along each column if 2d array). 
     277 
    209278     
    210279    <a name="#_computegrid_keyword_ZAXIS"></a> 
    … …  
    215284       
    216285       
    217        
    218        
    219        
    220     </h4> 
    221  
    222      
     286      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D</i></font> 
     287       
     288       
     289    </h4> 
     290 
     291     
     292       Specify the vertical axis. Must be sorted in the increasing or deceasing order 
     293 
    223294     
    224295    <a name="#_computegrid_keyword_MASK"></a> 
    … …  
    229300       
    230301       
    231        
    232        
    233        
    234     </h4> 
    235  
    236      
     302      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D or 3D array</i></font> 
     303      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>array of 1</i></font> 
     304       
     305    </h4> 
     306 
     307     
     308       Specify the land(0)/sea(1) mask 
     309 
    237310     
    238311    <a name="#_computegrid_keyword_GLAMBOUNDARY"></a> 
    … …  
    243316       
    244317       
    245        
    246        
    247        
    248     </h4> 
    249  
    250      
     318      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font> 
     319      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>those defined in the file</i></font> 
     320       
     321    </h4> 
     322 
     323     
     324       Longitude boundaries that should be used to visualize the data. 
     325         lon2 > lon1 
     326         lon2 - lon1 le 360 
     327       By default, the common (cm_4mesh) variable key_shift will be automatically 
     328       defined according to GLAMBOUNDARY. 
     329 
    251330     
    252331    <a name="#_computegrid_keyword_XMINMESH"></a> 
    … …  
    257336       
    258337       
    259        
    260        
    261        
    262     </h4> 
    263  
    264      
     338      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     339      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     340       
     341    </h4> 
     342 
     343     
     344       Define common (cm_4mesh) variables ixminmesh used to define the localization 
     345       of the first point of the grid along the x direction in a zoom of the original grid 
     346 
    265347     
    266348    <a name="#_computegrid_keyword_XMAXMESH"></a> 
    … …  
    271353       
    272354       
    273        
    274        
    275        
    276     </h4> 
    277  
    278      
     355      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     356      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font> 
     357       
     358    </h4> 
     359 
     360     
     361       Define common (cm_4mesh) variables ixmaxmesh used to define the localization 
     362       of the last point of the grid along the x direction in a zoom of the original grid 
     363       Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh 
     364 
    279365     
    280366    <a name="#_computegrid_keyword_YMINMESH"></a> 
    … …  
    285371       
    286372       
    287        
    288        
    289        
    290     </h4> 
    291  
    292      
     373      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     374      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     375       
     376    </h4> 
     377 
     378     
     379       Define common (cm_4mesh) variables iyminmesh used to define the localization 
     380       of the first point of the grid along the y direction in a zoom of the original grid 
     381 
    293382     
    294383    <a name="#_computegrid_keyword_YMAXMESH"></a> 
    … …  
    299388       
    300389       
    301        
    302        
    303        
    304     </h4> 
    305  
    306      
     390      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     391      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font> 
     392       
     393    </h4> 
     394 
     395     
     396       Define common (cm_4mesh) variables iymaxmesh used to define the localization 
     397       of the last point of the grid along the y direction in a zoom of the original grid 
     398       Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh 
     399 
    307400     
    308401    <a name="#_computegrid_keyword_ZMINMESH"></a> 
    … …  
    313406       
    314407       
    315        
    316        
    317        
    318     </h4> 
    319  
    320      
     408      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     409      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font> 
     410       
     411    </h4> 
     412 
     413     
     414       Define common (cm_4mesh) variables izminmesh used to define the localization 
     415       of the first point of the grid along the z direction in a zoom of the original grid 
     416 
    321417     
    322418    <a name="#_computegrid_keyword_ZMAXMESH"></a> 
    … …  
    327423       
    328424       
    329        
    330        
    331        
    332     </h4> 
    333  
    334      
     425      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     426      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpkglo-1</i></font> 
     427       
     428    </h4> 
     429 
     430     
     431       Define common (cm_4mesh) variables izmaxmesh used to define the localization 
     432       of the last point of the grid along the z direction in a zoom of the original grid 
     433       Note that if ZMAXMESH < 0 then izmaxmesh is defined as izmaxmesh = jpkglo -1 + maxmesh 
     434 
    335435     
    336436    <a name="#_computegrid_keyword_ONEARTH"></a> 
    … …  
    341441       
    342442       
    343        
    344        
    345        
    346     </h4> 
    347  
    348      
     443      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     444      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font> 
     445       
     446    </h4> 
     447 
     448     
     449       Force the manual definition of data localization on the earth or not 
     450          0) if the data are not on the earth 
     451          1) if the data are on earth (in that case we can for example use 
     452             the labels 'longitude', 'latitude' in plots). 
     453       The resulting value will be stored in the common (cm_4mesh) variable key_onearth 
     454       ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY 
     455 
    349456     
    350457    <a name="#_computegrid_keyword_PERIODIC"></a> 
    … …  
    355462       
    356463       
    357        
    358        
    359        
    360     </h4> 
    361  
    362      
     464      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     465      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed by using the first line of glamt</i></font> 
     466       
     467    </h4> 
     468 
     469     
     470       Force the manual definition of the grid zonal periodicity. 
     471       The resulting value will be stored in the common (cm_4mesh) variable key_periodic 
     472       PERIODIC = 0 forces SHIFT = 0 
     473 
    363474     
    364475    <a name="#_computegrid_keyword_PLAIN"></a> 
    … …  
    369480       
    370481       
    371        
    372        
    373        
    374     </h4> 
    375  
    376      
     482      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     483      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     484       
     485    </h4> 
     486 
     487     
     488       Force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
     489       suppress the automatic redefinition of the domain in case of 
     490       x periodicity overlap, y periodicity overlap (ORCA type only) 
     491       and mask border to 0. 
     492 
    377493     
    378494    <a name="#_computegrid_keyword_SHIFT"></a> 
    … …  
    383499       
    384500       
    385        
    386        
    387        
    388     </h4> 
    389  
    390      
     501      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font> 
     502      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font> 
     503       
     504    </h4> 
     505 
     506     
     507       Force the manual definition of the zonal shift that must be apply to the data.  
     508       The resulting value will be stored in the common (cm_4mesh) variable key_shift 
     509       Note that if key_periodic=0 then in any case key_shift = 0. 
     510 
    391511     
    392512    <a name="#_computegrid_keyword_STRIDE"></a> 
    … …  
    397517       
    398518       
    399        
    400        
    401        
    402     </h4> 
    403  
    404      
     519      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font> 
     520      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font> 
     521       
     522    </h4> 
     523 
     524     
     525       Specify the stride in x, y and z direction. The resulting 
     526       value will be stored in the common (cm_4mesh) variable key_stride 
     527 
    405528     
    406529    <a name="#_computegrid_keyword_FULLCGRID"></a> 
    … …  
    411534       
    412535       
    413        
    414        
    415        
    416     </h4> 
    417  
    418      
     536      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     537      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     538       
     539    </h4> 
     540 
     541     
     542       Activate to specify that you want to compute all the C grid parameters: 
     543       definition of glam[uv], gphi[uv], e1[uvf], e2[uvf], [uv]maskred and 
     544       fmaskred[xy] will be add to the default computations 
     545 
    419546     
    420547    <a name="#_computegrid_keyword_XYINDEX"></a> 
    … …  
    430557    </h4> 
    431558 
    432      
     559     activate to specify that the horizontal grid should 
     560       be simply defined by using the index of the points 
     561          (xaxis = findgen(nx) and yaxis = findgen(ny)) 
     562       using this keyword forces key_onearth=0 
     563 
    433564     
    434565    <a name="#_computegrid_keyword_FBASE2TBASE"></a> 
    … …  
    445576 
    446577     
     578       Activate when the model is a C grid based on a F point 
     579       (with a F point at the bottom-left corner and a T point at the 
     580       upper-right corner). In this case, we ignore  
     581         - the first line of F and U points 
     582         - the first column of F and V points 
     583         - the last line of T and U points 
     584         - the last column of T and V points. 
     585      => we are back to a C grid based on T point as for OPA model. 
     586 
    447587     
    448588    <a name="#_computegrid_keyword_STRCALLING"></a> 
    … …  
    453593       
    454594       
    455        
    456        
    457        
    458     </h4> 
    459  
    460      
     595      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font> 
     596       
     597       
     598    </h4> 
     599 
     600     
     601       a string containing the calling command used to 
     602       call computegrid (this is used by xxx.pro) 
     603 
     604 
     605       Used by xxx... 
     606 
    461607     
    462608    <a name="#_computegrid_keyword_ROMSH"></a> 
    … …  
    467613       
    468614       
    469        
    470        
    471        
    472     </h4> 
    473  
    474      
     615      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D array</i></font> 
     616       
     617       
     618    </h4> 
     619 
     620     
     621       This array is the final bathymetry at RHO-points. It is stored in the common 
     622       variable (cm_4mesh) romszinfos.h 
     623       Used when the model is a ROMS C-grid with one more point 
     624       in longitude for T and V grid and one more point in latitude 
     625       for T and U grid. In this case, we ignore  
     626         - the last line of T and U points 
     627         - the last column of T and V points. 
     628      => we are back to a C grid based on T point as for OPA model. 
     629       Note that activate ROMSH forces FULLCGRID=1 
     630 
    475631     
    476632    <a name="#_computegrid_keyword__extra"></a> 
    … …  
    486642    </h4> 
    487643 
    488      
    489      
    490      
    491  
    492      
    493      
    494      
    495      
    496      
    497      
    498  
    499      
    500      
    501      
    502      
    503      
    504  
    505      
    506      
    507      
    508      
     644      
     645    (not used in the present case...) 
     646 
     647     
     648     
     649 
     650     
     651    <h3>Version history</h3> 
     652     
     653    <h4>Version</h4> $Id: computegrid.pro 192 2006-09-22 09:37:08Z smasson $ 
     654 
     655    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     656                      2000-04-20 
     657  Sept 2004, several bug fixs to suit C grid type... 
     658  Aug 2005, rewritte almost everything... 
     659 
     660     
     661 
     662    <h3>Known issues</h3> 
     663     
     664     
     665     
     666    <h4>Restrictions</h4> if the grid has x/y periodicity orverlap and/or if 
     667    the mask has 0 everywhere at the border (like a close sea) and 
     668    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
     669    ymaxmesh keywords are defined to their default values), we redefine 
     670    xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
     671    overlapping part and/or to open the domain (avoid ti be forced 
     672    to use cell_fill = 1). 
     673 
     674 FUV points definition is not exact if the grid is irregular 
     675 
     676 
     677    <h3>Other attributes</h3> 
     678     
     679     
     680    <h4>Uses routines</h4> cm_4mesh cm_4data cm_4cal 
     681 
    509682     
    510683     

  • trunk/SRC/Documentation/idldoc_assistant_output/Grid/romsdepth.html

    r187 r195  
    9191     
    9292    <h4>Version</h4> 
    93  $Id: romsdepth.pro 172 2006-09-11 07:11:26Z smasson $ 
     93 $Id: romsdepth.pro 192 2006-09-22 09:37:08Z smasson $ 
    9494    <h4>History</h4>  
    9595 Sept 2006 Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/Obsolete/directory-overview.html

    r191 r195  
    4040        <li><a href="nlecsaison.html" target="file_frame">nlecsaison.pro</a></li> 
    4141        <li><a href="nlecserie.html" target="file_frame">nlecserie.pro</a></li> 
     42        <li><a href="strrepl.html" target="file_frame">strrepl.pro</a></li> 
    4243        <li><a href="vairdate.html" target="file_frame">vairdate.pro</a></li> 
    4344        <li><a href="vraidate.html" target="file_frame">vraidate.pro</a></li> 
    … …  
    4546      </ul> 
    4647 
    47       <div id="tagline">22 files</div> 
     48      <div id="tagline">23 files</div> 
    4849       
    4950 

  • trunk/SRC/Documentation/idldoc_assistant_output/Obsolete/nlecserie.html

    r187 r195  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="vairdate.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
     52<a href="strrepl.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Obsolete/vairdate.html

    r187 r195  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="nlecserie.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="strrepl.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/INIT/initncdf.html

    r187 r195  
    310310     
    311311    <h4>Version</h4> 
    312  $Id: initncdf.pro 172 2006-09-11 07:11:26Z smasson $ 
     312 $Id: initncdf.pro 192 2006-09-22 09:37:08Z smasson $ 
    313313 
    314314    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/LECTURE/read_ncdf.html

    r187 r195  
    8080 </font></h2> 
    8181 
    82       <p><font face="Courier"><i>result = </i>read_ncdf(<i><a href="#_read_ncdf_keyword_name">name</a>, <a href="#_read_ncdf_keyword_beginning">beginning</a>, <a href="#_read_ncdf_keyword_ending">ending</a>[, <a href="#_read_ncdf_keyword_compatibility">compatibility</a>]</i>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<i>PARENTIN</i>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<i>string</i>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<i>CONT_NOFILL</i>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_HFILENAME">HFILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
     82      <p><font face="Courier"><i>result = </i>read_ncdf(<i><a href="#_read_ncdf_keyword_name">name</a>, <a href="#_read_ncdf_keyword_beginning">beginning</a>, <a href="#_read_ncdf_keyword_ending">ending</a>[, <a href="#_read_ncdf_keyword_compatibility">compatibility</a>]</i>, <a href="#_read_ncdf_keyword_BOXZOOM">BOXZOOM</a>=<i>BOXZOOM</i>, <a href="#_read_ncdf_keyword_FILENAME">FILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_PARENTIN">PARENTIN</a>=<i>PARENTIN</i>, <a href="#_read_ncdf_keyword_TIMESTEP">TIMESTEP</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_TIMEVAR">TIMEVAR</a>=<i>string</i>, <a href="#_read_ncdf_keyword_TOUT">TOUT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_NOSTRUCT">NOSTRUCT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_CONT_NOFILL">CONT_NOFILL</a>=<i>CONT_NOFILL</i>, <a href="#_read_ncdf_keyword_INIT">INIT</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_GRID">GRID</a>=<i>GRID</i>, <a href="#_read_ncdf_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_read_ncdf_keyword_CALLITSELF">CALLITSELF</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword_ZETAFILENAME">ZETAFILENAME</a>=<i>string</i>, <a href="#_read_ncdf_keyword_ZETAZERO">ZETAZERO</a>=<i>scalar: 0 or 1</i>, <a href="#_read_ncdf_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    8383 
    8484     
    … …  
    367367  
    368368     
    369     <a name="#_read_ncdf_keyword_HFILENAME"></a> 
    370     <h4>HFILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     369    <a name="#_read_ncdf_keyword_ZETAFILENAME"></a> 
     370    <h4>ZETAFILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    371371       
    372372       
    … …  
    380380 
    381381     
    382  For ROMS outputs. The filename of the file where h vriable should be read 
    383  
    384      
    385     <a name="#_read_ncdf_keyword_ZETAFILENAME"></a> 
    386     <h4>ZETAFILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    387        
    388        
    389        
    390        
    391        
    392       <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font> 
    393       <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>FILENAME</i></font> 
    394        
    395     </h4> 
    396  
    397      
    398382 For ROMS outputs. The filename of the file where zeta vriable should be read 
    399383 
    … …  
    437421     
    438422    <h4>Version</h4> 
    439  $Id: read_ncdf.pro 181 2006-09-15 08:24:36Z smasson $  
     423 $Id: read_ncdf.pro 192 2006-09-22 09:37:08Z smasson $  
    440424    <h4>History</h4> 
    441425 Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/DESSINE/pltt.html

    r187 r195  
    738738     
    739739    <h4>Version</h4>  
    740  $Id: pltt.pro 172 2006-09-11 07:11:26Z smasson $ 
     740 $Id: pltt.pro 192 2006-09-22 09:37:08Z smasson $ 
    741741 
    742742    <h4>History</h4>  

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/directory-overview.html

    r191 r195  
    3232        <li><a href="string2struct.html" target="file_frame">string2struct.pro</a></li> 
    3333        <li><a href="strkeywd.html" target="file_frame">strkeywd.pro</a></li> 
    34         <li><a href="strrepl.html" target="file_frame">strrepl.pro</a></li> 
    3534        <li><a href="strright.html" target="file_frame">strright.pro</a></li> 
    3635        <li><a href="strsci.html" target="file_frame">strsci.pro</a></li> 
     36        <li><a href="strsed.html" target="file_frame">strsed.pro</a></li> 
    3737        <li><a href="strtok.html" target="file_frame">strtok.pro</a></li> 
    3838        <li><a href="strwhere.html" target="file_frame">strwhere.pro</a></li> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/getfile.html

    r187 r195  
    195195     
    196196    <h4>Version</h4> 
    197  $Id: getfile.pro 163 2006-08-29 12:59:46Z navarro $ 
     197 $Id: getfile.pro 192 2006-09-22 09:37:08Z smasson $ 
    198198 
    199199    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strkeywd.html

    r187 r195  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="strrepl.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> 
     52<a href="strright.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strright.html

    r187 r195  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="strrepl.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="strkeywd.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strsci.html

    r187 r195  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href="strtok.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> 
     52<a href="strsed.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strtok.html

    r187 r195  
    4646  <tr> 
    4747    <td width="10%"> 
    48 <a href="strsci.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> 
     48<a href="strsed.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> 
    4949    <td width="80%" align="center" valign="center"> 
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/TRIANGULATION/ciseauxtri.html

    r187 r195  
    7676</font></h2> 
    7777 
    78       <p><font face="Courier"><i>result = </i>ciseauxtri(<i><a href="#_ciseauxtri_keyword_triang">triang</a>, <a href="#_ciseauxtri_keyword_glam">glam</a>, <a href="#_ciseauxtri_keyword_gphi">gphi</a></i>, <a href="#_ciseauxtri_keyword_ALL">ALL</a>=<i>ALL</i>, <a href="#_ciseauxtri_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
     78      <p><font face="Courier"><i>result = </i>ciseauxtri(<i><a href="#_ciseauxtri_keyword_triang">triang</a>, <a href="#_ciseauxtri_keyword_glam">glam</a>, <a href="#_ciseauxtri_keyword_gphi">gphi</a></i>, <a href="#_ciseauxtri_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7979 
    8080     
    … …  
    131131 
    132132      
    133  
     133  
    134134     
    135135     
    … …  
    138138    <h3>Keywords</h3> 
    139139 
    140      
    141     <a name="#_ciseauxtri_keyword_ALL"></a> 
    142     <h4>ALL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    143        
    144        
    145        
    146        
    147        
    148        
    149        
    150        
    151     </h4> 
    152  
    153      
    154   
    155140     
    156141    <a name="#_ciseauxtri_keyword__EXTRA"></a> 
    … …  
    176161     
    177162    <h4>Version</h4> 
    178  $Id: ciseauxtri.pro 163 2006-08-29 12:59:46Z navarro $ 
     163 $Id: ciseauxtri.pro 192 2006-09-22 09:37:08Z smasson $ 
    179164  
    180165    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/cutcmd.html

    r187 r195  
    197197     
    198198    <h4>Version</h4>  
    199  $Id: cutcmd.pro 150 2006-08-09 10:12:54Z navarro $ 
     199 $Id: cutcmd.pro 192 2006-09-22 09:37:08Z smasson $ 
    200200  
    201201    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/AUTOUR_de_XXX/loadgrid.html

    r187 r195  
    132132     
    133133    <h4>Version</h4>  
    134  $Id: loadgrid.pro 181 2006-09-15 08:24:36Z smasson $ 
     134 $Id: loadgrid.pro 192 2006-09-22 09:37:08Z smasson $ 
    135135 
    136136    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/WIDGET/xxx.html

    r187 r195  
    129129     
    130130    <h4>Version</h4>  
    131  $Id: xxx.pro 186 2006-09-20 10:50:37Z pinsard $ 
     131 $Id: xxx.pro 192 2006-09-22 09:37:08Z smasson $ 
    132132    <h4>History</h4> 
    133133  
    … …  
    337337     
    338338    <h4>Version</h4> 
    339  $Id: xxx.pro 186 2006-09-20 10:50:37Z pinsard $ 
     339 $Id: xxx.pro 192 2006-09-22 09:37:08Z smasson $ 
    340340 
    341341    <h4>History</h4> 

  • trunk/SRC/Documentation/idldoc_assistant_output/Utilities/mergeonline_help.html

    r187 r195  
    8888     
    8989    <h4>Version</h4> 
    90  $Id: mergeonline_help.pro 177 2006-09-13 15:50:54Z smasson $ 
     90 $Id: mergeonline_help.pro 192 2006-09-22 09:37:08Z smasson $ 
    9191    <h4>History</h4> 
    9292 Sept 2006: Sebastien Masson (smasson@lodyc.jussieu.fr) 

  • trunk/SRC/Documentation/idldoc_assistant_output/idldoc-lib.adp

    r190 r195  
    362362      <keyword ref="./Obsolete/nlecserie.html#_nlecserie">nlecserie</keyword> 
    363363    </section> 
     364    <section ref="./Obsolete/strrepl.html" title="strrepl.pro"> 
     365      <keyword ref="./Obsolete/strrepl.html#_strrepl">strrepl</keyword> 
     366    </section> 
    364367    <section ref="./Obsolete/vairdate.html" title="vairdate.pro"> 
    365368      <keyword ref="./Obsolete/vairdate.html#_vairdate">vairdate</keyword> 
    … …  
    11211124      <keyword ref="./ToBeReviewed/STRING/strkeywd.html#_strkeywd">strkeywd</keyword> 
    11221125    </section> 
    1123     <section ref="./ToBeReviewed/STRING/strrepl.html" title="strrepl.pro"> 
    1124       <keyword ref="./ToBeReviewed/STRING/strrepl.html#_strrepl">strrepl</keyword> 
    1125     </section> 
    11261126    <section ref="./ToBeReviewed/STRING/strright.html" title="strright.pro"> 
    11271127      <keyword ref="./ToBeReviewed/STRING/strright.html#_strright">strright</keyword> 
    … …  
    11291129    <section ref="./ToBeReviewed/STRING/strsci.html" title="strsci.pro"> 
    11301130      <keyword ref="./ToBeReviewed/STRING/strsci.html#_strsci">strsci</keyword> 
     1131    </section> 
     1132    <section ref="./ToBeReviewed/STRING/strsed.html" title="strsed.pro"> 
     1133      <keyword ref="./ToBeReviewed/STRING/strsed.html#_strsed">strsed</keyword> 
    11311134    </section> 
    11321135    <section ref="./ToBeReviewed/STRING/strtok.html" title="strtok.pro"> 
Note: See TracChangeset for help on using the changeset viewer.