Ignore:
Timestamp:
06/12/06 14:12:53 (18 years ago)
Author:
pinsard
Message:

start to modify headers of Grid .pro files for better idldoc output

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html

    r89 r103  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
    90  
    91        
    92  
    93        
    94  
    95        
    96  
    97        
    98  
    99       <div id="routine_details"> 
    100          
    101  
    102         <div class="routine_details" id="_computegrid"> 
    103  
    104           <h2><a class="top" href="#container">top</a>computegrid </h2> 
    105          
    106           <p class="header"> 
    107             computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    108          
    109           <div class="comments"> 
    110  NAME:computegrid 
    111  
    112  PURPOSE:compute the grid parameters from cm_4mesh common: 
     89      <div id="file_comments"> compute the grid parameters from cm_4mesh common: 
     90 
     91       computegrid, startx, starty, stepx, stepy, nx, ny 
     92       computegrid, startx, starty, stepx, stepy 
     93       computegrid, xaxis = xaxis, yaxis = yaxis 
     94       or a suitable mix... 
    11395 
    11496 horizontal parameters: 
     
    128110       key_shift, key_periodic, key_zreverse, key_yreverse, 
    129111       key_stride, key_onearth, key_partialstep 
    130  
    131  CATEGORY:grid 
    132  
    133  CALLING SEQUENCE: 
    134  
    135        computegrid, startx, starty, stepx, stepy, nx, ny 
    136        computegrid, startx, starty, stepx, stepy 
    137        computegrid, xaxis = xaxis, yaxis = yaxis 
    138        or a suitable mix... 
    139   
    140  INPUTS:  
    141        startx:scalar, x starting point 
    142        starty:scalar, y starting point 
    143        stepx:scalar or vector: x direction step, must be > 0 
    144              if vector nx is not used 
    145        stepy:scalar or vector: y direction step,  
     112</div> 
     113 
     114       
     115 
     116       
     117 
     118       
     119 
     120       
     121 
     122      <div id="routine_details"> 
     123         
     124 
     125        <div class="routine_details" id="_computegrid"> 
     126 
     127          <h2><a class="top" href="#container">top</a>computegrid <span class="categories"> grid 
     128</span></h2> 
     129         
     130          <p class="header"> 
     131            computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     132         
     133          <div class="comments"> 
     134</div> 
     135 
     136           
     137 
     138           
     139            <h3>Parameters</h3> 
     140         
     141             
     142            <h4 id="_computegrid_param_startx">startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     143              <span class="attr">in</span> 
     144               
     145               
     146              <span class="attr">required</span> 
     147               
     148               
     149               
     150               
     151            </h4> 
     152         
     153          <div class="comments"> scalar, x starting point</div> 
     154             
     155            <h4 id="_computegrid_param_starty">starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     156              <span class="attr">in</span> 
     157               
     158               
     159              <span class="attr">required</span> 
     160               
     161               
     162               
     163               
     164            </h4> 
     165         
     166          <div class="comments"> scalar, y starting point</div> 
     167             
     168            <h4 id="_computegrid_param_stepxin">stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     169              <span class="attr">in</span> 
     170               
     171               
     172              <span class="attr">required</span> 
     173               
     174               
     175               
     176               
     177            </h4> 
     178         
     179          <div class="comments"> scalar or vector: x direction step, must be > 0 
     180             if vector nx is not used</div> 
     181             
     182            <h4 id="_computegrid_param_stepyin">stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     183              <span class="attr">in</span> 
     184               
     185               
     186              <span class="attr">required</span> 
     187               
     188               
     189               
     190               
     191            </h4> 
     192         
     193          <div class="comments"> scalar or vector: y direction step,  
    146194             could be > 0 (south to north) or < 0 (north to south) 
    147              if vector ny is not used 
    148        nx:scalar, number of points in x direction  
    149        ny:scalar, number of points in y direction 
    150  
    151  KEYWORD PARAMETERS: 
    152  
    153        /FULLCGRID: activate to specify that you want to compute 
    154        all the paremeters of a C grid. Computation of glam[uv], 
    155        gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
    156        will be add to the default computations 
    157  
    158        GLAMBOUNDARY: a 2 elements vector, [lon1,lon2], the longitute 
     195             if vector ny is not used</div> 
     196             
     197            <h4 id="_computegrid_param_nxin">nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     198              <span class="attr">in</span> 
     199               
     200               
     201              <span class="attr">required</span> 
     202               
     203               
     204               
     205               
     206            </h4> 
     207         
     208          <div class="comments"> scalar, number of points in x direction </div> 
     209             
     210            <h4 id="_computegrid_param_nyin">nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     211              <span class="attr">in</span> 
     212               
     213               
     214              <span class="attr">required</span> 
     215               
     216               
     217               
     218               
     219            </h4> 
     220         
     221          <div class="comments"> scalar, number of points in y direction 
     222</div> 
     223             
     224 
     225           
     226 
     227           
     228 
     229            <h3>Keywords</h3> 
     230             
     231            <h4 id="_computegrid_keyword_XAXIS">XAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     232               
     233               
     234               
     235               
     236               
     237               
     238               
     239               
     240            </h4> 
     241         
     242            <div class="comments"> to specify longitude1 with a 1 or 2 dimension array, in  
     243       this case startx, stepx and nx are not used but could be 
     244       necessary if the y axis is not defined with yaxis. It must be 
     245       possible to sort the first line of xaxis in the increasing 
     246       order by shifting its elements. 
     247</div> 
     248             
     249            <h4 id="_computegrid_keyword_YAXIS">YAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     250               
     251               
     252               
     253               
     254               
     255               
     256               
     257               
     258            </h4> 
     259         
     260            <div class="comments"> to specify latitudes with a 1 or 2 dimension array, in  
     261       this case starty, stepy and ny are not used but starty and 
     262       stepy could be necessary if the x axis is not defined with xaxis. 
     263       It must be sorted in the increasing or deceasing order 
     264       (along each column if 2d array). 
     265</div> 
     266             
     267            <h4 id="_computegrid_keyword_ZAXIS">ZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     268               
     269               
     270               
     271               
     272               
     273               
     274               
     275               
     276            </h4> 
     277         
     278            <div class="comments"> to specify the vertical axis with a 1 dimension 
     279       array. Must be sorted in the increasing or deceasing order 
     280</div> 
     281             
     282            <h4 id="_computegrid_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     283               
     284               
     285               
     286               
     287               
     288               
     289               
     290               
     291            </h4> 
     292         
     293            <div class="comments"> to specify the mask with a 2 or 3 dimension array 
     294</div> 
     295             
     296            <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     297               
     298               
     299               
     300               
     301               
     302               
     303               
     304               
     305            </h4> 
     306         
     307            <div class="comments"> a 2 elements vector, [lon1,lon2], the longitute 
    159308       boundaries that should be used to visualize the data. 
    160309       we must have lon2 > lon1 and lon2 - lon1 le 360 
     
    162311       glamboundary by using the FIRST LINE of glamt but  
    163312       key_shift will /= 0 only if key_periodic = 1  
    164  
    165        MASK: to specify the mask with a 2 or 3 dimension array 
    166  
    167        ONEARTH = 0 or 1: to force the manual definition of 
    168        key_onearth (to specify if the data are on earth -> use longitude 
    169        /latitude etc...). By default, key_onearth = 1. 
    170        note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0,  
    171        and is cancelling GLAMBOUNDARY 
    172  
    173        PERIODIC = 0 or 1: to force the manual definition of 
    174        key_periodic. By default, key_periodic is automaticaly 
    175        computed by using the first line of glamt.  
    176  
    177        /PLAIN: force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
    178        suppress the automatic redefinition of the domain in case of  
    179        x periodicity overlap, y periodicity overlap (ORCA type only) 
    180        and mask border to 0. 
    181  
    182        SHIFT = scalar to force the manual definition of key_shift. By 
    183        debault, key_shift is automaticaly computed according to 
    184        glamboundary (when defined) by using the FIRST LINE of glamt. if 
    185        key_periodic=0 then in any case key_shift = 0.  
    186  
    187        STRCALLING: a string containing the calling command used to 
    188        call computegrid (this is used by xxx.pro) 
    189  
    190        STRIDE = : a 3 elements vector to specify the stride in x, y, z 
    191        direction. Default definition is [1, 1, 1]. The resulting value 
    192        will be stored in the common (cm_4mesh) variable key_stride 
    193  
    194        XAXIS: to specify longitude1 with a 1 or 2 dimension array, in  
    195        this case startx, stepx and nx are not used but could be 
    196        necessary if the y axis is not defined with yaxis. It must be 
    197        possible to sort the first line of xaxis in the increasing 
    198        order by shifting its elements. 
    199  
    200        YAXIS: to specify latitudes with a 1 or 2 dimension array, in  
    201        this case starty, stepy and ny are not used but starty and 
    202        stepy could be necessary if the x axis is not defined with xaxis. 
    203        It must be sorted in the increasing or deceasing order 
    204        (along each column if 2d array). 
    205  
    206        /XYINDEX: activate to specify that the horizontal grid should  
    207        be simply defined by using the index of the points 
    208           (xaxis = findgen(nx) and yaxis = findgen(ny)) 
    209        using this keyword forces key_onearth=0 
    210  
    211        [XYZ]MINMESH: to define the common variables i[xyz]minmesh 
     313</div> 
     314             
     315            <h4 id="_computegrid_keyword_XMINMESH">XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     316               
     317               
     318               
     319               
     320               
     321               
     322               
     323               
     324            </h4> 
     325         
     326            <div class="comments"> </div> 
     327             
     328            <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     329               
     330               
     331               
     332               
     333               
     334               
     335               
     336               
     337            </h4> 
     338         
     339            <div class="comments"> </div> 
     340             
     341            <h4 id="_computegrid_keyword_YMINMESH">YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     342               
     343               
     344               
     345               
     346               
     347               
     348               
     349               
     350            </h4> 
     351         
     352            <div class="comments"> </div> 
     353             
     354            <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     355               
     356               
     357               
     358               
     359               
     360               
     361               
     362               
     363            </h4> 
     364         
     365            <div class="comments"> </div> 
     366             
     367            <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     368               
     369               
     370               
     371               
     372               
     373               
     374               
     375               
     376            </h4> 
     377         
     378            <div class="comments">  
     379       to define the common variables i[xyz]minmesh 
    212380       used to define the grid only in a zoomed part of the original 
    213381       grid. Defaut values are 0L, max value is [XYZ]MAXMESH 
    214  
    215        [XYZ]MAXMESH: to define the common variables i[xyz]maxmesh 
     382</div> 
     383             
     384            <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     385               
     386               
     387               
     388               
     389               
     390               
     391               
     392               
     393            </h4> 
     394         
     395            <div class="comments">  
     396       to define the common variables i[xyz]maxmesh 
    216397       used to define the grid only in a zoomed part of the original 
    217398       grid. Defaut values are jp[ijk]glo-1, max value is 
     
    219400       i[xyz]maxmesh as jp[ijk]glo - 1 + [XYZ]MAXMESH instead of 
    220401       [XYZ]MAXMESH      
    221  
    222        ZAXIS: to specify the vertical axis with a 1 dimension 
    223        array. Must be sorted in the increasing or deceasing order 
    224  
    225  OUTPUTS: 
    226  
    227  COMMON BLOCKS: cm_4mesh cm_4data cm_4cal 
    228  
    229  SIDE EFFECTS: if the grid has x/y periodicity orverlap and/or if 
     402</div> 
     403             
     404            <h4 id="_computegrid_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     405               
     406               
     407               
     408               
     409               
     410               
     411               
     412               
     413            </h4> 
     414         
     415            <div class="comments"> = 0 or 1 to force the manual definition of 
     416       key_onearth (to specify if the data are on earth -> use longitude 
     417       /latitude etc...). By default, key_onearth = 1. 
     418       note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0,  
     419       and is cancelling GLAMBOUNDARY 
     420</div> 
     421             
     422            <h4 id="_computegrid_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     423               
     424               
     425               
     426               
     427               
     428               
     429               
     430               
     431            </h4> 
     432         
     433            <div class="comments"> = 0 or 1 to force the manual definition of 
     434       key_periodic. By default, key_periodic is automaticaly 
     435       computed by using the first line of glamt.  
     436</div> 
     437             
     438            <h4 id="_computegrid_keyword_PLAIN">PLAIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     439               
     440               
     441               
     442               
     443               
     444               
     445               
     446               
     447            </h4> 
     448         
     449            <div class="comments"> force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
     450       suppress the automatic redefinition of the domain in case of  
     451       x periodicity overlap, y periodicity overlap (ORCA type only) 
     452       and mask border to 0. 
     453</div> 
     454             
     455            <h4 id="_computegrid_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     456               
     457               
     458               
     459               
     460               
     461               
     462               
     463               
     464            </h4> 
     465         
     466            <div class="comments"> = scalar to force the manual definition of key_shift. By 
     467       debault, key_shift is automaticaly computed according to 
     468       glamboundary (when defined) by using the FIRST LINE of glamt. if 
     469       key_periodic=0 then in any case key_shift = 0.  
     470</div> 
     471             
     472            <h4 id="_computegrid_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     473               
     474               
     475               
     476               
     477               
     478               
     479               
     480               
     481            </h4> 
     482         
     483            <div class="comments">  a 3 elements vector to specify the stride in x, y, z 
     484       direction. Default definition is [1, 1, 1]. The resulting value 
     485       will be stored in the common (cm_4mesh) variable key_stride 
     486</div> 
     487             
     488            <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     489               
     490               
     491               
     492               
     493               
     494               
     495               
     496               
     497            </h4> 
     498         
     499            <div class="comments"> activate to specify that you want to compute 
     500       all the paremeters of a C grid. Computation of glam[uv], 
     501       gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
     502       will be add to the default computations 
     503</div> 
     504             
     505            <h4 id="_computegrid_keyword_XYINDEX">XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     506               
     507               
     508               
     509               
     510               
     511               
     512               
     513               
     514            </h4> 
     515         
     516            <div class="comments"> activate to specify that the horizontal grid should  
     517       be simply defined by using the index of the points 
     518          (xaxis = findgen(nx) and yaxis = findgen(ny)) 
     519       using this keyword forces key_onearth=0 
     520</div> 
     521             
     522            <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     523               
     524               
     525               
     526               
     527               
     528               
     529               
     530               
     531            </h4> 
     532         
     533            <div class="comments"></div> 
     534             
     535            <h4 id="_computegrid_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     536               
     537               
     538               
     539               
     540               
     541               
     542               
     543               
     544            </h4> 
     545         
     546            <div class="comments"> a string containing the calling command used to 
     547       call computegrid (this is used by xxx.pro) 
     548</div> 
     549             
     550            <h4 id="_computegrid_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     551               
     552               
     553               
     554               
     555               
     556               
     557               
     558               
     559            </h4> 
     560         
     561            <div class="comments"></div> 
     562             
     563           
     564 
     565           
     566          <h3>Version history</h3> 
     567           
     568           
     569          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     570                      2000-04-20 
     571  Sept 2004, several bug fixs to suit C grid type... 
     572  Aug 2005, rewritte almost everything...</div> 
     573           
     574           
     575          <h3>Known issues</h3> 
     576           
     577           
     578           
     579          <h4>Restrictions</h4><div class="value"> if the grid has x/y periodicity orverlap and/or if 
    230580    the mask has 0 everywhere at the border (like a close sea) and 
    231581    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
     
    235585    to use cell_fill = 1). 
    236586 
    237  RESTRICTIONS:FUV points definition... 
    238  
    239  EXAMPLE: 
    240 </div> 
    241  
    242            
    243  
    244            
    245             <h3>Parameters</h3> 
    246          
    247              
    248             <h4 id="_computegrid_param_startx">startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    249                
    250                
    251                
    252                
    253                
    254                
    255                
    256                
    257             </h4> 
    258          
    259           <div class="comments"></div> 
    260              
    261             <h4 id="_computegrid_param_starty">starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    262                
    263                
    264                
    265                
    266                
    267                
    268                
    269                
    270             </h4> 
    271          
    272           <div class="comments"></div> 
    273              
    274             <h4 id="_computegrid_param_stepxin">stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    275                
    276                
    277                
    278                
    279                
    280                
    281                
    282                
    283             </h4> 
    284          
    285           <div class="comments"></div> 
    286              
    287             <h4 id="_computegrid_param_stepyin">stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    288                
    289                
    290                
    291                
    292                
    293                
    294                
    295                
    296             </h4> 
    297          
    298           <div class="comments"></div> 
    299              
    300             <h4 id="_computegrid_param_nxin">nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    301                
    302                
    303                
    304                
    305                
    306                
    307                
    308                
    309             </h4> 
    310          
    311           <div class="comments"></div> 
    312              
    313             <h4 id="_computegrid_param_nyin">nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    314                
    315                
    316                
    317                
    318                
    319                
    320                
    321                
    322             </h4> 
    323          
    324           <div class="comments"></div> 
    325              
    326  
    327            
    328  
    329            
    330  
    331             <h3>Keywords</h3> 
    332              
    333             <h4 id="_computegrid_keyword_XAXIS">XAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    334                
    335                
    336                
    337                
    338                
    339                
    340                
    341                
    342             </h4> 
    343          
    344             <div class="comments"></div> 
    345              
    346             <h4 id="_computegrid_keyword_YAXIS">YAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    347                
    348                
    349                
    350                
    351                
    352                
    353                
    354                
    355             </h4> 
    356          
    357             <div class="comments"></div> 
    358              
    359             <h4 id="_computegrid_keyword_ZAXIS">ZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    360                
    361                
    362                
    363                
    364                
    365                
    366                
    367                
    368             </h4> 
    369          
    370             <div class="comments"></div> 
    371              
    372             <h4 id="_computegrid_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    373                
    374                
    375                
    376                
    377                
    378                
    379                
    380                
    381             </h4> 
    382          
    383             <div class="comments"></div> 
    384              
    385             <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    386                
    387                
    388                
    389                
    390                
    391                
    392                
    393                
    394             </h4> 
    395          
    396             <div class="comments"></div> 
    397              
    398             <h4 id="_computegrid_keyword_XMINMESH">XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    399                
    400                
    401                
    402                
    403                
    404                
    405                
    406                
    407             </h4> 
    408          
    409             <div class="comments"></div> 
    410              
    411             <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    412                
    413                
    414                
    415                
    416                
    417                
    418                
    419                
    420             </h4> 
    421          
    422             <div class="comments"></div> 
    423              
    424             <h4 id="_computegrid_keyword_YMINMESH">YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    425                
    426                
    427                
    428                
    429                
    430                
    431                
    432                
    433             </h4> 
    434          
    435             <div class="comments"></div> 
    436              
    437             <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    438                
    439                
    440                
    441                
    442                
    443                
    444                
    445                
    446             </h4> 
    447          
    448             <div class="comments"></div> 
    449              
    450             <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    451                
    452                
    453                
    454                
    455                
    456                
    457                
    458                
    459             </h4> 
    460          
    461             <div class="comments"></div> 
    462              
    463             <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    464                
    465                
    466                
    467                
    468                
    469                
    470                
    471                
    472             </h4> 
    473          
    474             <div class="comments"></div> 
    475              
    476             <h4 id="_computegrid_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    477                
    478                
    479                
    480                
    481                
    482                
    483                
    484                
    485             </h4> 
    486          
    487             <div class="comments"></div> 
    488              
    489             <h4 id="_computegrid_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    490                
    491                
    492                
    493                
    494                
    495                
    496                
    497                
    498             </h4> 
    499          
    500             <div class="comments"></div> 
    501              
    502             <h4 id="_computegrid_keyword_PLAIN">PLAIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    503                
    504                
    505                
    506                
    507                
    508                
    509                
    510                
    511             </h4> 
    512          
    513             <div class="comments"></div> 
    514              
    515             <h4 id="_computegrid_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    516                
    517                
    518                
    519                
    520                
    521                
    522                
    523                
    524             </h4> 
    525          
    526             <div class="comments"></div> 
    527              
    528             <h4 id="_computegrid_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    529                
    530                
    531                
    532                
    533                
    534                
    535                
    536                
    537             </h4> 
    538          
    539             <div class="comments"></div> 
    540              
    541             <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    542                
    543                
    544                
    545                
    546                
    547                
    548                
    549                
    550             </h4> 
    551          
    552             <div class="comments"></div> 
    553              
    554             <h4 id="_computegrid_keyword_XYINDEX">XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    555                
    556                
    557                
    558                
    559                
    560                
    561                
    562                
    563             </h4> 
    564          
    565             <div class="comments"></div> 
    566              
    567             <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    568                
    569                
    570                
    571                
    572                
    573                
    574                
    575                
    576             </h4> 
    577          
    578             <div class="comments"></div> 
    579              
    580             <h4 id="_computegrid_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    581                
    582                
    583                
    584                
    585                
    586                
    587                
    588                
    589             </h4> 
    590          
    591             <div class="comments"></div> 
    592              
    593             <h4 id="_computegrid_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    594                
    595                
    596                
    597                
    598                
    599                
    600                
    601                
    602             </h4> 
    603          
    604             <div class="comments"></div> 
    605              
    606            
    607  
    608            
    609            
    610            
    611            
    612            
    613            
    614            
    615            
    616            
    617            
    618            
    619            
    620          
    621            
    622            
    623            
    624            
     587 FUV points definition... 
     588</div> 
     589         
     590          <h3>Other attributes</h3> 
     591           
     592           
     593          <h4>Uses routines</h4><div class="value"> cm_4mesh cm_4data cm_4cal 
     594</div> 
    625595           
    626596           
Note: See TracChangeset for help on using the changeset viewer.