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

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation

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