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

Last change on this file since 104 was 104, checked in by pinsard, 18 years ago

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation

File size: 10.2 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_grille">
103
104          <h2><a class="top" href="#container">top</a>grille </h2>
105       
106          <p class="header">
107            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_IFPLTZ">IFPLTZ</a>=<span class="result">IFPLTZ</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>
108       
109          <div class="comments">
110 NAME:grille
111
112 PURPOSE: choisit la grille qui doit etre utilisee pour faire le graphe en
113 fonction de vargrid et renvoie les parametres correspondants calcules ds
114 domdef.pro et reduit au domaine definit par domdef (contrairement a
115 grandegrille.pro)
116
117 CATEGORY:
118
119 CALLING SEQUENCE:
120  grille,mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz,lastx,lasty,lastz,e1,e2,e3
121
122 INPUTS:rien. ATTENTION les choix de la grille se fait a partir de la
123 valeur de la variable globale vargrid, qui peut etre egale a 'T',
124 'U', 'V', 'W' ou 'F'.
125
126 KEYWORD PARAMETERS:
127         TRI si ce mot clef sert a obtenir grace a grille la
128         triangulation qui se rapporte a la grille mais uniquement
129         sur la partie du zoom. ce tableau de triangulation reduit
130         est passe ds la variable que l''on a egalee a tri.par ex:
131         grille,...,tri=triangulation_reduite. ne mot clef est
132         utilise dans plt.pro
133
134         /FORPLT: ds plt on veut que sur les points terres, glam et
135         gphi soit egale a glamt et gphit quelle que soit la grille.
136
137         /NOTRI: utile seulement qd TRI est active. dans ce cas
138         grille retourne -1 ds la variable tri meme si la variable du
139         common triangles_list est definie et differente de -1
140
141         /WDEPTH: to specify that the field is at W depth instad of T
142         depth (automatically activated if vargrid eq 'W')
143
144 OUTPUTS:mask,glam,gphi,gdep,nx,ny,nz,firstx,firsty,firstz,
145         lastx,lasty,lastz,e1,e2,e3
146
147         pour leur definition cf domdef et la gestion des sous
148         domaines sur le web
149
150         Rq: ces outputs sont optionnels, si je veux recuperer que
151         mask, glam et gphi il suffit de taper grille, mask, glam, gphi
152
153 COMMON BLOCKS: cm_4mesh and cm_4data
154
155 SIDE EFFECTS: utilise la variable globale vargird
156
157 RESTRICTIONS: vargrid doit etre 'T', 'W', 'U', 'V' ou 'F'
158
159 EXAMPLE:
160</div>
161
162         
163
164         
165            <h3>Parameters</h3>
166       
167           
168            <h4 id="_grille_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments"></div>
180           
181            <h4 id="_grille_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192          <div class="comments"></div>
193           
194            <h4 id="_grille_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
195             
196             
197             
198             
199             
200             
201             
202             
203            </h4>
204       
205          <div class="comments"></div>
206           
207            <h4 id="_grille_param_gdep">gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
208             
209             
210             
211             
212             
213             
214             
215             
216            </h4>
217       
218          <div class="comments"></div>
219           
220            <h4 id="_grille_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231          <div class="comments"></div>
232           
233            <h4 id="_grille_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244          <div class="comments"></div>
245           
246            <h4 id="_grille_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
247             
248             
249             
250             
251             
252             
253             
254             
255            </h4>
256       
257          <div class="comments"></div>
258           
259            <h4 id="_grille_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
260             
261             
262             
263             
264             
265             
266             
267             
268            </h4>
269       
270          <div class="comments"></div>
271           
272            <h4 id="_grille_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273             
274             
275             
276             
277             
278             
279             
280             
281            </h4>
282       
283          <div class="comments"></div>
284           
285            <h4 id="_grille_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
286             
287             
288             
289             
290             
291             
292             
293             
294            </h4>
295       
296          <div class="comments"></div>
297           
298            <h4 id="_grille_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
299             
300             
301             
302             
303             
304             
305             
306             
307            </h4>
308       
309          <div class="comments"></div>
310           
311            <h4 id="_grille_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312             
313             
314             
315             
316             
317             
318             
319             
320            </h4>
321       
322          <div class="comments"></div>
323           
324            <h4 id="_grille_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
325             
326             
327             
328             
329             
330             
331             
332             
333            </h4>
334       
335          <div class="comments"></div>
336           
337            <h4 id="_grille_param_e1">e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
338             
339             
340             
341             
342             
343             
344             
345             
346            </h4>
347       
348          <div class="comments"></div>
349           
350            <h4 id="_grille_param_e2">e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
351             
352             
353             
354             
355             
356             
357             
358             
359            </h4>
360       
361          <div class="comments"></div>
362           
363            <h4 id="_grille_param_e3">e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
364             
365             
366             
367             
368             
369             
370             
371             
372            </h4>
373       
374          <div class="comments"></div>
375           
376
377         
378
379         
380
381            <h3>Keywords</h3>
382           
383            <h4 id="_grille_keyword_TRI">TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
384             
385             
386             
387             
388             
389             
390             
391             
392            </h4>
393       
394            <div class="comments"></div>
395           
396            <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
397             
398             
399             
400             
401             
402             
403             
404             
405            </h4>
406       
407            <div class="comments"></div>
408           
409            <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
410             
411             
412             
413             
414             
415             
416             
417             
418            </h4>
419       
420            <div class="comments"></div>
421           
422            <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
423             
424             
425             
426             
427             
428             
429             
430             
431            </h4>
432       
433            <div class="comments"></div>
434           
435            <h4 id="_grille_keyword_IFPLTZ">IFPLTZ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436             
437             
438             
439             
440             
441             
442             
443             
444            </h4>
445       
446            <div class="comments"></div>
447           
448            <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
449             
450             
451             
452             
453             
454             
455             
456             
457            </h4>
458       
459            <div class="comments"></div>
460           
461            <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
462             
463             
464             
465             
466             
467             
468             
469             
470            </h4>
471       
472            <div class="comments"></div>
473           
474         
475
476         
477         
478         
479         
480         
481         
482         
483         
484         
485         
486         
487         
488       
489         
490         
491         
492         
493         
494         
495         
496       
497         
498       
499        </div>
500       
501      </div>
502
503     
504
505      <div id="tagline">Produced by IDLdoc 2.0.</div>
506
507    </div>
508
509  </body>
510</html>
Note: See TracBrowser for help on using the repository browser.