source: trunk/SRC/Documentation/idldoc_html_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: 14.1 KB
RevLine 
[89]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>
[104]9    <title>grille.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="grille.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/GRILLE//grille.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/GRILLE/</a></h1>
[89]82      <h2 class="pro_file">grille.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]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
[290]92 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and reduced at the domain defined by
93 <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> (contrarily to
[234]94 <pro>grandegrille</pro>)
[402]95
[234]96 BEWARE!! The choice of the grid is made from the value of the
[142]97 global variable vargrid, which can be equal to 'T', 'U', 'V', 'W' ou 'F'.
98</div>
[89]99
100     
101
102     
103
104     
105
106     
107
108      <div id="routine_details">
109       
110
111        <div class="routine_details" id="_grille">
112
[142]113          <h2><a class="top" href="#container">top</a>grille <span class="categories">
[290]114 Grid
[142]115</span></h2>
[89]116       
117          <p class="header">
[402]118            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_GRID">GRID</a>=<span class="result">GRID</span>, <a href="#_grille_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
[89]119       
120          <div class="comments">
121</div>
122
123         
124
125         
126            <h3>Parameters</h3>
127       
128           
129            <h4 id="_grille_param_mask">mask&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
130             
[142]131              <span class="attr">out</span>
132              <span class="attr">optional</span>
[89]133             
134             
135             
136             
137             
138            </h4>
139       
[142]140          <div class="comments">
[290]141 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]142</div>
[89]143           
144            <h4 id="_grille_param_glam">glam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
[142]146              <span class="attr">out</span>
147              <span class="attr">optional</span>
[89]148             
149             
150             
151             
152             
153            </h4>
154       
[142]155          <div class="comments">
[290]156 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]157</div>
[89]158           
159            <h4 id="_grille_param_gphi">gphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
160             
[142]161              <span class="attr">out</span>
162              <span class="attr">optional</span>
[89]163             
164             
165             
166             
167             
168            </h4>
169       
[142]170          <div class="comments">
[290]171 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]172</div>
[89]173           
174            <h4 id="_grille_param_gdep">gdep&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
[142]176              <span class="attr">out</span>
177              <span class="attr">optional</span>
[89]178             
179             
180             
181             
182             
183            </h4>
184       
[142]185          <div class="comments">
[290]186 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]187</div>
[89]188           
189            <h4 id="_grille_param_nx">nx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
[142]191              <span class="attr">out</span>
192              <span class="attr">optional</span>
[89]193             
194             
195             
196             
197             
198            </h4>
199       
[142]200          <div class="comments">
[290]201 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]202</div>
[89]203           
204            <h4 id="_grille_param_ny">ny&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205             
[142]206              <span class="attr">out</span>
207              <span class="attr">optional</span>
[89]208             
209             
210             
211             
212             
213            </h4>
214       
[142]215          <div class="comments">
[290]216 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]217</div>
[89]218           
219            <h4 id="_grille_param_nz">nz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
[142]221              <span class="attr">out</span>
222              <span class="attr">optional</span>
[89]223             
224             
225             
226             
227             
228            </h4>
229       
[142]230          <div class="comments">
[290]231 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]232</div>
[89]233           
234            <h4 id="_grille_param_firstx">firstx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
[142]236              <span class="attr">out</span>
237              <span class="attr">optional</span>
[89]238             
239             
240             
241             
242             
243            </h4>
244       
[142]245          <div class="comments">
[290]246 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]247</div>
[89]248           
249            <h4 id="_grille_param_firsty">firsty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
250             
[142]251              <span class="attr">out</span>
252              <span class="attr">optional</span>
[89]253             
254             
255             
256             
257             
258            </h4>
259       
[142]260          <div class="comments">
[290]261 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]262</div>
[89]263           
264            <h4 id="_grille_param_firstz">firstz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
265             
[142]266              <span class="attr">out</span>
267              <span class="attr">optional</span>
[89]268             
269             
270             
271             
272             
273            </h4>
274       
[142]275          <div class="comments">
[290]276 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]277</div>
[89]278           
279            <h4 id="_grille_param_lastx">lastx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280             
[142]281              <span class="attr">out</span>
282              <span class="attr">optional</span>
[89]283             
284             
285             
286             
287             
288            </h4>
289       
[142]290          <div class="comments">
[290]291 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]292</div>
[89]293           
294            <h4 id="_grille_param_lasty">lasty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
295             
[142]296              <span class="attr">out</span>
297              <span class="attr">optional</span>
[89]298             
299             
300             
301             
302             
303            </h4>
304       
[142]305          <div class="comments">
[290]306 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]307</div>
[89]308           
309            <h4 id="_grille_param_lastz">lastz&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
310             
[142]311              <span class="attr">out</span>
312              <span class="attr">optional</span>
[89]313             
314             
315             
316             
317             
318            </h4>
319       
[142]320          <div class="comments">
[290]321 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]322</div>
[89]323           
324            <h4 id="_grille_param_e1">e1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
325             
[142]326              <span class="attr">out</span>
327              <span class="attr">optional</span>
[89]328             
329             
330             
331             
332             
333            </h4>
334       
[142]335          <div class="comments">
[290]336 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[142]337</div>
[89]338           
339            <h4 id="_grille_param_e2">e2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
340             
[142]341              <span class="attr">out</span>
342              <span class="attr">optional</span>
[89]343             
344             
345             
346             
347             
348            </h4>
349       
[142]350          <div class="comments">
[290]351 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[234]352</div>
[89]353           
354            <h4 id="_grille_param_e3">e3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
355             
[142]356              <span class="attr">out</span>
357              <span class="attr">optional</span>
[89]358             
359             
360             
361             
362             
363            </h4>
364       
[142]365          <div class="comments">
[290]366 For the definition, see <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> and the management of subdomains on the web.
[142]367</div>
[89]368           
369
370         
371
372         
373
374            <h3>Keywords</h3>
375           
376            <h4 id="_grille_keyword_TRI">TRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
377             
378             
379             
380             
381             
382             
383             
384             
385            </h4>
386       
[234]387            <div class="comments">
[290]388 This keyword serve to obtain the triangulation which
389 refer to the grid but only on the part of the zoom. This array of triangulation
[142]390 is passed in the variable we have equate at TRI.
391 For example: grille,...,tri=triangulation_reduite.
[242]392 This keyword is used in <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>.
[142]393</div>
[89]394           
395            <h4 id="_grille_keyword_NOTRI">NOTRI&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
396             
397             
398             
399             
400             
401             
402             
403             
404            </h4>
405       
[142]406            <div class="comments">
[290]407 Useful only when TRI is activated. In this case, grille send back -1 in the
[234]408 variable tri even if the variable of the common triangles_list is defined
409 and different of -1
410</div>
[89]411           
412            <h4 id="_grille_keyword_TOUT">TOUT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
413             
414             
415             
416             
417             
418             
419             
420             
421            </h4>
422       
[142]423            <div class="comments">
424</div>
[89]425           
426            <h4 id="_grille_keyword_FORPLT">FORPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
427             
428             
429             
430             
431             
432             
433             
434             
435            </h4>
436       
[142]437            <div class="comments">
[242]438 In <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt.html">plt</a>, we want that land points,
[234]439 glam and gphi, be equal to glamt and
[142]440 gphit regardless of the grid.
441</div>
[89]442           
[177]443            <h4 id="_grille_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[89]444             
445             
446             
447             
448             
449             
450             
451             
452            </h4>
453       
454            <div class="comments"></div>
455           
456            <h4 id="_grille_keyword_WDEPTH">WDEPTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
457             
458             
459             
460             
461             
462             
[402]463              <span class="attr">default:</span> <span class="value">0</span>
[89]464             
465            </h4>
466       
[402]467            <div class="comments"> 
[234]468 To specify that the field is at W depth instead of T
[142]469 depth (automatically activated if vargrid eq 'W')
[234]470</div>
[89]471           
[402]472            <h4 id="_grille_keyword_GRID">GRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
473             
474             
475             
476             
477             
478             
479              <span class="attr">default:</span> <span class="value">vargrid defined in <a href="../..//Commons/cm_4data.html">cm_4data</a></span>
480             
481            </h4>
482       
483            <div class="comments"> 
484 To specify on which grid are located the data
485</div>
486           
[89]487            <h4 id="_grille_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
488             
489             
490             
491             
492             
493             
494             
495             
496            </h4>
497       
[234]498            <div class="comments">
499 Used to pass keywords
[142]500</div>
[89]501           
502         
503
504         
[142]505          <h3>Version history</h3>
[89]506         
[142]507          <h4>Version</h4><div class="preformat">
[402]508 $Id: grille.pro 388 2008-12-09 09:36:41Z smasson $
[142]509</div>
[157]510          <h4>History</h4><div class="preformat">
511  Sebastien Masson (smasson@lodyc.jussieu.fr)
512                        12/2/1999
513                       10/11/1999 /forplt
514</div>
[89]515         
516         
[142]517          <h3>Known issues</h3>
[89]518         
519         
[234]520          <h4>Todo items</h4><div class="preformat">
521 Comment ecrire la remarque sur les inputs?
522</div>
523          <h4>Restrictions</h4><div class="preformat">
[142]524 Use the variable vargrid
525
526
[163]527 Vargrid must be 'T', 'W', 'U', 'V' or 'F'
[142]528</div>
[89]529       
[142]530          <h3>Other attributes</h3>
[89]531         
532         
[142]533          <h4>Uses routines</h4><div class="preformat">
[402]534 <a href="../..//Commons/cm_4mesh.html">cm_4mesh</a>
535 <a href="../..//Commons/cm_4data.html">cm_4data</a>
[142]536</div>
[89]537         
538         
539         
540       
[163]541          <h3>Statistics</h3>
542          <table class="statistics">
[402]543            <tr><td>McCabe cyclic</td><td>          82</td></tr>
[163]544            <tr><td>McCabe essential</td><td>           1</td></tr>
545            <tr><td>McCabe modular design</td><td>           1</td></tr>
546          </table>
[89]547         
548       
549        </div>
550       
551      </div>
552
553     
554
555      <div id="tagline">Produced by IDLdoc 2.0.</div>
556
557    </div>
558
559  </body>
[249]560</html>
Note: See TracBrowser for help on using the repository browser.