- Timestamp:
- 03/21/07 10:14:37 (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html
r214 r234 87 87 </div> 88 88 89 <div id="file_comments"> 90 89 <div id="file_comments"> 91 90 compute the grid parameters (cm_4mesh) common 92 91 … … 147 146 <div class="routine_details" id="_computegrid"> 148 147 149 <h2><a class="top" href="#container">top</a>computegrid <span class="categories"> 148 <h2><a class="top" href="#container">top</a>computegrid <span class="categories"> 150 149 Grid 151 150 </span></h2> 152 151 153 152 <p class="header"> 154 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">1D or 2D array</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">1D or 2D array</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">1D</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">2D or 3D array</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_UBASE2TBASE">UBASE2TBASE</a>=<span class="result">UBASE2TBASE</span>, <a href="#_computegrid_keyword_VBASE2TBASE">VBASE2TBASE</a>=<span class="result">VBASE2TBASE</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<span class="result">2D array</span>, <a href="#_computegrid_keyword__ extra">_extra</a>=<span class="result">_extra</span></p>153 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">1D or 2D array</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">1D or 2D array</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">1D</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">2D or 3D array</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_UBASE2TBASE">UBASE2TBASE</a>=<span class="result">UBASE2TBASE</span>, <a href="#_computegrid_keyword_VBASE2TBASE">VBASE2TBASE</a>=<span class="result">VBASE2TBASE</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<span class="result">2D array</span>, <a href="#_computegrid_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 155 154 156 155 <div class="comments"> … … 253 252 </h4> 254 253 255 <div class="comments"> 254 <div class="comments"> 256 255 number of points in y direction, 257 256 optional if [XY]AXIS keyword is used or stepyin is a vector … … 515 514 516 515 <div class="comments"> 517 Force the manual definition of the zonal shift that must be apply to the data. 516 Force the manual definition of the zonal shift that must be apply to the data. 518 517 The resulting value will be stored in the common (cm_4mesh) variable key_shift 519 518 Note that if key_periodic=0 then in any case key_shift = 0. … … 584 583 Activate when the model is a C grid based on a U point 585 584 (with a U point at the bottom-left corner and a T point at the 586 upper-right corner). In this case, we ignore 585 upper-right corner). In this case, we ignore 587 586 - if the grid is not x-periodic, the first column of F and U points 588 587 - if the grid is not x-periodic, the last column of T and V points. … … 606 605 Activate when the model is a C grid based on a V point 607 606 (with a V point at the bottom-left corner and a T point at the 608 upper-right corner). In this case, we ignore 607 upper-right corner). In this case, we ignore 609 608 - the first line of F and V points 610 609 - the last line of T and U points … … 628 627 Activate when the model is a C grid based on a F point 629 628 (with a F point at the bottom-left corner and a T point at the 630 upper-right corner). In this case, we ignore 629 upper-right corner). In this case, we ignore 631 630 - the first line of F and V points 632 631 - the last line of T and U points … … 651 650 <div class="comments"> 652 651 a string containing the calling command used to 653 call computegrid (this is used by xxx.pro)652 call computegrid (this is used by <a href=".//../../ToBeReviewed/WIDGET/xxx.html">xxx</a>) 654 653 655 654 … … 673 672 Used when the model is a ROMS C-grid with one more point 674 673 in longitude for T and V grid and one more point in latitude 675 for T and U grid. In this case, we ignore 674 for T and U grid. In this case, we ignore 676 675 - the last line of T and U points 677 676 - the last column of T and V points. … … 680 679 </div> 681 680 682 <h4 id="_computegrid_keyword__ extra">_extra 683 684 685 686 687 688 689 690 691 </h4> 692 693 <div class="comments"> 681 <h4 id="_computegrid_keyword__EXTRA">_EXTRA 682 683 684 685 686 687 688 689 690 </h4> 691 692 <div class="comments"> 694 693 (not used in the present case...) 695 694 </div> … … 700 699 <h3>Version history</h3> 701 700 702 <h4>Version</h4><div class="preformat"> $Id: computegrid.pro 213 2007-02-16 11:29:17Z smasson $ 703 </div> 704 <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) 701 <h4>Version</h4><div class="preformat"> 702 $Id: computegrid.pro 232 2007-03-20 16:59:36Z pinsard $ 703 </div> 704 <h4>History</h4><div class="preformat"> 705 Sebastien Masson (smasson@lodyc.jussieu.fr) 705 706 2000-04-20 706 Sept 2004, several bug fix sto suit C grid type...707 Sept 2004, several bug fix to suit C grid type... 707 708 Aug 2005, rewritte almost everything... 708 709 </div> … … 713 714 714 715 715 <h4>Restrictions</h4><div class="preformat"> if the grid has x/y periodicity o rverlap and/or if716 <h4>Restrictions</h4><div class="preformat"> if the grid has x/y periodicity overlap and/or if 716 717 the mask has 0 everywhere at the border (like a close sea) and 717 718 if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
Note: See TracChangeset
for help on using the changeset viewer.
