source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/GRILLE/domdef.html @ 191

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 10.4 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>domdef.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="domdef.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" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/GRILLE//domdef.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" 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="decoupeterre.html">&lt;&lt;prev file</a> | <a href="f2v.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="domdef.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/GRILLE/</a></h1>
82      <h2 class="pro_file">domdef.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 Allows to extract a sub-domain of study by providing parameters
91 needed for drawings (see outputs)
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_domdef">
106
107          <h2><a class="top" href="#container">top</a>domdef <span class="categories">
108</span></h2>
109       
110          <p class="header">
111            domdef<span class="result">[, <a href="#_domdef_param_x1">x1</a>][, <a href="#_domdef_param_x2">x2</a>][, <a href="#_domdef_param_y1">y1</a>][, <a href="#_domdef_param_y2">y2</a>][, <a href="#_domdef_param_z1">z1</a>][, <a href="#_domdef_param_z2">z2</a>]</span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">string or vector</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">vector</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_domdef_param_x1">x1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125              <span class="attr">optional</span>
126             
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134 Define the minimum longitude. (All levels are selected)
135</div>
136           
137            <h4 id="_domdef_param_x2">x2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138              <span class="attr">in</span>
139             
140              <span class="attr">optional</span>
141             
142             
143             
144             
145             
146            </h4>
147       
148          <div class="comments">
149 Define the maximum longitude. (All levels are selected)
150</div>
151           
152            <h4 id="_domdef_param_y1">y1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153              <span class="attr">in</span>
154             
155              <span class="attr">optional</span>
156             
157             
158             
159             
160             
161            </h4>
162       
163          <div class="comments">
164 Define the minimum latitude. (All levels are selected)
165</div>
166           
167            <h4 id="_domdef_param_y2">y2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168              <span class="attr">in</span>
169             
170              <span class="attr">optional</span>
171             
172             
173             
174             
175             
176            </h4>
177       
178          <div class="comments">
179 Define the maximum latitude. (All levels are selected)
180</div>
181           
182            <h4 id="_domdef_param_z1">z1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183              <span class="attr">in</span>
184             
185              <span class="attr">optional</span>
186             
187             
188             
189             
190             
191            </h4>
192       
193          <div class="comments">
194 For a 3d domain whose the horizontal part cover all glam
195 </div>
196           
197            <h4 id="_domdef_param_z2">z2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198              <span class="attr">in</span>
199             
200              <span class="attr">optional</span>
201             
202             
203             
204             
205             
206            </h4>
207       
208          <div class="comments">
209 For a 3d domain whose the horizontal part cover all gphi
210</div>
211           
212
213         
214
215         
216
217            <h3>Keywords</h3>
218           
219            <h4 id="_domdef_keyword_FINDALWAYS">FINDALWAYS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220             
221             
222             
223             
224             
225             
226             
227             
228            </h4>
229       
230            <div class="comments">
231 Force to redefine a box even when none point is find in the box.
232 In this case, we select all the grid.
233</div>
234           
235            <h4 id="_domdef_keyword_GRIDTYPE">GRIDTYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241              <span class="attr">type:</span> <span class="value">string or vector</span>
242             
243             
244            </h4>
245       
246            <div class="comments">
247 It is a string or a vector of strings containing the grids's name
248 (Only determined by 'T','U','V','W','F') for which the calculation
249 must be done.
250  For example: 'T' or ['T','U']
251</div>
252           
253            <h4 id="_domdef_keyword_MEMEINDICES">MEMEINDICES&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
254             
255             
256             
257             
258             
259             
260             
261             
262            </h4>
263       
264            <div class="comments">
265 It is possible that points t,u,v and F correspond to a same geographic
266 box which do not concern the same array indexes. This is sometimes a
267 problem (or at least serious complications) in programs where several
268 type of grid intervene (see norme, curl...). Activate MEMEINDICE to
269 force domdef to take same indexes -those of the grid T- for all other
270 grids.
271</div>
272           
273            <h4 id="_domdef_keyword_XINDEX">XINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274             
275             
276             
277             
278             
279             
280             
281             
282            </h4>
283       
284            <div class="comments"> 
285 We activate it if we want that all elements passed in input of domdef
286 and concerning the X dimension refer to indexes of glam arrays rather
287 than to values of these arrays.
288</div>
289           
290            <h4 id="_domdef_keyword_YINDEX">YINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
291             
292             
293             
294             
295             
296             
297             
298             
299            </h4>
300       
301            <div class="comments"> 
302 We activate it if we want that all elements passed in input of domdef
303 and concerning the X dimension refer to indexes of gphi arrays rather
304 than to values of these arrays.
305 </div>
306           
307            <h4 id="_domdef_keyword_ZINDEX">ZINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
308             
309             
310             
311             
312             
313             
314             
315             
316            </h4>
317       
318            <div class="comments"> 
319 We activate it if we want that all elements passed in input of domdef
320 and concerning the X dimension refer to indexes of gdep arrays rather
321 than to values of these arrays.
322</div>
323           
324            <h4 id="_domdef_keyword_ENDPOINTS">ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
325             
326             
327             
328             
329             
330              <span class="attr">type:</span> <span class="value">vector</span>
331             
332             
333            </h4>
334       
335            <div class="comments">
336 A four elements vector [x1,y1,x2,y2] used to specify
337 that domdef must define the box used to make a plot (pltz, pltt,
338 plt1d) done strictly along the line (that can have any direction)
339 starting at (x1, y1) ending at (x2, y2). When defining endpoints,
340 you must also define TYPE which define the type of plots
341 ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used
342 ENDPOINTS keywords
343</div>
344           
345            <h4 id="_domdef_keyword_TYPE">TYPE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
346             
347             
348             
349             
350             
351             
352             
353             
354            </h4>
355       
356            <div class="comments"></div>
357           
358            <h4 id="_domdef_keyword_INDEX">INDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
359             
360             
361             
362             
363             
364             
365             
366             
367            </h4>
368       
369            <div class="comments"> 
370 We activate it if we want that all elements passed in input of domdef
371 refer to indexes of glam, gphi and gdep arrays rather than to values
372 of these arrays.
373</div>
374           
375            <h4 id="_domdef_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
376             
377             
378             
379             
380             
381             
382             
383             
384            </h4>
385       
386            <div class="comments"></div>
387           
388         
389
390         
391          <h3>Version history</h3>
392         
393          <h4>Version</h4><div class="preformat">
394 $Id: domdef.pro 163 2006-08-29 12:59:46Z navarro $
395</div>
396          <h4>History</h4><div class="preformat">
397 Sebastien Masson (smasson@lodyc.jussieu.fr)
398                        8/2/98
399 rewrite everything, debug and spee-up Sebastien Masson April 2005
400</div>
401         
402         
403          <h3>Known issues</h3>
404         
405         
406          <h4>Todo items</h4><div class="preformat"> seb: output pas clair/ pas d'input required?</div>
407         
408       
409          <h3>Other attributes</h3>
410         
411         
412          <h4>Uses routines</h4><div class="preformat">
413 common.pro
414
415</div>
416         
417         
418         
419       
420          <h3>Statistics</h3>
421          <table class="statistics">
422            <tr><td>McCabe cyclic</td><td>         206</td></tr>
423            <tr><td>McCabe essential</td><td>           2</td></tr>
424            <tr><td>McCabe modular design</td><td>           1</td></tr>
425          </table>
426         
427       
428        </div>
429       
430      </div>
431
432     
433
434      <div id="tagline">Produced by IDLdoc 2.0.</div>
435
436    </div>
437
438  </body>
439</html>
Note: See TracBrowser for help on using the repository browser.