Ignore:
Timestamp:
09/13/06 17:50:54 (18 years ago)
Author:
smasson
Message:

updates of html files...

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r168 r177  
    699699      </div> 
    700700 
    701       <div id="file_comments"> compute the grid parameters from cm_4mesh common: 
    702  
    703        computegrid, startx, starty, stepx, stepy, nx, ny 
    704        computegrid, startx, starty, stepx, stepy 
    705        computegrid, xaxis = xaxis, yaxis = yaxis 
    706        or a suitable mix... 
    707  
    708  glamt 
    709  glamf 
    710  gphit 
    711  gphit 
    712  e1t 
    713  e2t 
    714  horizontal parameters 
    715  
    716  glamu {in} 
    717  glamv {in} 
    718  gphiu {in} 
    719  gphiv {in} 
    720  e1u {in} 
    721  e1v {in} 
    722  e1f {in} 
    723  e2u {in} 
    724  e2v {in} 
    725  e2f {in} 
    726  horizontal parameters if FULLCGRID keyword is defined 
    727  
    728  gdept 
    729  gdepw 
    730  e3t 
    731  e3w 
    732  verticals parameters 
    733  
    734  tmask 
    735  masks 
    736  
    737  umaskred {in} 
    738  vmaskred {in} 
    739  fmaskredx {in} 
    740  fmaskredy {in} 
    741  masks if FULLCGRID keyword is defined 
    742  
    743  triangles_list 
    744  triangulation 
    745 </div> 
     701      <div id="file_comments">  
     702 
     703 compute the grid parameters (cm_4mesh) common 
     704 
     705 domains sizes:</div> 
    746706 
    747707       
    … …  
    758718        <div class="routine_details" id="_computegrid"> 
    759719 
    760           <h2><a class="top" href="#container">top</a>computegrid <span class="categories">  
    761  Grid 
    762 </span></h2> 
     720          <h2><a class="top" href="#container">top</a>computegrid </h2> 
    763721         
    764722          <p class="header"> 
    765             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">string</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
     723            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_ROMSH">ROMSH</a>=<span class="result">ROMSH</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 
    766724         
    767725          <div class="comments"> 
    … …  
    775733             
    776734            <h4 id="_computegrid_param_startx">startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    777               <span class="attr">in</span> 
    778                
    779                
    780               <span class="attr">required</span> 
    781                
    782                
    783                
    784                
    785             </h4> 
    786          
    787           <div class="comments"> scalar, x starting point</div> 
     735               
     736               
     737               
     738               
     739               
     740               
     741               
     742               
     743            </h4> 
     744         
     745          <div class="comments"></div> 
    788746             
    789747            <h4 id="_computegrid_param_starty">starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    790               <span class="attr">in</span> 
    791                
    792                
    793               <span class="attr">required</span> 
    794                
    795                
    796                
    797                
    798             </h4> 
    799          
    800           <div class="comments"> scalar, y starting point</div> 
     748               
     749               
     750               
     751               
     752               
     753               
     754               
     755               
     756            </h4> 
     757         
     758          <div class="comments"></div> 
    801759             
    802760            <h4 id="_computegrid_param_stepxin">stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    803               <span class="attr">in</span> 
    804                
    805                
    806               <span class="attr">required</span> 
    807                
    808                
    809                
    810                
    811             </h4> 
    812          
    813           <div class="comments"> scalar or vector: x direction step, must be > 0 
    814              if vector nx is not used</div> 
     761               
     762               
     763               
     764               
     765               
     766               
     767               
     768               
     769            </h4> 
     770         
     771          <div class="comments"></div> 
    815772             
    816773            <h4 id="_computegrid_param_stepyin">stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    817               <span class="attr">in</span> 
    818                
    819                
    820               <span class="attr">required</span> 
    821                
    822                
    823                
    824                
    825             </h4> 
    826          
    827           <div class="comments"> scalar or vector: y direction step, 
    828              could be > 0 (south to north) or < 0 (north to south) 
    829              if vector ny is not used</div> 
     774               
     775               
     776               
     777               
     778               
     779               
     780               
     781               
     782            </h4> 
     783         
     784          <div class="comments"></div> 
    830785             
    831786            <h4 id="_computegrid_param_nxin">nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    832               <span class="attr">in</span> 
    833                
    834                
    835               <span class="attr">required</span> 
    836                
    837                
    838                
    839                
    840             </h4> 
    841          
    842           <div class="comments"> scalar, number of points in x direction</div> 
     787               
     788               
     789               
     790               
     791               
     792               
     793               
     794               
     795            </h4> 
     796         
     797          <div class="comments"></div> 
    843798             
    844799            <h4 id="_computegrid_param_nyin">nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    845               <span class="attr">in</span> 
    846                
    847                
    848               <span class="attr">required</span> 
    849                
    850                
    851                
    852                
    853             </h4> 
    854          
    855           <div class="comments"> scalar, number of points in y direction 
    856 </div> 
     800               
     801               
     802               
     803               
     804               
     805               
     806               
     807               
     808            </h4> 
     809         
     810          <div class="comments"></div> 
    857811             
    858812 
    … …  
    874828            </h4> 
    875829         
    876             <div class="comments"> to specify longitude1 with a 1 or 2 dimension array, in 
    877        this case startx, stepx and nx are not used but could be 
    878        necessary if the y axis is not defined with yaxis. It must be 
    879        possible to sort the first line of xaxis in the increasing 
    880        order by shifting its elements. 
    881 </div> 
     830            <div class="comments"></div> 
    882831             
    883832            <h4 id="_computegrid_keyword_YAXIS">YAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    892841            </h4> 
    893842         
    894             <div class="comments"> to specify latitudes with a 1 or 2 dimension array, in 
    895        this case starty, stepy and ny are not used but starty and 
    896        stepy could be necessary if the x axis is not defined with xaxis. 
    897        It must be sorted in the increasing or deceasing order 
    898        (along each column if 2d array). 
    899 </div> 
     843            <div class="comments"></div> 
    900844             
    901845            <h4 id="_computegrid_keyword_ZAXIS">ZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    910854            </h4> 
    911855         
    912             <div class="comments"> to specify the vertical axis with a 1 dimension 
    913        array. Must be sorted in the increasing or deceasing order 
    914 </div> 
     856            <div class="comments"></div> 
    915857             
    916858            <h4 id="_computegrid_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    925867            </h4> 
    926868         
    927             <div class="comments"> to specify the mask with a 2 or 3 dimension array 
    928 </div> 
     869            <div class="comments"></div> 
    929870             
    930871            <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    939880            </h4> 
    940881         
    941             <div class="comments"> a 2 elements vector, [lon1,lon2], the longitude 
    942        boundaries that should be used to visualize the data. 
    943        we must have lon2 > lon1 and lon2 - lon1 le 360 
    944        key_shift will be defined automaticaly computed according to 
    945        glamboundary by using the FIRST LINE of glamt but 
    946        key_shift will /= 0 only if key_periodic = 1 
    947 </div> 
     882            <div class="comments"></div> 
    948883             
    949884            <h4 id="_computegrid_keyword_XMINMESH">XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    954889               
    955890               
    956               <span class="attr">default:</span> <span class="value">0L</span> 
     891               
    957892               
    958893            </h4> 
    … …  
    967902               
    968903               
    969               <span class="attr">default:</span> <span class="value">jpiglo-1</span> 
     904               
    970905               
    971906            </h4> 
    … …  
    980915               
    981916               
    982               <span class="attr">default:</span> <span class="value">0L</span> 
     917               
    983918               
    984919            </h4> 
    … …  
    993928               
    994929               
    995               <span class="attr">default:</span> <span class="value">jpjglo-1</span> 
     930               
    996931               
    997932            </h4> 
    … …  
    1006941               
    1007942               
    1008               <span class="attr">default:</span> <span class="value">0L</span> 
    1009                
    1010             </h4> 
    1011          
    1012             <div class="comments"> 
    1013        to define the common variables i[xyz]minmesh 
    1014        used to define the grid only in a zoomed part of the original 
    1015        grid. max value is [XYZ]MAXMESH 
    1016 </div> 
     943               
     944               
     945            </h4> 
     946         
     947            <div class="comments"></div> 
    1017948             
    1018949            <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    1023954               
    1024955               
    1025               <span class="attr">default:</span> <span class="value">jpkglo-1</span> 
    1026                
    1027             </h4> 
    1028          
    1029             <div class="comments"> 
    1030        to define the common variables i[xyz]maxmesh 
    1031        used to define the grid only in a zoomed part of the original 
    1032        grid. max value is jp[ijk]glo-1. 
    1033        if [XYZ]MAXMESH is negative, then we define i[xyz]maxmesh as 
    1034        jp[ijk]glo - 1 + [XYZ]MAXMESH instead of [XYZ]MAXMESH     
    1035 </div> 
     956               
     957               
     958            </h4> 
     959         
     960            <div class="comments"></div> 
    1036961             
    1037962            <h4 id="_computegrid_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    1042967               
    1043968               
    1044               <span class="attr">default:</span> <span class="value"> key_onearth</span> 
    1045                
    1046             </h4> 
    1047          
    1048             <div class="comments"> 
    1049        = 0 or 1 to force the manual definition of 
    1050        key_onearth (to specify if the data are on earth -> use longitude 
    1051        /latitude etc...). 
    1052        note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0, 
    1053        and is cancelling GLAMBOUNDARY 
    1054 </div> 
     969               
     970               
     971            </h4> 
     972         
     973            <div class="comments"></div> 
    1055974             
    1056975            <h4 id="_computegrid_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    1061980               
    1062981               
    1063               <span class="attr">default:</span> <span class="value">key_periodic is automatically computed by using the first line of glamt</span> 
    1064                
    1065             </h4> 
    1066          
    1067             <div class="comments"> 
    1068        = 0 or 1 to force the manual definition of key_periodic. 
    1069 </div> 
     982               
     983               
     984            </h4> 
     985         
     986            <div class="comments"></div> 
    1070987             
    1071988            <h4 id="_computegrid_keyword_PLAIN">PLAIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    1080997            </h4> 
    1081998         
    1082             <div class="comments"> force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and 
    1083        suppress the automatic redefinition of the domain in case of 
    1084        x periodicity overlap, y periodicity overlap (ORCA type only) 
    1085        and mask border to 0. 
    1086 </div> 
     999            <div class="comments"></div> 
    10871000             
    10881001            <h4 id="_computegrid_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    10971010            </h4> 
    10981011         
    1099             <div class="comments"> = scalar to force the manual definition of key_shift. By 
    1100        default, key_shift is automatically computed according to 
    1101        glamboundary (when defined) by using the FIRST LINE of glamt. if 
    1102        key_periodic=0 then in any case key_shift = 0. 
    1103 </div> 
     1012            <div class="comments"></div> 
    11041013             
    11051014            <h4 id="_computegrid_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11101019               
    11111020               
    1112               <span class="attr">default:</span> <span class="value">[1, 1, 1]</span> 
    1113                
    1114             </h4> 
    1115          
    1116             <div class="comments"> a 3 elements vector to specify the stride in x, y, z 
    1117        direction. The resulting value 
    1118        will be stored in the common (cm_4mesh) variable key_stride 
    1119 </div> 
     1021               
     1022               
     1023            </h4> 
     1024         
     1025            <div class="comments"></div> 
    11201026             
    11211027            <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11301036            </h4> 
    11311037         
    1132             <div class="comments"> activate to specify that you want to compute 
    1133        all the parameters of a C grid. Computation of glam[uv], 
    1134        gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy] 
    1135        will be add to the default computations 
    1136 </div> 
     1038            <div class="comments"></div> 
    11371039             
    11381040            <h4 id="_computegrid_keyword_XYINDEX">XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11471049            </h4> 
    11481050         
    1149             <div class="comments"> activate to specify that the horizontal grid should 
    1150        be simply defined by using the index of the points 
    1151           (xaxis = findgen(nx) and yaxis = findgen(ny)) 
    1152        using this keyword forces key_onearth=0 
    1153 </div> 
     1051            <div class="comments"></div> 
    11541052             
    11551053            <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11641062            </h4> 
    11651063         
    1166             <div class="comments"> 
    1167 </div> 
     1064            <div class="comments"></div> 
    11681065             
    11691066            <h4 id="_computegrid_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11731070               
    11741071               
    1175               <span class="attr">type:</span> <span class="value">string</span> 
    1176                
    1177                
    1178             </h4> 
    1179          
    1180             <div class="comments"> 
    1181        a string containing the calling command used to 
    1182        call computegrid (this is used by xxx.pro) 
    1183  
    1184  
    1185 </div> 
     1072               
     1073               
     1074               
     1075            </h4> 
     1076         
     1077            <div class="comments"></div> 
     1078             
     1079            <h4 id="_computegrid_keyword_ROMSH">ROMSH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1080               
     1081               
     1082               
     1083               
     1084               
     1085               
     1086               
     1087               
     1088            </h4> 
     1089         
     1090            <div class="comments"></div> 
    11861091             
    11871092            <h4 id="_computegrid_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    … …  
    11961101            </h4> 
    11971102         
    1198             <div class="comments"> used to pass your keywords to the created function. 
    1199 </div> 
    1200              
    1201            
    1202  
    1203            
    1204           <h3>Version history</h3> 
    1205            
    1206           <h4>Version</h4><div class="preformat"> $Id: computegrid.pro 163 2006-08-29 12:59:46Z navarro $ 
    1207 </div> 
    1208           <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
    1209                       2000-04-20 
    1210   Sept 2004, several bug fixs to suit C grid type... 
    1211   Aug 2005, rewritte almost everything... 
    1212 </div> 
    1213            
    1214            
    1215           <h3>Known issues</h3> 
    1216            
    1217            
    1218            
    1219           <h4>Restrictions</h4><div class="preformat"> if the grid has x/y periodicity orverlap and/or if 
    1220     the mask has 0 everywhere at the border (like a close sea) and 
    1221     if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh, 
    1222     ymaxmesh keywords are defined to their default values), we redefine 
    1223     xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the 
    1224     overlapping part and/or to open the domain (avoid ti be forced 
    1225     to use cell_fill = 1). 
    1226  
    1227  FUV points definition... 
    1228 </div> 
    1229          
    1230           <h3>Other attributes</h3> 
    1231            
    1232            
    1233           <h4>Uses routines</h4><div class="preformat"> cm_4mesh cm_4data cm_4cal 
    1234 </div> 
     1103            <div class="comments"></div> 
     1104             
     1105           
     1106 
     1107           
     1108           
     1109           
     1110           
     1111           
     1112           
     1113           
     1114           
     1115           
     1116           
     1117           
     1118           
     1119         
     1120           
     1121           
     1122           
     1123           
    12351124           
    12361125           
    … …  
    12391128          <h3>Statistics</h3> 
    12401129          <table class="statistics"> 
    1241             <tr><td>McCabe cyclic</td><td>         209</td></tr> 
     1130            <tr><td>McCabe cyclic</td><td>         214</td></tr> 
    12421131            <tr><td>McCabe essential</td><td>           1</td></tr> 
    12431132            <tr><td>McCabe modular design</td><td>           1</td></tr> 
Note: See TracChangeset for help on using the changeset viewer.