Ignore:
Timestamp:
07/21/06 14:47:49 (18 years ago)
Author:
navarro
Message:

english and nicer header (2a)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/grille.html

    r138 r142  
    696696      </div> 
    697697 
    698       <div id="file_comments"></div> 
     698      <div id="file_comments"> 
     699 Choose the grid which must be used to do the graph in function of 
     700 vargrid and send back corresponding parameters calculated in 
     701 domdef.pro and reduced at the domain defined by domdef (contrarily 
     702 to grandegrille.pro) 
     703 BEWARE!! The choice of the grid is made from the value of the  
     704 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'. 
     705</div> 
    699706 
    700707       
     
    711718        <div class="routine_details" id="_grille"> 
    712719 
    713           <h2><a class="top" href="#container">top</a>grille </h2> 
     720          <h2><a class="top" href="#container">top</a>grille <span class="categories"> 
     721</span></h2> 
    714722         
    715723          <p class="header"> 
    716             grille<span class="result">, <a href="#_grille_param_mask">mask</a>, <a href="#_grille_param_glam">glam</a>, <a href="#_grille_param_gphi">gphi</a>, <a href="#_grille_param_gdep">gdep</a>, <a href="#_grille_param_nx">nx</a>, <a href="#_grille_param_ny">ny</a>, <a href="#_grille_param_nz">nz</a>, <a href="#_grille_param_firstx">firstx</a>, <a href="#_grille_param_firsty">firsty</a>, <a href="#_grille_param_firstz">firstz</a>, <a href="#_grille_param_lastx">lastx</a>, <a href="#_grille_param_lasty">lasty</a>, <a href="#_grille_param_lastz">lastz</a>, <a href="#_grille_param_e1">e1</a>, <a href="#_grille_param_e2">e2</a>, <a href="#_grille_param_e3">e3</a></span>, <a href="#_grille_keyword_TRI">TRI</a>=<span class="result">TRI</span>, <a href="#_grille_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_grille_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_grille_keyword_FORPLT">FORPLT</a>=<span class="result">FORPLT</span>, <a href="#_grille_keyword_IFPLTZ">IFPLTZ</a>=<span class="result">IFPLTZ</span>, <a href="#_grille_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_grille_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
    717          
    718           <div class="comments"> 
    719  NAME:grille 
    720  
    721  PURPOSE: choisit la grille qui doit etre utilisee pour faire le graphe en 
    722  fonction de vargrid et renvoie les parametres correspondants calcules ds 
    723  domdef.pro et reduit au domaine definit par domdef (contrairement a 
    724  grandegrille.pro) 
    725  
    726  CATEGORY: 
    727  
    728  CALLING SEQUENCE: 
    729   grille,mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz,lastx,lasty,lastz,e1,e2,e3 
    730  
    731  INPUTS:rien. ATTENTION les choix de la grille se fait a partir de la 
    732  valeur de la variable globale vargrid, qui peut etre egale a 'T', 
    733  'U', 'V', 'W' ou 'F'. 
    734  
    735  KEYWORD PARAMETERS: 
    736          TRI si ce mot clef sert a obtenir grace a grille la 
    737          triangulation qui se rapporte a la grille mais uniquement 
    738          sur la partie du zoom. ce tableau de triangulation reduit 
    739          est passe ds la variable que l''on a egalee a tri.par ex: 
    740          grille,...,tri=triangulation_reduite. ne mot clef est 
    741          utilise dans plt.pro 
    742  
    743          /FORPLT: ds plt on veut que sur les points terres, glam et 
    744          gphi soit egale a glamt et gphit quelle que soit la grille. 
    745  
    746          /NOTRI: utile seulement qd TRI est active. dans ce cas 
    747          grille retourne -1 ds la variable tri meme si la variable du 
    748          common triangles_list est definie et differente de -1 
    749  
    750          /WDEPTH: to specify that the field is at W depth instad of T  
    751          depth (automatically activated if vargrid eq 'W') 
    752  
    753  OUTPUTS:mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz, 
    754          lastx,lasty,lastz,e1,e2,e3 
    755  
    756          pour leur definition cf domdef et la gestion des sous 
    757          domaines sur le web 
    758  
    759          Rq: ces outputs sont optionnels, si je veux recuperer que 
    760          mask, glam et gphi il suffit de taper grille, mask, glam, gphi 
    761  
    762  COMMON BLOCKS: cm_4mesh and cm_4data 
    763  
    764  SIDE EFFECTS: utilise la variable globale vargird 
    765  
    766  RESTRICTIONS: vargrid doit etre 'T', 'W', 'U', 'V' ou 'F' 
    767  
    768  EXAMPLE: 
     724            grille<span class="result">[, <a href="#_grille_param_mask">mask</a>][, <a href="#_grille_param_glam">glam</a>][, <a href="#_grille_param_gphi">gphi</a>][, <a href="#_grille_param_gdep">gdep</a>][, <a href="#_grille_param_nx">nx</a>][, <a href="#_grille_param_ny">ny</a>][, <a href="#_grille_param_nz">nz</a>][, <a href="#_grille_param_firstx">firstx</a>][, <a href="#_grille_param_firsty">firsty</a>][, <a href="#_grille_param_firstz">firstz</a>][, <a href="#_grille_param_lastx">lastx</a>][, <a href="#_grille_param_lasty">lasty</a>][, <a href="#_grille_param_lastz">lastz</a>][, <a href="#_grille_param_e1">e1</a>][, <a href="#_grille_param_e2">e2</a>][, <a href="#_grille_param_e3">e3</a>]</span>, <a href="#_grille_keyword_TRI">TRI</a>=<span class="result">TRI</span>, <a href="#_grille_keyword_NOTRI">NOTRI</a>=<span class="result">NOTRI</span>, <a href="#_grille_keyword_TOUT">TOUT</a>=<span class="result">TOUT</span>, <a href="#_grille_keyword_FORPLT">FORPLT</a>=<span class="result">FORPLT</span>, <a href="#_grille_keyword_IFPLTZ">IFPLTZ</a>=<span class="result">IFPLTZ</span>, <a href="#_grille_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>, <a href="#_grille_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> 
     725         
     726          <div class="comments"> 
    769727</div> 
    770728 
     
    777735            <h4 id="_grille_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    778736               
    779                
    780                
    781                
    782                
    783                
    784                
    785                
    786             </h4> 
    787          
    788           <div class="comments"></div> 
     737              <span class="attr">out</span> 
     738              <span class="attr">optional</span> 
     739               
     740               
     741               
     742               
     743               
     744            </h4> 
     745         
     746          <div class="comments"> 
     747 For the definition, see domdef and the management of subdomains on the web. 
     748 </div> 
    789749             
    790750            <h4 id="_grille_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    791751               
    792                
    793                
    794                
    795                
    796                
    797                
    798                
    799             </h4> 
    800          
    801           <div class="comments"></div> 
     752              <span class="attr">out</span> 
     753              <span class="attr">optional</span> 
     754               
     755               
     756               
     757               
     758               
     759            </h4> 
     760         
     761          <div class="comments"> 
     762 For the definition, see domdef and the management of subdomains on the web. 
     763 </div> 
    802764             
    803765            <h4 id="_grille_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    804766               
    805                
    806                
    807                
    808                
    809                
    810                
    811                
    812             </h4> 
    813          
    814           <div class="comments"></div> 
     767              <span class="attr">out</span> 
     768              <span class="attr">optional</span> 
     769               
     770               
     771               
     772               
     773               
     774            </h4> 
     775         
     776          <div class="comments"> 
     777 For the definition, see domdef and the management of subdomains on the web. 
     778 </div> 
    815779             
    816780            <h4 id="_grille_param_gdep">gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    817781               
    818                
    819                
    820                
    821                
    822                
    823                
    824                
    825             </h4> 
    826          
    827           <div class="comments"></div> 
     782              <span class="attr">out</span> 
     783              <span class="attr">optional</span> 
     784               
     785               
     786               
     787               
     788               
     789            </h4> 
     790         
     791          <div class="comments"> 
     792 For the definition, see domdef and the management of subdomains on the web. 
     793 </div> 
    828794             
    829795            <h4 id="_grille_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    830796               
    831                
    832                
    833                
    834                
    835                
    836                
    837                
    838             </h4> 
    839          
    840           <div class="comments"></div> 
     797              <span class="attr">out</span> 
     798              <span class="attr">optional</span> 
     799               
     800               
     801               
     802               
     803               
     804            </h4> 
     805         
     806          <div class="comments"> 
     807 For the definition, see domdef and the management of subdomains on the web. 
     808 </div> 
    841809             
    842810            <h4 id="_grille_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    843811               
    844                
    845                
    846                
    847                
    848                
    849                
    850                
    851             </h4> 
    852          
    853           <div class="comments"></div> 
     812              <span class="attr">out</span> 
     813              <span class="attr">optional</span> 
     814               
     815               
     816               
     817               
     818               
     819            </h4> 
     820         
     821          <div class="comments"> 
     822 For the definition, see domdef and the management of subdomains on the web. 
     823 </div> 
    854824             
    855825            <h4 id="_grille_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    856826               
    857                
    858                
    859                
    860                
    861                
    862                
    863                
    864             </h4> 
    865          
    866           <div class="comments"></div> 
     827              <span class="attr">out</span> 
     828              <span class="attr">optional</span> 
     829               
     830               
     831               
     832               
     833               
     834            </h4> 
     835         
     836          <div class="comments"> 
     837 For the definition, see domdef and the management of subdomains on the web. 
     838 </div> 
    867839             
    868840            <h4 id="_grille_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    869841               
    870                
    871                
    872                
    873                
    874                
    875                
    876                
    877             </h4> 
    878          
    879           <div class="comments"></div> 
     842              <span class="attr">out</span> 
     843              <span class="attr">optional</span> 
     844               
     845               
     846               
     847               
     848               
     849            </h4> 
     850         
     851          <div class="comments"> 
     852 For the definition, see domdef and the management of subdomains on the web. 
     853 </div> 
    880854             
    881855            <h4 id="_grille_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    882856               
    883                
    884                
    885                
    886                
    887                
    888                
    889                
    890             </h4> 
    891          
    892           <div class="comments"></div> 
     857              <span class="attr">out</span> 
     858              <span class="attr">optional</span> 
     859               
     860               
     861               
     862               
     863               
     864            </h4> 
     865         
     866          <div class="comments"> 
     867 For the definition, see domdef and the management of subdomains on the web. 
     868 </div> 
    893869             
    894870            <h4 id="_grille_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    895871               
    896                
    897                
    898                
    899                
    900                
    901                
    902                
    903             </h4> 
    904          
    905           <div class="comments"></div> 
     872              <span class="attr">out</span> 
     873              <span class="attr">optional</span> 
     874               
     875               
     876               
     877               
     878               
     879            </h4> 
     880         
     881          <div class="comments"> 
     882 For the definition, see domdef and the management of subdomains on the web. 
     883         </div> 
    906884             
    907885            <h4 id="_grille_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    908886               
    909                
    910                
    911                
    912                
    913                
    914                
    915                
    916             </h4> 
    917          
    918           <div class="comments"></div> 
     887              <span class="attr">out</span> 
     888              <span class="attr">optional</span> 
     889               
     890               
     891               
     892               
     893               
     894            </h4> 
     895         
     896          <div class="comments"> 
     897 For the definition, see domdef and the management of subdomains on the web. 
     898 </div> 
    919899             
    920900            <h4 id="_grille_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    921901               
    922                
    923                
    924                
    925                
    926                
    927                
    928                
    929             </h4> 
    930          
    931           <div class="comments"></div> 
     902              <span class="attr">out</span> 
     903              <span class="attr">optional</span> 
     904               
     905               
     906               
     907               
     908               
     909            </h4> 
     910         
     911          <div class="comments"> 
     912 For the definition, see domdef and the management of subdomains on the web. 
     913 </div> 
    932914             
    933915            <h4 id="_grille_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    934916               
    935                
    936                
    937                
    938                
    939                
    940                
    941                
    942             </h4> 
    943          
    944           <div class="comments"></div> 
     917              <span class="attr">out</span> 
     918              <span class="attr">optional</span> 
     919               
     920               
     921               
     922               
     923               
     924            </h4> 
     925         
     926          <div class="comments"> 
     927 For the definition, see domdef and the management of subdomains on the web. 
     928 </div> 
    945929             
    946930            <h4 id="_grille_param_e1">e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    947931               
    948                
    949                
    950                
    951                
    952                
    953                
    954                
    955             </h4> 
    956          
    957           <div class="comments"></div> 
     932              <span class="attr">out</span> 
     933              <span class="attr">optional</span> 
     934               
     935               
     936               
     937               
     938               
     939            </h4> 
     940         
     941          <div class="comments"> 
     942 For the definition, see domdef and the management of subdomains on the web. 
     943</div> 
    958944             
    959945            <h4 id="_grille_param_e2">e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    960946               
    961                
    962                
    963                
    964                
    965                
    966                
    967                
    968             </h4> 
    969          
    970           <div class="comments"></div> 
     947              <span class="attr">out</span> 
     948              <span class="attr">optional</span> 
     949               
     950               
     951               
     952               
     953               
     954            </h4> 
     955         
     956          <div class="comments"> 
     957 For the definition, see domdef and the management of subdomains on the web. 
     958 </div> 
    971959             
    972960            <h4 id="_grille_param_e3">e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    973961               
    974                
    975                
    976                
    977                
    978                
    979                
    980                
    981             </h4> 
    982          
    983           <div class="comments"></div> 
     962              <span class="attr">out</span> 
     963              <span class="attr">optional</span> 
     964               
     965               
     966               
     967               
     968               
     969            </h4> 
     970         
     971          <div class="comments"> 
     972 For the definition, see domdef and the management of subdomains on the web. 
     973</div> 
    984974             
    985975 
     
    1001991            </h4> 
    1002992         
     993            <div class="comments">  
     994 This keyword serve to obtain, thanks to grille, the triangulation which 
     995 refer to the grid but only on the part of the zoom. This of triangulation 
     996 is passed in the variable we have equate at TRI. 
     997 For example: grille,...,tri=triangulation_reduite. 
     998 This keyword is used in plt.pro 
     999</div> 
     1000             
     1001            <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1002               
     1003               
     1004               
     1005               
     1006               
     1007               
     1008               
     1009               
     1010            </h4> 
     1011         
     1012            <div class="comments"> 
     1013 Useful only when TRI is activated. In this case, grill send back -1 in the  
     1014 variable tri even if the variable of the common triangles_list is defined  
     1015 and different of-1 
     1016 </div> 
     1017             
     1018            <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1019               
     1020               
     1021               
     1022               
     1023               
     1024               
     1025               
     1026               
     1027            </h4> 
     1028         
     1029            <div class="comments"> 
     1030</div> 
     1031             
     1032            <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1033               
     1034               
     1035               
     1036               
     1037               
     1038               
     1039               
     1040               
     1041            </h4> 
     1042         
     1043            <div class="comments"> 
     1044 In plt, we want that land points, glam and gphi, be equal to glamt and  
     1045 gphit regardless of the grid. 
     1046</div> 
     1047             
     1048            <h4 id="_grille_keyword_IFPLTZ">IFPLTZ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1049               
     1050               
     1051               
     1052               
     1053               
     1054               
     1055               
     1056               
     1057            </h4> 
     1058         
    10031059            <div class="comments"></div> 
    10041060             
    1005             <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1061            <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10061062               
    10071063               
     
    10141070            </h4> 
    10151071         
    1016             <div class="comments"></div> 
    1017              
    1018             <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     1072            <div class="comments"> 
     1073 To specify that the field is at W depth instad of T  
     1074 depth (automatically activated if vargrid eq 'W') 
     1075 </div> 
     1076             
     1077            <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    10191078               
    10201079               
     
    10271086            </h4> 
    10281087         
    1029             <div class="comments"></div> 
    1030              
    1031             <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1032                
    1033                
    1034                
    1035                
    1036                
    1037                
    1038                
    1039                
    1040             </h4> 
    1041          
    1042             <div class="comments"></div> 
    1043              
    1044             <h4 id="_grille_keyword_IFPLTZ">IFPLTZ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1045                
    1046                
    1047                
    1048                
    1049                
    1050                
    1051                
    1052                
    1053             </h4> 
    1054          
    1055             <div class="comments"></div> 
    1056              
    1057             <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1058                
    1059                
    1060                
    1061                
    1062                
    1063                
    1064                
    1065                
    1066             </h4> 
    1067          
    1068             <div class="comments"></div> 
    1069              
    1070             <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    1071                
    1072                
    1073                
    1074                
    1075                
    1076                
    1077                
    1078                
    1079             </h4> 
    1080          
    1081             <div class="comments"></div> 
    1082              
    1083            
    1084  
    1085            
    1086            
    1087            
    1088            
    1089            
    1090            
    1091            
    1092            
    1093            
    1094            
    1095            
    1096            
    1097          
    1098            
    1099            
    1100            
    1101            
     1088            <div class="comments">  
     1089 Used to pass your keywords 
     1090</div> 
     1091             
     1092           
     1093 
     1094           
     1095          <h3>Version history</h3> 
     1096           
     1097          <h4>Version</h4><div class="preformat"> 
     1098 $Id$  
     1099</div> 
     1100          <h4>History</h4><div class="preformat"></div> 
     1101           
     1102           
     1103          <h3>Known issues</h3> 
     1104           
     1105           
     1106          <h4>Todo items</h4><div class="preformat"> Comment ecrire la remarque sur les inputs? 
     1107 </div> 
     1108          <h4>Restrictions</h4><div class="preformat">  
     1109 Use the variable vargrid 
     1110 
     1111 
     1112 Vargrid must be 'T', 'W', 'U', 'V' ou 'F' 
     1113</div> 
     1114         
     1115          <h3>Other attributes</h3> 
     1116           
     1117           
     1118          <h4>Uses routines</h4><div class="preformat"> 
     1119 cm_4mesh  
     1120 cm_4data 
     1121</div> 
    11021122           
    11031123           
Note: See TracChangeset for help on using the changeset viewer.