source: trunk/SRC/Documentation/idldoc_assistant_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: 12.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>grille.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="fmask.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="t2v.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/GRILLE/</font></h1>
58    <h2>grille.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Choose the grid which must be used to do the graph in function of
65 vargrid and send back corresponding parameters calculated in
66 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and reduced at the domain defined by
67 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> (contrarily to
68 <pro>grandegrille</pro>)
69 BEWARE!! The choice of the grid is made from the value of the
70 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
71
72
73   
74
75     
76      <a name="#_grille"></a>
77
78      <h2>grille  <font size="-1" color="#006633">
79 Grid
80</font></h2>
81
82      <p><font face="Courier">grille<i>[, <a href="#_grille_keyword_mask">mask</a>][, <a href="#_grille_keyword_glam">glam</a>][, <a href="#_grille_keyword_gphi">gphi</a>][, <a href="#_grille_keyword_gdep">gdep</a>][, <a href="#_grille_keyword_nx">nx</a>][, <a href="#_grille_keyword_ny">ny</a>][, <a href="#_grille_keyword_nz">nz</a>][, <a href="#_grille_keyword_firstx">firstx</a>][, <a href="#_grille_keyword_firsty">firsty</a>][, <a href="#_grille_keyword_firstz">firstz</a>][, <a href="#_grille_keyword_lastx">lastx</a>][, <a href="#_grille_keyword_lasty">lasty</a>][, <a href="#_grille_keyword_lastz">lastz</a>][, <a href="#_grille_keyword_e1">e1</a>][, <a href="#_grille_keyword_e2">e2</a>][, <a href="#_grille_keyword_e3">e3</a>]</i>, <a href="#_grille_keyword_TRI">TRI</a>=<i>TRI</i>, <a href="#_grille_keyword_NOTRI">NOTRI</a>=<i>NOTRI</i>, <a href="#_grille_keyword_TOUT">TOUT</a>=<i>TOUT</i>, <a href="#_grille_keyword_FORPLT">FORPLT</a>=<i>FORPLT</i>, <a href="#_grille_keyword_TYPE">TYPE</a>=<i>TYPE</i>, <a href="#_grille_keyword_WDEPTH">WDEPTH</a>=<i>WDEPTH</i>, <a href="#_grille_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
83
84   
85
86
87   
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_grille_keyword_mask"></a>
94    <h4>mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95     
96      <font size="-1" color="#006633">out</font>
97      <font size="-1" color="#006633">optional</font>
98     
99     
100     
101     
102     
103    </h4>
104
105   
106 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
107
108   
109
110    <a name="#_grille_keyword_glam"></a>
111    <h4>glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113      <font size="-1" color="#006633">out</font>
114      <font size="-1" color="#006633">optional</font>
115     
116     
117     
118     
119     
120    </h4>
121
122   
123 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
124
125   
126
127    <a name="#_grille_keyword_gphi"></a>
128    <h4>gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130      <font size="-1" color="#006633">out</font>
131      <font size="-1" color="#006633">optional</font>
132     
133     
134     
135     
136     
137    </h4>
138
139   
140 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
141
142   
143
144    <a name="#_grille_keyword_gdep"></a>
145    <h4>gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147      <font size="-1" color="#006633">out</font>
148      <font size="-1" color="#006633">optional</font>
149     
150     
151     
152     
153     
154    </h4>
155
156   
157 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
158
159   
160
161    <a name="#_grille_keyword_nx"></a>
162    <h4>nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164      <font size="-1" color="#006633">out</font>
165      <font size="-1" color="#006633">optional</font>
166     
167     
168     
169     
170     
171    </h4>
172
173   
174 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
175
176   
177
178    <a name="#_grille_keyword_ny"></a>
179    <h4>ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
180     
181      <font size="-1" color="#006633">out</font>
182      <font size="-1" color="#006633">optional</font>
183     
184     
185     
186     
187     
188    </h4>
189
190   
191 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
192
193   
194
195    <a name="#_grille_keyword_nz"></a>
196    <h4>nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
197     
198      <font size="-1" color="#006633">out</font>
199      <font size="-1" color="#006633">optional</font>
200     
201     
202     
203     
204     
205    </h4>
206
207   
208 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
209
210   
211
212    <a name="#_grille_keyword_firstx"></a>
213    <h4>firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214     
215      <font size="-1" color="#006633">out</font>
216      <font size="-1" color="#006633">optional</font>
217     
218     
219     
220     
221     
222    </h4>
223
224   
225 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
226
227   
228
229    <a name="#_grille_keyword_firsty"></a>
230    <h4>firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
231     
232      <font size="-1" color="#006633">out</font>
233      <font size="-1" color="#006633">optional</font>
234     
235     
236     
237     
238     
239    </h4>
240
241   
242 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
243
244   
245
246    <a name="#_grille_keyword_firstz"></a>
247    <h4>firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
248     
249      <font size="-1" color="#006633">out</font>
250      <font size="-1" color="#006633">optional</font>
251     
252     
253     
254     
255     
256    </h4>
257
258   
259 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
260
261   
262
263    <a name="#_grille_keyword_lastx"></a>
264    <h4>lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
265     
266      <font size="-1" color="#006633">out</font>
267      <font size="-1" color="#006633">optional</font>
268     
269     
270     
271     
272     
273    </h4>
274
275   
276 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
277
278   
279
280    <a name="#_grille_keyword_lasty"></a>
281    <h4>lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
282     
283      <font size="-1" color="#006633">out</font>
284      <font size="-1" color="#006633">optional</font>
285     
286     
287     
288     
289     
290    </h4>
291
292   
293 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
294
295   
296
297    <a name="#_grille_keyword_lastz"></a>
298    <h4>lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
299     
300      <font size="-1" color="#006633">out</font>
301      <font size="-1" color="#006633">optional</font>
302     
303     
304     
305     
306     
307    </h4>
308
309   
310 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
311
312   
313
314    <a name="#_grille_keyword_e1"></a>
315    <h4>e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316     
317      <font size="-1" color="#006633">out</font>
318      <font size="-1" color="#006633">optional</font>
319     
320     
321     
322     
323     
324    </h4>
325
326   
327 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
328
329   
330
331    <a name="#_grille_keyword_e2"></a>
332    <h4>e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
333     
334      <font size="-1" color="#006633">out</font>
335      <font size="-1" color="#006633">optional</font>
336     
337     
338     
339     
340     
341    </h4>
342
343   
344 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
345
346   
347
348    <a name="#_grille_keyword_e3"></a>
349    <h4>e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
350     
351      <font size="-1" color="#006633">out</font>
352      <font size="-1" color="#006633">optional</font>
353     
354     
355     
356     
357     
358    </h4>
359
360   
361 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
362
363   
364   
365
366   
367    <h3>Keywords</h3>
368
369   
370    <a name="#_grille_keyword_TRI"></a>
371    <h4>TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372     
373     
374     
375     
376     
377     
378     
379     
380    </h4>
381
382   
383 This keyword serve to obtain the triangulation which
384 refer to the grid but only on the part of the zoom. This array of triangulation
385 is passed in the variable we have equate at TRI.
386 For example: grille,...,tri=triangulation_reduite.
387 This keyword is used in <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
388
389   
390    <a name="#_grille_keyword_NOTRI"></a>
391    <h4>NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
392     
393     
394     
395     
396     
397     
398     
399     
400    </h4>
401
402   
403 Useful only when TRI is activated. In this case, grille send back -1 in the
404 variable tri even if the variable of the common triangles_list is defined
405 and different of -1
406
407   
408    <a name="#_grille_keyword_TOUT"></a>
409    <h4>TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
410     
411     
412     
413     
414     
415     
416     
417     
418    </h4>
419
420   
421
422   
423    <a name="#_grille_keyword_FORPLT"></a>
424    <h4>FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
425     
426     
427     
428     
429     
430     
431     
432     
433    </h4>
434
435   
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
440   
441    <a name="#_grille_keyword_TYPE"></a>
442    <h4>TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
443     
444     
445     
446     
447     
448     
449     
450     
451    </h4>
452
453   
454   
455    <a name="#_grille_keyword_WDEPTH"></a>
456    <h4>WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
457     
458     
459     
460     
461     
462     
463     
464     
465    </h4>
466
467   
468 To specify that the field is at W depth instead of T
469 depth (automatically activated if vargrid eq 'W')
470
471   
472    <a name="#_grille_keyword__EXTRA"></a>
473    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
474     
475     
476     
477     
478     
479     
480     
481     
482    </h4>
483
484   
485 Used to pass keywords
486
487   
488   
489
490   
491    </pre><h3>Version history</h3>
492   
493    <h4>Version</h4>
494 $Id: grille.pro 327 2007-12-13 16:22:35Z pinsard $
495
496    <h4>History</h4>
497  Sebastien Masson (smasson@lodyc.jussieu.fr)
498                        12/2/1999
499                       10/11/1999 /forplt
500
501   
502
503    <h3>Known issues</h3>
504   
505   
506    <h4>Todo items</h4>
507 Comment ecrire la remarque sur les inputs?
508
509    <h4>Restrictions</h4>
510 Use the variable vargrid
511
512
513 Vargrid must be 'T', 'W', 'U', 'V' or 'F'
514
515
516    <h3>Other attributes</h3>
517   
518   
519    <h4>Uses routines</h4>
520 cm_4mesh
521 cm_4data
522
523   
524   
525   
526
527    <font size="-3"><p>&nbsp;</p></font>
528    <hr size="1" color="#CCCCCC"/>
529     
530
531   
532
533    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
534
535  </body>
536</html>
Note: See TracBrowser for help on using the repository browser.