- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/domdef.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Allows to extract a subdomain of study by providing parameters 700 needed for drawings (see outputs) 701 </div> 699 702 700 703 … … 711 714 <div class="routine_details" id="_domdef"> 712 715 713 <h2><a class="top" href="#container">top</a>domdef </h2> 716 <h2><a class="top" href="#container">top</a>domdef <span class="categories"> 717 </span></h2> 714 718 715 719 <p class="header"> 716 domdef<span class="result"> , <a href="#_domdef_param_x1">x1</a>, <a href="#_domdef_param_x2">x2</a>, <a href="#_domdef_param_y1">y1</a>, <a href="#_domdef_param_y2">y2</a>, <a href="#_domdef_param_z1">z1</a>, <a href="#_domdef_param_z2">z2</a></span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__extra">_extra</a>=<span class="result">_extra</span></p>720 domdef<span class="result">[, <a href="#_domdef_param_x1">x1</a>][, <a href="#_domdef_param_x2">x2</a>][, <a href="#_domdef_param_y1">y1</a>][, <a href="#_domdef_param_y2">y2</a>][, <a href="#_domdef_param_z1">z1</a>][, <a href="#_domdef_param_z2">z2</a>]</span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">GRIDTYPE</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">ENDPOINTS</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__extra">_extra</a>=<span class="result">_extra</span></p> 717 721 718 722 <div class="comments"> 719 NAME: DOMDEF 720 721 PURPOSE:permet d'extraire un sous domaine d'etude en fournissant les 722 parametres necessaires pour les traces. (cf. outputs) 723 724 CATEGORY: 725 726 CALLING SEQUENCE:domdef [,lon1, lon2, lat1, lat2[,vert1,vert2]] ou 727 bien domdef,vecteur 728 729 INPUTS:(facultatif), [vecteur a] 2, 4 ou 6 elements:; 730 sans l''utilisation des mots cles index,xindex,yindex,zindex: 731 *vert1, vert2: pour un domaine 3D dont la partie horizontale couvre tout 732 glam et gphi 733 *lon1, lon2, lat1, lat2: 734 definissant les longitudes min. max et les latitudes min, max du domaine a 735 etudier (tous les niveaux sont selectiones) 736 *lon1,lon2,lat1,lat2,vert1,vert2 pour specifier les profondeurs. 737 738 KEYWORD PARAMETERS: 739 740 ENDPOINTS: a four elements vector [x1,y1,x2,y2] used to specify 741 that domdef must define the box used to make a plot (pltz, pltt, 742 plt1d) done strictly along the line (that can have any direction) 743 starting at (x1, y1) ending at (x2, y2). When defining endpoints, 744 you must also define TYPE which define the type of plots 745 ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used 746 ENDPOINTS keywords 747 748 FINDALWAYS:oblige a redefinir une boite meme qd auqun point 749 n''est trouve ds la boite. dans ce cas on selectionne toute la 750 grille. 751 752 GRIDTYPE:un string ou un vecteur de string contennant le nom des 753 grilles (determinees uniquement par : 'T','U','V','W','F') pour 754 lesquelles le calcul doit etre fait. par 755 ex :'T' ou ['T','U'] 756 757 /MEMEINDICES: il se peut que les points t,u,v et F correspondant a 758 une meme boite geographique ne concernent pas les memes 759 indices des tableaux. Ceci pose parfois de pb (ou du moins de 760 serieuses complications) ds les programmes ou plusieurs types 761 de grilles interviennent (cf.: norme, curl...). Activer 762 MEMEINDICES pour forcer domdef a prendre les memes indices -ceux 763 de la grille T- pour toutes les autres grilles. 764 765 /INDEX: activer si on veut specifier que tous les elements 766 passes en entree de domdef se rapportent aux indices des 767 tableaux glam, gphi et gdep plutot qu'aux valeurs de ces 768 tableaux 769 770 /xindex: activer si on veut que les elements passes en entrre 771 de domdef et concernant la dimension en x se rapportent aux 772 indices des tableaux glam qu'aux valeurs de ces tableaux. 773 774 /yindex: cf xindex mais pour y et les gphi 775 776 /zindex: cf xindex mais pour z et les gdep 723 </div> 724 725 726 727 728 <h3>Parameters</h3> 729 730 731 <h4 id="_domdef_param_x1">x1 732 <span class="attr">in</span> 733 734 <span class="attr">optional</span> 735 736 737 738 739 740 </h4> 741 742 <div class="comments"> 743 Define the minimum longitude. (All levels are selected) 744 </div> 745 746 <h4 id="_domdef_param_x2">x2 747 <span class="attr">in</span> 748 749 <span class="attr">optional</span> 750 751 752 753 754 755 </h4> 756 757 <div class="comments"> 758 Define the maximum longitude. (All levels are selected) 759 </div> 760 761 <h4 id="_domdef_param_y1">y1 762 <span class="attr">in</span> 763 764 <span class="attr">optional</span> 765 766 767 768 769 770 </h4> 771 772 <div class="comments"> 773 Define the minimum latitude. (All levels are selected) 774 </div> 775 776 <h4 id="_domdef_param_y2">y2 777 <span class="attr">in</span> 778 779 <span class="attr">optional</span> 780 781 782 783 784 785 </h4> 786 787 <div class="comments"> 788 Define the maximum latitude. (All levels are selected) 789 </div> 790 791 <h4 id="_domdef_param_z1">z1 792 <span class="attr">in</span> 793 794 <span class="attr">optional</span> 795 796 797 798 799 800 </h4> 801 802 <div class="comments"> 803 For a 3d domain whose the horizontal part cover all glam 804 </div> 805 806 <h4 id="_domdef_param_z2">z2 807 <span class="attr">in</span> 808 809 <span class="attr">optional</span> 810 811 812 813 814 815 </h4> 816 817 <div class="comments"> 818 For a 3d domain whose the horizontal part cover all gphi 819 </div> 820 821 822 823 824 825 826 <h3>Keywords</h3> 827 828 <h4 id="_domdef_keyword_FINDALWAYS">FINDALWAYS 829 830 831 832 833 834 835 836 837 </h4> 838 839 <div class="comments"> 840 Force to redefine a box even when none point is find in the box. 841 In this case, we select all the grid. 842 </div> 843 844 <h4 id="_domdef_keyword_GRIDTYPE">GRIDTYPE 845 846 847 848 849 850 851 852 853 </h4> 854 855 <div class="comments"> 856 It is a string or a vector of strings containing the grids's name 857 (Only determinated by 'T','U','V','W','F') for which the calculation 858 must be done. 859 For example: 'T' ou ['T','U'] 860 </div> 861 862 <h4 id="_domdef_keyword_MEMEINDICES">MEMEINDICES 863 864 865 866 867 868 869 870 871 </h4> 872 873 <div class="comments"> 874 It is possible that points t,u,v and F correspond to a same geographic 875 box which do not concern the same array indexes. This is sometimes a 876 problem (or at least serious complications) in programs where several 877 type of grid interven (see norme, curl...). Activate MEMEINDICE to 878 force domdef to take same indexes -those of the grid T- for all other 879 grids. 880 </div> 881 882 <h4 id="_domdef_keyword_XINDEX">XINDEX 883 884 885 886 887 888 889 890 891 </h4> 892 893 <div class="comments"> 894 We activate it if we want that all elements passed in input of domdef 895 and concerning the X dimension refer to indexes of glam arrays rather 896 than to values of these arrays. 897 </div> 898 899 <h4 id="_domdef_keyword_YINDEX">YINDEX 900 901 902 903 904 905 906 907 908 </h4> 909 910 <div class="comments"> 911 We activate it if we want that all elements passed in input of domdef 912 and concerning the X dimension refer to indexes of gphi arrays rather 913 than to values of these arrays. 914 </div> 915 916 <h4 id="_domdef_keyword_ZINDEX">ZINDEX 917 918 919 920 921 922 923 924 925 </h4> 926 927 <div class="comments"> 928 We activate it if we want that all elements passed in input of domdef 929 and concerning the X dimension refer to indexes of gdep arrays rather 930 than to values of these arrays. 777 931 778 932 OUTPUTS:on recupere pour les 4 grilles t,u,v,f … … 795 949 -lastzt,w: le last indice qui delimite le sous domaine 796 950 suivant z 797 798 COMMON BLOCKS: 799 common.pro 800 801 SIDE EFFECTS: 802 803 RESTRICTIONS: 804 805 EXAMPLE: 806 </div> 807 808 809 810 811 <h3>Parameters</h3> 812 813 814 <h4 id="_domdef_param_x1">x1 815 816 817 818 819 820 821 822 823 </h4> 824 825 <div class="comments"></div> 826 827 <h4 id="_domdef_param_x2">x2 828 829 830 831 832 833 834 835 836 </h4> 837 838 <div class="comments"></div> 839 840 <h4 id="_domdef_param_y1">y1 841 842 843 844 845 846 847 848 849 </h4> 850 851 <div class="comments"></div> 852 853 <h4 id="_domdef_param_y2">y2 854 855 856 857 858 859 860 861 862 </h4> 863 864 <div class="comments"></div> 865 866 <h4 id="_domdef_param_z1">z1 867 868 869 870 871 872 873 874 875 </h4> 876 877 <div class="comments"></div> 878 879 <h4 id="_domdef_param_z2">z2 880 881 882 883 884 885 886 887 888 </h4> 889 890 <div class="comments"></div> 891 892 893 894 895 896 897 <h3>Keywords</h3> 898 899 <h4 id="_domdef_keyword_FINDALWAYS">FINDALWAYS 951 </div> 952 953 <h4 id="_domdef_keyword_ENDPOINTS">ENDPOINTS 900 954 901 955 … … 908 962 </h4> 909 963 964 <div class="comments"> 965 A four elements vector [x1,y1,x2,y2] used to specify 966 that domdef must define the box used to make a plot (pltz, pltt, 967 plt1d) done strictly along the line (that can have any direction) 968 starting at (x1, y1) ending at (x2, y2). When defining endpoints, 969 you must also define TYPE which define the type of plots 970 ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used 971 ENDPOINTS keywords 972 </div> 973 974 <h4 id="_domdef_keyword_TYPE">TYPE 975 976 977 978 979 980 981 982 983 </h4> 984 910 985 <div class="comments"></div> 911 986 912 <h4 id="_domdef_keyword_ GRIDTYPE">GRIDTYPE 987 <h4 id="_domdef_keyword_INDEX">INDEX 913 988 914 989 … … 921 996 </h4> 922 997 998 <div class="comments"> 999 We activate it if we want that all elements passed in input of domdef 1000 refer to indexes of glam, gphi and gdep arrays rather than to values 1001 of these arrays. 1002 </div> 1003 1004 <h4 id="_domdef_keyword__extra">_extra 1005 1006 1007 1008 1009 1010 1011 1012 1013 </h4> 1014 923 1015 <div class="comments"></div> 924 1016 925 <h4 id="_domdef_keyword_MEMEINDICES">MEMEINDICES 926 927 928 929 930 931 932 933 934 </h4> 935 936 <div class="comments"></div> 937 938 <h4 id="_domdef_keyword_XINDEX">XINDEX 939 940 941 942 943 944 945 946 947 </h4> 948 949 <div class="comments"></div> 950 951 <h4 id="_domdef_keyword_YINDEX">YINDEX 952 953 954 955 956 957 958 959 960 </h4> 961 962 <div class="comments"></div> 963 964 <h4 id="_domdef_keyword_ZINDEX">ZINDEX 965 966 967 968 969 970 971 972 973 </h4> 974 975 <div class="comments"></div> 976 977 <h4 id="_domdef_keyword_ENDPOINTS">ENDPOINTS 978 979 980 981 982 983 984 985 986 </h4> 987 988 <div class="comments"></div> 989 990 <h4 id="_domdef_keyword_TYPE">TYPE 991 992 993 994 995 996 997 998 999 </h4> 1000 1001 <div class="comments"></div> 1002 1003 <h4 id="_domdef_keyword_INDEX">INDEX 1004 1005 1006 1007 1008 1009 1010 1011 1012 </h4> 1013 1014 <div class="comments"></div> 1015 1016 <h4 id="_domdef_keyword__extra">_extra 1017 1018 1019 1020 1021 1022 1023 1024 1025 </h4> 1026 1027 <div class="comments"></div> 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1017 1018 1019 1020 <h3>Version history</h3> 1021 1022 <h4>Version</h4><div class="preformat"> 1023 $Id$ 1024 </div> 1025 <h4>History</h4><div class="preformat"></div> 1026 1027 1028 <h3>Known issues</h3> 1029 1030 1031 <h4>Todo items</h4><div class="preformat"> seb: output pas clair/ pas d'input required?</div> 1032 1033 1034 <h3>Other attributes</h3> 1035 1036 1037 <h4>Uses routines</h4><div class="preformat"> 1038 common.pro 1039 1040 </div> 1048 1041 1049 1042
Note: See TracChangeset
for help on using the changeset viewer.
