source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/GRILLE/grille.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation

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