source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/grille.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output

File size: 12.5 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>grille.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="grille.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/GRILLE//grille.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="fmask.html">&lt;&lt;prev file</a> | <a href="t2v.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="grille.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/GRILLE/</a></h1>
82      <h2 class="pro_file">grille.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Choose the grid which must be used to do the graph in function of
91 vargrid and send back corresponding parameters calculated in
92 domdef.pro and reduced at the domain defined by domdef (contrarily
93 to grandegrille.pro)
94 BEWARE!! The choice of the grid is made from the value of the
95 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
96</div>
97
98     
99
100     
101
102     
103
104     
105
106      <div id="routine_details">
107       
108
109        <div class="routine_details" id="_grille">
110
111          <h2><a class="top" href="#container">top</a>grille <span class="categories">
112</span></h2>
113       
114          <p class="header">
115            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_TYPE">TYPE</a>=<span class="result">TYPE</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>
116       
117          <div class="comments">
118</div>
119
120         
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_grille_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127             
128              <span class="attr">out</span>
129              <span class="attr">optional</span>
130             
131             
132             
133             
134             
135            </h4>
136       
137          <div class="comments">
138 For the definition, see domdef and the management of subdomains on the web.
139 </div>
140           
141            <h4 id="_grille_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142             
143              <span class="attr">out</span>
144              <span class="attr">optional</span>
145             
146             
147             
148             
149             
150            </h4>
151       
152          <div class="comments">
153 For the definition, see domdef and the management of subdomains on the web.
154 </div>
155           
156            <h4 id="_grille_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157             
158              <span class="attr">out</span>
159              <span class="attr">optional</span>
160             
161             
162             
163             
164             
165            </h4>
166       
167          <div class="comments">
168 For the definition, see domdef and the management of subdomains on the web.
169 </div>
170           
171            <h4 id="_grille_param_gdep">gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
172             
173              <span class="attr">out</span>
174              <span class="attr">optional</span>
175             
176             
177             
178             
179             
180            </h4>
181       
182          <div class="comments">
183 For the definition, see domdef and the management of subdomains on the web.
184 </div>
185           
186            <h4 id="_grille_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187             
188              <span class="attr">out</span>
189              <span class="attr">optional</span>
190             
191             
192             
193             
194             
195            </h4>
196       
197          <div class="comments">
198 For the definition, see domdef and the management of subdomains on the web.
199 </div>
200           
201            <h4 id="_grille_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202             
203              <span class="attr">out</span>
204              <span class="attr">optional</span>
205             
206             
207             
208             
209             
210            </h4>
211       
212          <div class="comments">
213 For the definition, see domdef and the management of subdomains on the web.
214 </div>
215           
216            <h4 id="_grille_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217             
218              <span class="attr">out</span>
219              <span class="attr">optional</span>
220             
221             
222             
223             
224             
225            </h4>
226       
227          <div class="comments">
228 For the definition, see domdef and the management of subdomains on the web.
229 </div>
230           
231            <h4 id="_grille_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233              <span class="attr">out</span>
234              <span class="attr">optional</span>
235             
236             
237             
238             
239             
240            </h4>
241       
242          <div class="comments">
243 For the definition, see domdef and the management of subdomains on the web.
244 </div>
245           
246            <h4 id="_grille_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248              <span class="attr">out</span>
249              <span class="attr">optional</span>
250             
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments">
258 For the definition, see domdef and the management of subdomains on the web.
259 </div>
260           
261            <h4 id="_grille_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262             
263              <span class="attr">out</span>
264              <span class="attr">optional</span>
265             
266             
267             
268             
269             
270            </h4>
271       
272          <div class="comments">
273 For the definition, see domdef and the management of subdomains on the web.
274         </div>
275           
276            <h4 id="_grille_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277             
278              <span class="attr">out</span>
279              <span class="attr">optional</span>
280             
281             
282             
283             
284             
285            </h4>
286       
287          <div class="comments">
288 For the definition, see domdef and the management of subdomains on the web.
289 </div>
290           
291            <h4 id="_grille_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
292             
293              <span class="attr">out</span>
294              <span class="attr">optional</span>
295             
296             
297             
298             
299             
300            </h4>
301       
302          <div class="comments">
303 For the definition, see domdef and the management of subdomains on the web.
304 </div>
305           
306            <h4 id="_grille_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
307             
308              <span class="attr">out</span>
309              <span class="attr">optional</span>
310             
311             
312             
313             
314             
315            </h4>
316       
317          <div class="comments">
318 For the definition, see domdef and the management of subdomains on the web.
319 </div>
320           
321            <h4 id="_grille_param_e1">e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
322             
323              <span class="attr">out</span>
324              <span class="attr">optional</span>
325             
326             
327             
328             
329             
330            </h4>
331       
332          <div class="comments">
333 For the definition, see domdef and the management of subdomains on the web.
334</div>
335           
336            <h4 id="_grille_param_e2">e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
337             
338              <span class="attr">out</span>
339              <span class="attr">optional</span>
340             
341             
342             
343             
344             
345            </h4>
346       
347          <div class="comments">
348 For the definition, see domdef and the management of subdomains on the web.
349 </div>
350           
351            <h4 id="_grille_param_e3">e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
352             
353              <span class="attr">out</span>
354              <span class="attr">optional</span>
355             
356             
357             
358             
359             
360            </h4>
361       
362          <div class="comments">
363 For the definition, see domdef and the management of subdomains on the web.
364</div>
365           
366
367         
368
369         
370
371            <h3>Keywords</h3>
372           
373            <h4 id="_grille_keyword_TRI">TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
374             
375             
376             
377             
378             
379             
380             
381             
382            </h4>
383       
384            <div class="comments"> 
385 This keyword serve to obtain, thanks to grille, the triangulation which
386 refer to the grid but only on the part of the zoom. This of triangulation
387 is passed in the variable we have equate at TRI.
388 For example: grille,...,tri=triangulation_reduite.
389 This keyword is used in plt.pro
390</div>
391           
392            <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
393             
394             
395             
396             
397             
398             
399             
400             
401            </h4>
402       
403            <div class="comments">
404 Useful only when TRI is activated. In this case, grill send back -1 in the
405 variable tri even if the variable of the common triangles_list is defined
406 and different of-1
407 </div>
408           
409            <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
410             
411             
412             
413             
414             
415             
416             
417             
418            </h4>
419       
420            <div class="comments">
421</div>
422           
423            <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
424             
425             
426             
427             
428             
429             
430             
431             
432            </h4>
433       
434            <div class="comments">
435 In plt, we want that land points, glam and gphi, be equal to glamt and
436 gphit regardless of the grid.
437</div>
438           
439            <h4 id="_grille_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
440             
441             
442             
443             
444             
445             
446             
447             
448            </h4>
449       
450            <div class="comments"></div>
451           
452            <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
453             
454             
455             
456             
457             
458             
459             
460             
461            </h4>
462       
463            <div class="comments">
464 To specify that the field is at W depth instead of T
465 depth (automatically activated if vargrid eq 'W')
466 </div>
467           
468            <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
469             
470             
471             
472             
473             
474             
475             
476             
477            </h4>
478       
479            <div class="comments"> 
480 Used to pass your keywords
481</div>
482           
483         
484
485         
486          <h3>Version history</h3>
487         
488          <h4>Version</h4><div class="preformat">
489 $Id: grille.pro 172 2006-09-11 07:11:26Z smasson $
490</div>
491          <h4>History</h4><div class="preformat">
492  Sebastien Masson (smasson@lodyc.jussieu.fr)
493                        12/2/1999
494                       10/11/1999 /forplt
495</div>
496         
497         
498          <h3>Known issues</h3>
499         
500         
501          <h4>Todo items</h4><div class="preformat"> Comment ecrire la remarque sur les inputs?
502 </div>
503          <h4>Restrictions</h4><div class="preformat"> 
504 Use the variable vargrid
505
506
507 Vargrid must be 'T', 'W', 'U', 'V' or 'F'
508</div>
509       
510          <h3>Other attributes</h3>
511         
512         
513          <h4>Uses routines</h4><div class="preformat">
514 cm_4mesh
515 cm_4data
516</div>
517         
518         
519         
520       
521          <h3>Statistics</h3>
522          <table class="statistics">
523            <tr><td>McCabe cyclic</td><td>          81</td></tr>
524            <tr><td>McCabe essential</td><td>           1</td></tr>
525            <tr><td>McCabe modular design</td><td>           1</td></tr>
526          </table>
527         
528       
529        </div>
530       
531      </div>
532
533     
534
535      <div id="tagline">Produced by IDLdoc 2.0.</div>
536
537    </div>
538
539  </body>
540</html>
Note: See TracBrowser for help on using the repository browser.