Changeset 168 for trunk/SRC/Documentation/idldoc_html_output/Computation
- Timestamp:
- 09/06/06 12:46:29 (18 years ago)
- Location:
- trunk/SRC/Documentation/idldoc_html_output/Computation
- Files:
-
- 3 added
- 3 moved
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Computation/curl.html
r167 r168 645 645 <tr> 646 646 647 <td><a href="./../ ../overview.html?format=raw" title="Overview of library">Overview</a></td>647 <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td> 648 648 649 649 … … 653 653 654 654 655 <td><a href="./../ ../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>656 657 658 659 <td><a href="./../ ../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>660 661 662 663 <td><a href="./../ ../search-page.html?format=raw" title="Search library">Search</a></td>655 <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> 656 657 658 659 <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> 660 661 662 663 <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> 664 664 665 665 … … 667 667 668 668 669 <td >Source</td>670 671 672 673 <td><a href="./../ ../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>669 <td><a href="../../../Computation//curl.pro?format=raw" title="Source code of a file">Source</a></td> 670 671 672 673 <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> 674 674 675 675 … … 684 684 <div id="secondary_navbar"> 685 685 686 << prev file | <a href="d epth2floatlevel.html?format=raw">next file >></a> <a href="curl.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a>686 << prev file | <a href="div.html?format=raw">next file >></a> <a href="curl.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> 687 687 688 688 </div> … … 691 691 <div id="container"> 692 692 693 <h1 class="directory"><a href="directory-overview.html?format=raw"> ToBeReviewed/CALCULS/</a></h1>693 <h1 class="directory"><a href="directory-overview.html?format=raw">Computation/</a></h1> 694 694 <h2 class="pro_file">curl.pro</h2> 695 695 … … 721 721 722 722 <p class="header"> 723 <span class="result">result = </span>curl(<span class="result"><a href="#_curl_param_uu">uu</a>, <a href="#_curl_param_vv">vv</a></span> )</p>723 <span class="result">result = </span>curl(<span class="result"><a href="#_curl_param_uu">uu</a>, <a href="#_curl_param_vv">vv</a></span>, <a href="#_curl_keyword_DIREC">DIREC</a>=<span class="result">scalar string</span>)</p> 724 724 725 725 <div class="comments"> … … 727 727 728 728 <h3>Return value</h3><div class="preformat"> RES 729 A 2d matrix729 the vertical component of the curl of the input data (with the same size) 730 730 </div> 731 731 … … 746 746 747 747 <div class="comments"> 748 Matrix representing coordinates of a field of vectors 748 Matrix representing the zonal coordinates (U point) of a field of vectors 749 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 750 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 751 note that the dimension of the arry must suit the domain dimension. 749 752 </div> 750 753 … … 761 764 762 765 <div class="comments"> 763 Matrix representing coordinates of a field of vectors 766 Matrix representing the meridional coordinates (V point) of a field of vectors 767 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 768 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 769 note that the dimension of the arry must suit the domain dimension. 764 770 </div> 765 771 … … 769 775 770 776 771 777 <h3>Keywords</h3> 778 779 <h4 id="_curl_keyword_DIREC">DIREC 780 781 782 783 784 785 <span class="attr">type:</span> <span class="value">scalar string</span> 786 787 788 </h4> 789 790 <div class="comments"> 791 Use if you want to call moyenne or grossemoyenne after the div computation 792 with a mean done in the DIREC direction 793 </div> 794 795 796 797 <h3>Examples</h3><div class="preformat"> 798 IDL> @tst_initorca2 799 IDL> plt, curl(dist(jpi,jpj), dist(jpi,jpj)) 800 </div> 772 801 <h3>Version history</h3> 773 802 774 803 <h4>Version</h4><div class="preformat"> 775 $Id: curl.pro 1 57 2006-08-21 09:01:50Z navarro$804 $Id: curl.pro 167 2006-09-05 12:24:07Z smasson $ 776 805 </div> 777 806 <h4>History</h4><div class="preformat"> 778 807 Guillaume Roullet (grlod@ipsl.jussieu.fr) 779 780 808 Sebastien Masson (smasson@lodyc.jussieu.fr) 781 809 adaptation to work with a reduce domain … … 787 815 788 816 789 817 <h4>Todo items</h4><div class="preformat"> 818 code the 4d case</div> 790 819 <h4>Restrictions</h4><div class="preformat"> 791 U and V matrices can be 2 or 4d. 792 Beware, to discern different configuration of U and V (xy, xyz, xyt, xyzt), 793 we look at the variable of the common 794 -time which contain the calendar in IDL julian days to which U and 795 V refered to, in the same way as the variable 796 -jpt which is the number of time's step to consider in time. 797 U and V arrays ae cut in the same geographic domain. Because of the gap of 798 T, U, V and F grids, it is possible that these two arrays has not the same 799 size and refered to different indexes. In this case, arrays are re-cut on 800 common indexes and the domain is redefined to match with these common 801 indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro 802 803 804 Points on the drawing edge are at !values.f_nan 820 821 - Works only for Arakawa C-grid. 822 - UU must be on U grid, VV must be on V grid 823 - 4d case is not coded yet 824 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 825 - U and V arrays are cut in the same geographic domain. Because of the shift between 826 T, U, V and F grids, it is possible that these two arrays do not have the same 827 size and refer to different indexes. In this case, arrays are re-cut on 828 common indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro 829 - When computing the divergence, we update, vargrid, varname, varunits and the 830 grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf). 831 - points that cannot be computed (domain bondaries, coastline) are set to NaN 805 832 </div> 806 833 … … 809 836 810 837 <h4>Uses routines</h4><div class="preformat"> 811 c ommon.pro838 cm_4cal, cm_4data, cm_4mmesh 812 839 </div> 813 840 … … 817 844 <h3>Statistics</h3> 818 845 <table class="statistics"> 819 <tr><td>McCabe cyclic</td><td> 5 9</td></tr>846 <tr><td>McCabe cyclic</td><td> 55</td></tr> 820 847 <tr><td>McCabe essential</td><td> 1</td></tr> 821 848 <tr><td>McCabe modular design</td><td> 1</td></tr> -
trunk/SRC/Documentation/idldoc_html_output/Computation/div.html
r167 r168 645 645 <tr> 646 646 647 <td><a href="./../ ../overview.html?format=raw" title="Overview of library">Overview</a></td>647 <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td> 648 648 649 649 … … 653 653 654 654 655 <td><a href="./../ ../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>656 657 658 659 <td><a href="./../ ../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>660 661 662 663 <td><a href="./../ ../search-page.html?format=raw" title="Search library">Search</a></td>655 <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> 656 657 658 659 <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> 660 661 662 663 <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> 664 664 665 665 … … 667 667 668 668 669 <td >Source</td>670 671 672 673 <td><a href="./../ ../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>669 <td><a href="../../../Computation//div.pro?format=raw" title="Source code of a file">Source</a></td> 670 671 672 673 <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> 674 674 675 675 … … 684 684 <div id="secondary_navbar"> 685 685 686 <a href=" determ3.html?format=raw"><<prev file</a> | <a href="floatlevel2depth.html?format=raw">next file >></a> <a href="div.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a>686 <a href="curl.html?format=raw"><<prev file</a> | <a href="grad.html?format=raw">next file >></a> <a href="div.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> 687 687 688 688 </div> … … 691 691 <div id="container"> 692 692 693 <h1 class="directory"><a href="directory-overview.html?format=raw"> ToBeReviewed/CALCULS/</a></h1>693 <h1 class="directory"><a href="directory-overview.html?format=raw">Computation/</a></h1> 694 694 <h2 class="pro_file">div.pro</h2> 695 695 … … 700 700 701 701 <div id="file_comments"> 702 c alculation of the divergence of a 2dfield702 compute the horizontal divergence of a vectors field 703 703 </div> 704 704 … … 721 721 722 722 <p class="header"> 723 <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span> )</p>723 <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span>, <a href="#_div_keyword_DIREC">DIREC</a>=<span class="result">scalar string</span>)</p> 724 724 725 725 <div class="comments"> … … 727 727 728 728 <h3>Return value</h3><div class="preformat"> RES 729 A 2d matrix729 the divergence of the input data (with the same size) 730 730 </div> 731 731 … … 746 746 747 747 <div class="comments"> 748 Matrix representing coordinates of a field of vectors 748 Matrix representing the zonal coordinates (U point) of a field of vectors 749 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 750 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 751 note that the dimension of the arry must suit the domain dimension. 749 752 </div> 750 753 … … 761 764 762 765 <div class="comments"> 763 Matrix representing coordinates of a field of vectors 766 Matrix representing the meridional coordinates (V point) of a field of vectors 767 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 768 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 769 note that the dimension of the arry must suit the domain dimension. 764 770 </div> 765 771 … … 769 775 770 776 771 777 <h3>Keywords</h3> 778 779 <h4 id="_div_keyword_DIREC">DIREC 780 781 782 783 784 785 <span class="attr">type:</span> <span class="value">scalar string</span> 786 787 788 </h4> 789 790 <div class="comments"> 791 Use if you want to call moyenne or grossemoyenne after the div computation 792 (stupid ?) with a mean done in the DIREC direction 793 </div> 794 795 796 797 <h3>Examples</h3><div class="preformat"> 798 IDL> @tst_initorca2 799 IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj)) 800 </div> 772 801 <h3>Version history</h3> 773 802 774 803 <h4>Version</h4><div class="preformat"> 775 $Id: div.pro 1 57 2006-08-21 09:01:50Z navarro$804 $Id: div.pro 167 2006-09-05 12:24:07Z smasson $ 776 805 </div> 777 806 <h4>History</h4><div class="preformat"> 778 Guillaume Roullet (grlod@ipsl.jussieu.fr) 779 Creation : printemps 1998 780 Sebastien Masson (smasson@lodyc.jussieu.fr) 781 adaptation to work with a reduce domain 782 12/1/2000; 807 Guillaume Roullet (grlod@ipsl.jussieu.fr): creation; spring 1998 808 Sebastien Masson (smasson@lodyc.jussieu.fr) 809 adaptation to work with a reduce domain; 12/1/2000 783 810 </div> 784 811 … … 787 814 788 815 789 816 <h4>Todo items</h4><div class="preformat"> 817 code the 4d case</div> 790 818 <h4>Restrictions</h4><div class="preformat"> 791 U and V matrices can be 2 or 4d. 792 Beware, to discern different configuration of U and V (xy, xyz, xyt, xyzt), 793 we look at the variable of the common 794 -time which contain the calendar in IDL julian days to which U and 795 V refered to, in the same way as the variable 796 -jpt which is the number of time's step to consider in time. 797 U and V arrays are cut in the same geographic domain. Because of the gap of 798 T, U, V and F grids, it is possible that these two arrays has not the same 799 size and refered to different indexes. In this case, arrays are re-cut on 800 common indexes and the domain is redefined to match with these common 801 indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro 802 803 804 Points on the drawing edge are at !values.f_nan 805 819 820 - Works only for Arakawa C-grid. 821 - UU must be on U grid, VV must be on V grid 822 - 4d case is not coded yet 823 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 824 - U and V arrays are cut in the same geographic domain. Because of the shift between 825 T, U, V and F grids, it is possible that these two arrays do not have the same 826 size and refer to different indexes. In this case, arrays are re-cut on 827 common indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro 828 - When computing the divergence, we update, vargrid, varname, varunits and the 829 grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt). 830 - points that cannot be computed (domain bondaries, coastline) are set to NaN 806 831 </div> 807 832 … … 810 835 811 836 <h4>Uses routines</h4><div class="preformat"> 812 c ommon.pro837 cm_4cal, cm_4data, cm_4mmesh 813 838 </div> 814 839 … … 818 843 <h3>Statistics</h3> 819 844 <table class="statistics"> 820 <tr><td>McCabe cyclic</td><td> 54</td></tr>821 <tr><td>McCabe essential</td><td> 5</td></tr>845 <tr><td>McCabe cyclic</td><td> 49</td></tr> 846 <tr><td>McCabe essential</td><td> 1</td></tr> 822 847 <tr><td>McCabe modular design</td><td> 1</td></tr> 823 848 </table> -
trunk/SRC/Documentation/idldoc_html_output/Computation/grad.html
r167 r168 645 645 <tr> 646 646 647 <td><a href="./../ ../overview.html?format=raw" title="Overview of library">Overview</a></td>647 <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td> 648 648 649 649 … … 653 653 654 654 655 <td><a href="./../ ../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>656 657 658 659 <td><a href="./../ ../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>660 661 662 663 <td><a href="./../ ../search-page.html?format=raw" title="Search library">Search</a></td>655 <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> 656 657 658 659 <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> 660 661 662 663 <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> 664 664 665 665 … … 667 667 668 668 669 <td >Source</td>670 671 672 673 <td><a href="./../ ../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>669 <td><a href="../../../Computation//grad.pro?format=raw" title="Source code of a file">Source</a></td> 670 671 672 673 <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> 674 674 675 675 … … 684 684 <div id="secondary_navbar"> 685 685 686 <a href=" fsfzpt.html?format=raw"><<prev file</a> | <a href="grossemoyenne.html?format=raw">next file >></a> <a href="grad.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a>686 <a href="div.html?format=raw"><<prev file</a> | next file >> <a href="grad.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | routine details: <a href="#routine_details">routine</a> 687 687 688 688 </div> … … 691 691 <div id="container"> 692 692 693 <h1 class="directory"><a href="directory-overview.html?format=raw"> ToBeReviewed/CALCULS/</a></h1>693 <h1 class="directory"><a href="directory-overview.html?format=raw">Computation/</a></h1> 694 694 <h2 class="pro_file">grad.pro</h2> 695 695 … … 700 700 701 701 <div id="file_comments"> 702 702 compute the gradient of a variable 703 703 </div> 704 704 … … 717 717 718 718 <h2><a class="top" href="#container">top</a>grad <span class="categories"> 719 719 Calculation 720 720 </span></h2> 721 721 … … 725 725 <div class="comments"></div> 726 726 727 <h3>Return value</h3><div class="preformat"> 728 727 <h3>Return value</h3><div class="preformat"> RES {type=2D, 3D or 4D array} 728 the gradient of the input data (with the same size) 729 729 </div> 730 730 … … 745 745 746 746 <div class="comments"> 747 747 The field for which we want to compute the gradient. A 2D (xy), 748 3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp 749 and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 750 note that the dimension of the arry must suit the domain dimension. 748 751 </div> 749 752 … … 754 757 755 758 756 759 <span class="attr">type:</span> <span class="value">scalar string</span> 757 760 758 761 … … 760 763 761 764 <div class="comments"> 762 765 the gradient direction: 'x', 'y', 'z' 763 766 </div> 764 767 … … 769 772 770 773 <h3>Examples</h3><div class="preformat"> 771 774 IDL> @tst_initorca2 775 IDL> plt, grad({arr:gphit,g:'T'}, 'x') 776 IDL> plt, grad({arr:gphit,g:'T'}, 'y') 772 777 </div> 773 778 <h3>Version history</h3> 774 779 775 780 <h4>Version</h4><div class="preformat"> 776 $Id: grad.pro 1 59 2006-08-28 14:50:01Z smasson $781 $Id: grad.pro 167 2006-09-05 12:24:07Z smasson $ 777 782 </div> 778 783 <h4>History</h4><div class="preformat"> … … 784 789 785 790 786 <h4>Todo items</h4><div class="preformat"> 787 seb: remplir les truc!</div> 791 788 792 <h4>Restrictions</h4><div class="preformat"> 789 793 - Works only for Arakawa C-grid. 794 - When computing the gradient, the result is not on the same grid point 795 than the input data. In consequence, we update, vargrid and the grid position 796 parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf], 797 ny[tuvf], firstz[tw], lastz[tw], nz[tw]). 798 - points that cannot be computed (domain bondaries, coastline) are set to NaN 799 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 790 800 </div> 791 801 … … 794 804 795 805 <h4>Uses routines</h4><div class="preformat"> 796 806 cm_4cal, cm_4data, cm_4mmesh 797 807 </div> 798 808 … … 802 812 <h3>Statistics</h3> 803 813 <table class="statistics"> 804 <tr><td>McCabe cyclic</td><td> 6 5</td></tr>814 <tr><td>McCabe cyclic</td><td> 67</td></tr> 805 815 <tr><td>McCabe essential</td><td> 1</td></tr> 806 816 <tr><td>McCabe modular design</td><td> 1</td></tr>
Note: See TracChangeset
for help on using the changeset viewer.