Ignore:
Timestamp:
02/08/07 11:21:07 (17 years ago)
Author:
smasson
Message:

update documentation

File:
1 edited

Legend:

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

    r203 r210  
    117117</font></h2> 
    118118 
    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> 
     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_UBASE2TBASE">UBASE2TBASE</a>=<i>UBASE2TBASE</i>, <a href="#_computegrid_keyword_VBASE2TBASE">VBASE2TBASE</a>=<i>VBASE2TBASE</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> 
    120120 
    121121     
     
    563563 
    564564     
     565    <a name="#_computegrid_keyword_UBASE2TBASE"></a> 
     566    <h4>UBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     567       
     568       
     569       
     570       
     571       
     572       
     573       
     574       
     575    </h4> 
     576 
     577     
     578       Activate when the model is a C grid based on a U point 
     579       (with a U point at the bottom-left corner and a T point at the 
     580       upper-right corner). In this case, we ignore  
     581         - if the grid is not x-periodic, the first column of F and U points 
     582         - if the grid is not x-periodic, the last  column of T and V points. 
     583       => we are back to a C grid based on T point as for OPA model. 
     584       Note that in that case, key_gridtype = 'c_u' and not 'c' (-> used in read_ncdf) 
     585       Note that activate UBASE2TBASE forces FULLCGRID=1 
     586 
     587     
     588    <a name="#_computegrid_keyword_VBASE2TBASE"></a> 
     589    <h4>VBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     590       
     591       
     592       
     593       
     594       
     595       
     596       
     597       
     598    </h4> 
     599 
     600     
     601       Activate when the model is a C grid based on a V point 
     602       (with a V point at the bottom-left corner and a T point at the 
     603       upper-right corner). In this case, we ignore  
     604         - the first line of F and V points 
     605         - the last  line of T and U points 
     606       => we are back to a C grid based on T point as for OPA model. 
     607       Note that in that case, key_gridtype = 'c_v' and not 'c' (-> used in read_ncdf) 
     608       Note that activate VBASE2TBASE forces FULLCGRID=1 
     609 
     610     
    565611    <a name="#_computegrid_keyword_FBASE2TBASE"></a> 
    566612    <h4>FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     
    579625       (with a F point at the bottom-left corner and a T point at the 
    580626       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. 
     627         - the first line of F and V points 
     628         - the last  line of T and U points 
     629         - if the grid is not x-periodic, the first column of F and U points 
     630         - if the grid is not x-periodic, the last  column of T and V points. 
     631       => we are back to a C grid based on T point as for OPA model. 
     632       Note that in that case, key_gridtype = 'c_f' and not 'c' (-> used in read_ncdf) 
     633       Note that activate FBASE2TBASE forces FULLCGRID=1 
    586634 
    587635     
     
    651699    <h3>Version history</h3> 
    652700     
    653     <h4>Version</h4> $Id: computegrid.pro 202 2007-01-12 11:00:06Z smasson $ 
     701    <h4>Version</h4> $Id: computegrid.pro 209 2007-02-08 10:01:49Z smasson $ 
    654702 
    655703    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) 
Note: See TracChangeset for help on using the changeset viewer.