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

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs

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