source: trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.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: 15.9 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>computegrid.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="computegrid.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&lt;&lt; prev file | <a href="micromeshmask.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="computegrid.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">Grid/</a></h1>
82      <h2 class="pro_file">computegrid.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> compute the grid parameters from cm_4mesh common:
90
91       computegrid, startx, starty, stepx, stepy, nx, ny
92       computegrid, startx, starty, stepx, stepy
93       computegrid, xaxis = xaxis, yaxis = yaxis
94       or a suitable mix...
95
96 horizontal parameters:
97       glam[tf], gphi[tf], e1t and e2t
98    and if FULLCGRID keyword is defined:
99       glam[uv], gphi[uv], e1[uvf] and e2[uvf]
100     
101 verticals parameters:
102       gdep[tw], e3[tw]
103
104 masks: tmask
105        and if FULLCGRID keyword is defined:[uv]maskred fmaskred[xy]
106
107 triangulation: triangles_list
108
109 key_ parameters:
110       key_shift, key_periodic, key_zreverse, key_yreverse,
111       key_stride, key_onearth, key_partialstep
112</div>
113
114     
115
116     
117
118     
119
120     
121
122      <div id="routine_details">
123       
124
125        <div class="routine_details" id="_computegrid">
126
127          <h2><a class="top" href="#container">top</a>computegrid <span class="categories"> grid
128</span></h2>
129       
130          <p class="header">
131            computegrid<span class="result">, <a href="#_computegrid_param_startx">startx</a>, <a href="#_computegrid_param_starty">starty</a>, <a href="#_computegrid_param_stepxin">stepxin</a>, <a href="#_computegrid_param_stepyin">stepyin</a>, <a href="#_computegrid_param_nxin">nxin</a>, <a href="#_computegrid_param_nyin">nyin</a></span>, <a href="#_computegrid_keyword_XAXIS">XAXIS</a>=<span class="result">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
132       
133          <div class="comments">
134</div>
135
136         
137
138         
139            <h3>Parameters</h3>
140       
141           
142            <h4 id="_computegrid_param_startx">startx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143              <span class="attr">in</span>
144             
145             
146              <span class="attr">required</span>
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments"> scalar, x starting point</div>
154           
155            <h4 id="_computegrid_param_starty">starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158             
159              <span class="attr">required</span>
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments"> scalar, y starting point</div>
167           
168            <h4 id="_computegrid_param_stepxin">stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169              <span class="attr">in</span>
170             
171             
172              <span class="attr">required</span>
173             
174             
175             
176             
177            </h4>
178       
179          <div class="comments"> scalar or vector: x direction step, must be > 0
180             if vector nx is not used</div>
181           
182            <h4 id="_computegrid_param_stepyin">stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183              <span class="attr">in</span>
184             
185             
186              <span class="attr">required</span>
187             
188             
189             
190             
191            </h4>
192       
193          <div class="comments"> scalar or vector: y direction step,
194             could be > 0 (south to north) or < 0 (north to south)
195             if vector ny is not used</div>
196           
197            <h4 id="_computegrid_param_nxin">nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198              <span class="attr">in</span>
199             
200             
201              <span class="attr">required</span>
202             
203             
204             
205             
206            </h4>
207       
208          <div class="comments"> scalar, number of points in x direction </div>
209           
210            <h4 id="_computegrid_param_nyin">nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
211              <span class="attr">in</span>
212             
213             
214              <span class="attr">required</span>
215             
216             
217             
218             
219            </h4>
220       
221          <div class="comments"> scalar, number of points in y direction
222</div>
223           
224
225         
226
227         
228
229            <h3>Keywords</h3>
230           
231            <h4 id="_computegrid_keyword_XAXIS">XAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233             
234             
235             
236             
237             
238             
239             
240            </h4>
241       
242            <div class="comments"> to specify longitude1 with a 1 or 2 dimension array, in
243       this case startx, stepx and nx are not used but could be
244       necessary if the y axis is not defined with yaxis. It must be
245       possible to sort the first line of xaxis in the increasing
246       order by shifting its elements.
247</div>
248           
249            <h4 id="_computegrid_keyword_YAXIS">YAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
250             
251             
252             
253             
254             
255             
256             
257             
258            </h4>
259       
260            <div class="comments"> to specify latitudes with a 1 or 2 dimension array, in
261       this case starty, stepy and ny are not used but starty and
262       stepy could be necessary if the x axis is not defined with xaxis.
263       It must be sorted in the increasing or deceasing order
264       (along each column if 2d array).
265</div>
266           
267            <h4 id="_computegrid_keyword_ZAXIS">ZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268             
269             
270             
271             
272             
273             
274             
275             
276            </h4>
277       
278            <div class="comments"> to specify the vertical axis with a 1 dimension
279       array. Must be sorted in the increasing or deceasing order
280</div>
281           
282            <h4 id="_computegrid_keyword_MASK">MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293            <div class="comments"> to specify the mask with a 2 or 3 dimension array
294</div>
295           
296            <h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
297             
298             
299             
300             
301             
302             
303             
304             
305            </h4>
306       
307            <div class="comments"> a 2 elements vector, [lon1,lon2], the longitute
308       boundaries that should be used to visualize the data.
309       we must have lon2 > lon1 and lon2 - lon1 le 360
310       key_shift will be defined automaticaly computed according to
311       glamboundary by using the FIRST LINE of glamt but
312       key_shift will /= 0 only if key_periodic = 1
313</div>
314           
315            <h4 id="_computegrid_keyword_XMINMESH">XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
316             
317             
318             
319             
320             
321             
322             
323             
324            </h4>
325       
326            <div class="comments"> </div>
327           
328            <h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
329             
330             
331             
332             
333             
334             
335             
336             
337            </h4>
338       
339            <div class="comments"> </div>
340           
341            <h4 id="_computegrid_keyword_YMINMESH">YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
342             
343             
344             
345             
346             
347             
348             
349             
350            </h4>
351       
352            <div class="comments"> </div>
353           
354            <h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
355             
356             
357             
358             
359             
360             
361             
362             
363            </h4>
364       
365            <div class="comments"> </div>
366           
367            <h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
368             
369             
370             
371             
372             
373             
374             
375             
376            </h4>
377       
378            <div class="comments"> 
379       to define the common variables i[xyz]minmesh
380       used to define the grid only in a zoomed part of the original
381       grid. Defaut values are 0L, max value is [XYZ]MAXMESH
382</div>
383           
384            <h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385             
386             
387             
388             
389             
390             
391             
392             
393            </h4>
394       
395            <div class="comments"> 
396       to define the common variables i[xyz]maxmesh
397       used to define the grid only in a zoomed part of the original
398       grid. Defaut values are jp[ijk]glo-1, max value is
399       jp[ijk]glo-1. if [XYZ]MAXMESH is negative, then we define
400       i[xyz]maxmesh as jp[ijk]glo - 1 + [XYZ]MAXMESH instead of
401       [XYZ]MAXMESH     
402</div>
403           
404            <h4 id="_computegrid_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
405             
406             
407             
408             
409             
410             
411             
412             
413            </h4>
414       
415            <div class="comments"> = 0 or 1 to force the manual definition of
416       key_onearth (to specify if the data are on earth -> use longitude
417       /latitude etc...). By default, key_onearth = 1.
418       note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0,
419       and is cancelling GLAMBOUNDARY
420</div>
421           
422            <h4 id="_computegrid_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
423             
424             
425             
426             
427             
428             
429             
430             
431            </h4>
432       
433            <div class="comments"> = 0 or 1 to force the manual definition of
434       key_periodic. By default, key_periodic is automaticaly
435       computed by using the first line of glamt.
436</div>
437           
438            <h4 id="_computegrid_keyword_PLAIN">PLAIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
439             
440             
441             
442             
443             
444             
445             
446             
447            </h4>
448       
449            <div class="comments"> force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and
450       suppress the automatic redefinition of the domain in case of
451       x periodicity overlap, y periodicity overlap (ORCA type only)
452       and mask border to 0.
453</div>
454           
455            <h4 id="_computegrid_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
456             
457             
458             
459             
460             
461             
462             
463             
464            </h4>
465       
466            <div class="comments"> = scalar to force the manual definition of key_shift. By
467       debault, key_shift is automaticaly computed according to
468       glamboundary (when defined) by using the FIRST LINE of glamt. if
469       key_periodic=0 then in any case key_shift = 0.
470</div>
471           
472            <h4 id="_computegrid_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
473             
474             
475             
476             
477             
478             
479             
480             
481            </h4>
482       
483            <div class="comments">  a 3 elements vector to specify the stride in x, y, z
484       direction. Default definition is [1, 1, 1]. The resulting value
485       will be stored in the common (cm_4mesh) variable key_stride
486</div>
487           
488            <h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
489             
490             
491             
492             
493             
494             
495             
496             
497            </h4>
498       
499            <div class="comments"> activate to specify that you want to compute
500       all the paremeters of a C grid. Computation of glam[uv],
501       gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy]
502       will be add to the default computations
503</div>
504           
505            <h4 id="_computegrid_keyword_XYINDEX">XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
506             
507             
508             
509             
510             
511             
512             
513             
514            </h4>
515       
516            <div class="comments"> activate to specify that the horizontal grid should
517       be simply defined by using the index of the points
518          (xaxis = findgen(nx) and yaxis = findgen(ny))
519       using this keyword forces key_onearth=0
520</div>
521           
522            <h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
523             
524             
525             
526             
527             
528             
529             
530             
531            </h4>
532       
533            <div class="comments"></div>
534           
535            <h4 id="_computegrid_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
536             
537             
538             
539             
540             
541             
542             
543             
544            </h4>
545       
546            <div class="comments"> a string containing the calling command used to
547       call computegrid (this is used by xxx.pro)
548</div>
549           
550            <h4 id="_computegrid_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
551             
552             
553             
554             
555             
556             
557             
558             
559            </h4>
560       
561            <div class="comments"></div>
562           
563         
564
565         
566          <h3>Version history</h3>
567         
568         
569          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
570                      2000-04-20
571  Sept 2004, several bug fixs to suit C grid type...
572  Aug 2005, rewritte almost everything...</div>
573         
574         
575          <h3>Known issues</h3>
576         
577         
578         
579          <h4>Restrictions</h4><div class="value"> if the grid has x/y periodicity orverlap and/or if
580    the mask has 0 everywhere at the border (like a close sea) and
581    if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
582    ymaxmesh keywords are defined to their default values), we redefine
583    xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the
584    overlapping part and/or to open the domain (avoid ti be forced
585    to use cell_fill = 1).
586
587 FUV points definition...
588</div>
589       
590          <h3>Other attributes</h3>
591         
592         
593          <h4>Uses routines</h4><div class="value"> cm_4mesh cm_4data cm_4cal
594</div>
595         
596         
597         
598       
599         
600       
601        </div>
602       
603      </div>
604
605     
606
607      <div id="tagline">Produced by IDLdoc 2.0.</div>
608
609    </div>
610
611  </body>
612</html>
Note: See TracBrowser for help on using the repository browser.