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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 13.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 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and reduced at the domain defined by
93 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> (contrarily to
94 <pro>grandegrille</pro>)
95 BEWARE!! The choice of the grid is made from the value of the
96 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
97</div>
98
99     
100
101     
102
103     
104
105     
106
107      <div id="routine_details">
108       
109
110        <div class="routine_details" id="_grille">
111
112          <h2><a class="top" href="#container">top</a>grille <span class="categories">
113 Grid
114</span></h2>
115       
116          <p class="header">
117            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>
118       
119          <div class="comments">
120</div>
121
122         
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_grille_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129             
130              <span class="attr">out</span>
131              <span class="attr">optional</span>
132             
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments">
140 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
141</div>
142           
143            <h4 id="_grille_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144             
145              <span class="attr">out</span>
146              <span class="attr">optional</span>
147             
148             
149             
150             
151             
152            </h4>
153       
154          <div class="comments">
155 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
156</div>
157           
158            <h4 id="_grille_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160              <span class="attr">out</span>
161              <span class="attr">optional</span>
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments">
170 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
171</div>
172           
173            <h4 id="_grille_param_gdep">gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
174             
175              <span class="attr">out</span>
176              <span class="attr">optional</span>
177             
178             
179             
180             
181             
182            </h4>
183       
184          <div class="comments">
185 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
186</div>
187           
188            <h4 id="_grille_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190              <span class="attr">out</span>
191              <span class="attr">optional</span>
192             
193             
194             
195             
196             
197            </h4>
198       
199          <div class="comments">
200 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
201</div>
202           
203            <h4 id="_grille_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205              <span class="attr">out</span>
206              <span class="attr">optional</span>
207             
208             
209             
210             
211             
212            </h4>
213       
214          <div class="comments">
215 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
216</div>
217           
218            <h4 id="_grille_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220              <span class="attr">out</span>
221              <span class="attr">optional</span>
222             
223             
224             
225             
226             
227            </h4>
228       
229          <div class="comments">
230 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
231</div>
232           
233            <h4 id="_grille_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235              <span class="attr">out</span>
236              <span class="attr">optional</span>
237             
238             
239             
240             
241             
242            </h4>
243       
244          <div class="comments">
245 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
246</div>
247           
248            <h4 id="_grille_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250              <span class="attr">out</span>
251              <span class="attr">optional</span>
252             
253             
254             
255             
256             
257            </h4>
258       
259          <div class="comments">
260 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
261</div>
262           
263            <h4 id="_grille_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
264             
265              <span class="attr">out</span>
266              <span class="attr">optional</span>
267             
268             
269             
270             
271             
272            </h4>
273       
274          <div class="comments">
275 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
276</div>
277           
278            <h4 id="_grille_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279             
280              <span class="attr">out</span>
281              <span class="attr">optional</span>
282             
283             
284             
285             
286             
287            </h4>
288       
289          <div class="comments">
290 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
291</div>
292           
293            <h4 id="_grille_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
294             
295              <span class="attr">out</span>
296              <span class="attr">optional</span>
297             
298             
299             
300             
301             
302            </h4>
303       
304          <div class="comments">
305 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
306</div>
307           
308            <h4 id="_grille_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
309             
310              <span class="attr">out</span>
311              <span class="attr">optional</span>
312             
313             
314             
315             
316             
317            </h4>
318       
319          <div class="comments">
320 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
321</div>
322           
323            <h4 id="_grille_param_e1">e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
324             
325              <span class="attr">out</span>
326              <span class="attr">optional</span>
327             
328             
329             
330             
331             
332            </h4>
333       
334          <div class="comments">
335 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
336</div>
337           
338            <h4 id="_grille_param_e2">e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
339             
340              <span class="attr">out</span>
341              <span class="attr">optional</span>
342             
343             
344             
345             
346             
347            </h4>
348       
349          <div class="comments">
350 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
351</div>
352           
353            <h4 id="_grille_param_e3">e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
354             
355              <span class="attr">out</span>
356              <span class="attr">optional</span>
357             
358             
359             
360             
361             
362            </h4>
363       
364          <div class="comments">
365 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
366</div>
367           
368
369         
370
371         
372
373            <h3>Keywords</h3>
374           
375            <h4 id="_grille_keyword_TRI">TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
376             
377             
378             
379             
380             
381             
382             
383             
384            </h4>
385       
386            <div class="comments">
387 This keyword serve to obtain the triangulation which
388 refer to the grid but only on the part of the zoom. This array of triangulation
389 is passed in the variable we have equate at TRI.
390 For example: grille,...,tri=triangulation_reduite.
391 This keyword is used in <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
392</div>
393           
394            <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
395             
396             
397             
398             
399             
400             
401             
402             
403            </h4>
404       
405            <div class="comments">
406 Useful only when TRI is activated. In this case, grille send back -1 in the
407 variable tri even if the variable of the common triangles_list is defined
408 and different of -1
409</div>
410           
411            <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
412             
413             
414             
415             
416             
417             
418             
419             
420            </h4>
421       
422            <div class="comments">
423</div>
424           
425            <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
426             
427             
428             
429             
430             
431             
432             
433             
434            </h4>
435       
436            <div class="comments">
437 In <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>, we want that land points,
438 glam and gphi, be equal to glamt and
439 gphit regardless of the grid.
440</div>
441           
442            <h4 id="_grille_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
443             
444             
445             
446             
447             
448             
449             
450             
451            </h4>
452       
453            <div class="comments"></div>
454           
455            <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
456             
457             
458             
459             
460             
461             
462             
463             
464            </h4>
465       
466            <div class="comments">
467 To specify that the field is at W depth instead of T
468 depth (automatically activated if vargrid eq 'W')
469</div>
470           
471            <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
472             
473             
474             
475             
476             
477             
478             
479             
480            </h4>
481       
482            <div class="comments">
483 Used to pass keywords
484</div>
485           
486         
487
488         
489          <h3>Version history</h3>
490         
491          <h4>Version</h4><div class="preformat">
492 $Id: grille.pro 327 2007-12-13 16:22:35Z pinsard $
493</div>
494          <h4>History</h4><div class="preformat">
495  Sebastien Masson (smasson@lodyc.jussieu.fr)
496                        12/2/1999
497                       10/11/1999 /forplt
498</div>
499         
500         
501          <h3>Known issues</h3>
502         
503         
504          <h4>Todo items</h4><div class="preformat">
505 Comment ecrire la remarque sur les inputs?
506</div>
507          <h4>Restrictions</h4><div class="preformat">
508 Use the variable vargrid
509
510
511 Vargrid must be 'T', 'W', 'U', 'V' or 'F'
512</div>
513       
514          <h3>Other attributes</h3>
515         
516         
517          <h4>Uses routines</h4><div class="preformat">
518 cm_4mesh
519 cm_4data
520</div>
521         
522         
523         
524       
525          <h3>Statistics</h3>
526          <table class="statistics">
527            <tr><td>McCabe cyclic</td><td>          81</td></tr>
528            <tr><td>McCabe essential</td><td>           1</td></tr>
529            <tr><td>McCabe modular design</td><td>           1</td></tr>
530          </table>
531         
532       
533        </div>
534       
535      </div>
536
537     
538
539      <div id="tagline">Produced by IDLdoc 2.0.</div>
540
541    </div>
542
543  </body>
544</html>
Note: See TracBrowser for help on using the repository browser.