source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/computegrid.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

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