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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 24.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   
64 compute the grid parameters (cm_4mesh) common
65
66 domains sizes:
67 ---------------
68 jpi, jpj, jpk, jpiglo, jpjglo, jpkglo, jpidta, jpjdta, jpkdta
69
70 domains positions regarding to the original grid:
71 --------------------------------------------------
72 ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh
73 ixmindta, ixmaxdta, iymindta, iymaxdta, izmindta, izmaxdta
74
75 horizontal parameters:
76 ----------------------
77 glamt, glamf, gphit, gphit, e1t, e2t
78
79 additional horizontal parameters if FULLCGRID keyword is defined:
80 -----------------------------------------------------------------
81 glamu, glamv, gphiu, gphiv, e1u, e1v, e1f, e2u, e2v, e2f
82
83 verticals parameters:
84 ---------------------
85 gdept, gdepw, e3t, e3w
86
87 masks:
88 ------
89 tmask
90
91 additional masks if FULLCGRID keyword is defined:
92 -------------------------------------------------
93 umaskred, vmaskred, fmaskredx, fmaskredy
94
95 triangles_list:
96 ---------------
97 triangulation
98
99 key_* variables:
100 ----------------
101 key_onearth, key_periodic, key_shift, key_stride, key_partialstep,
102 key_yreverse, key_zreverse, key_gridtype
103
104 xxx related variables:
105 ----------------------
106 ccmeshparameters, ccreadparameters
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>1D or 2D array</i>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<i>1D or 2D array</i>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<i>1D</i>, <a href="#_computegrid_keyword_MASK">MASK</a>=<i>2D or 3D array</i>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>2 elements vector</i>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<i>scalar</i>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<i>3 elements vector</i>, <a href="#_computegrid_keyword_YREVERSE">YREVERSE</a>=<i>scalar</i>, <a href="#_computegrid_keyword_ZREVERSE">ZREVERSE</a>=<i>scalar</i>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<i>scalar: 0 or 1</i>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<i>XYINDEX</i>, <a href="#_computegrid_keyword_UBASE2TBASE">UBASE2TBASE</a>=<i>UBASE2TBASE</i>, <a href="#_computegrid_keyword_VBASE2TBASE">VBASE2TBASE</a>=<i>VBASE2TBASE</i>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<i>FBASE2TBASE</i>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<i>scalar string</i>, <a href="#_computegrid_keyword_ROMSH">ROMSH</a>=<i>2D array</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      <font size="-1" color="#006633">optional</font>
134     
135     
136      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
137     
138     
139    </h4>
140
141   
142       x starting point, optional if [XY]AXIS keyword is used
143
144   
145
146    <a name="#_computegrid_keyword_starty"></a>
147    <h4>starty&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148      <font size="-1" color="#006633">in</font>
149     
150      <font size="-1" color="#006633">optional</font>
151     
152     
153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
154     
155     
156    </h4>
157
158   
159       y starting point, optional if [XY]AXIS keyword is used
160
161   
162
163    <a name="#_computegrid_keyword_stepxin"></a>
164    <h4>stepxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165      <font size="-1" color="#006633">in</font>
166     
167      <font size="-1" color="#006633">optional</font>
168     
169     
170      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar or vector</i></font>
171     
172     
173    </h4>
174
175   
176       x direction step, optional if [XY]AXIS keyword is used, must be > 0
177       if stepxin is a vector nx is not used
178
179   
180
181    <a name="#_computegrid_keyword_stepyin"></a>
182    <h4>stepyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183      <font size="-1" color="#006633">in</font>
184     
185      <font size="-1" color="#006633">optional</font>
186     
187     
188      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar or vector</i></font>
189     
190     
191    </h4>
192
193   
194       y direction step, optional if [XY]AXIS keyword is used,
195       could be > 0 (south to north) or < 0 (north to south)
196       if stepyin is a vector ny is not used
197
198   
199
200    <a name="#_computegrid_keyword_nxin"></a>
201    <h4>nxin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202      <font size="-1" color="#006633">in</font>
203     
204      <font size="-1" color="#006633">optional</font>
205     
206     
207      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
208     
209     
210    </h4>
211
212   
213       number of points in x direction,
214       optional if [XY]AXIS keyword is used or stepxin is a vector
215
216   
217
218    <a name="#_computegrid_keyword_nyin"></a>
219    <h4>nyin&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
220      <font size="-1" color="#006633">in</font>
221     
222      <font size="-1" color="#006633">optional</font>
223     
224     
225      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
226     
227     
228    </h4>
229
230   
231       number of points in y direction,
232       optional if [XY]AXIS keyword is used or stepyin is a vector
233
234   
235   
236
237   
238    <h3>Keywords</h3>
239
240   
241    <a name="#_computegrid_keyword_XAXIS"></a>
242    <h4>XAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
243     
244     
245     
246     
247     
248      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font>
249     
250     
251    </h4>
252
253   
254       Specify longitudes in this case startx, stepx and nx are not used but
255       could be necessary if the y axis is not defined with yaxis. It must be
256       possible to sort the first line of xaxis in the increasing order by
257       shifting its elements.
258
259   
260    <a name="#_computegrid_keyword_YAXIS"></a>
261    <h4>YAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262     
263     
264     
265     
266     
267      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D or 2D array</i></font>
268     
269     
270    </h4>
271
272   
273       Specify latitudes in this case starty, stepy and ny are not used but
274       starty and stepy could be necessary if the x axis is not defined with
275       xaxis. It must be sorted in the increasing or decreasing order (along each column if 2d array).
276
277   
278    <a name="#_computegrid_keyword_ZAXIS"></a>
279    <h4>ZAXIS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280     
281     
282     
283     
284     
285      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1D</i></font>
286     
287     
288    </h4>
289
290   
291       Specify the vertical axis. Must be sorted in the increasing or decreasing order
292
293   
294    <a name="#_computegrid_keyword_MASK"></a>
295    <h4>MASK&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296     
297     
298     
299     
300     
301      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D or 3D array</i></font>
302      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>array of 1</i></font>
303     
304    </h4>
305
306   
307       Specify the land(0)/sea(1) mask
308
309   
310    <a name="#_computegrid_keyword_GLAMBOUNDARY"></a>
311    <h4>GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312     
313     
314     
315     
316     
317      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font>
318      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>those defined in the file</i></font>
319     
320    </h4>
321
322   
323       Longitude boundaries that should be used to visualize the data.
324         lon2 > lon1
325         lon2 - lon1 le 360
326       By default, the common (cm_4mesh) variable key_shift will be automatically
327       defined according to GLAMBOUNDARY.
328
329   
330    <a name="#_computegrid_keyword_XMINMESH"></a>
331    <h4>XMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
332     
333     
334     
335     
336     
337      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
338      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font>
339     
340    </h4>
341
342   
343       Define common (cm_4mesh) variables ixminmesh used to define the localization
344       of the first point of the grid along the x direction in a zoom of the original grid
345
346   
347    <a name="#_computegrid_keyword_XMAXMESH"></a>
348    <h4>XMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
349     
350     
351     
352     
353     
354      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
355      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpiglo-1</i></font>
356     
357    </h4>
358
359   
360       Define common (cm_4mesh) variables ixmaxmesh used to define the localization
361       of the last point of the grid along the x direction in a zoom of the original grid
362       Note that if XMAXMESH < 0 then ixmaxmesh is defined as ixmaxmesh = jpiglo -1 + xmaxmesh
363
364   
365    <a name="#_computegrid_keyword_YMINMESH"></a>
366    <h4>YMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
367     
368     
369     
370     
371     
372      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
373      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font>
374     
375    </h4>
376
377   
378       Define common (cm_4mesh) variables iyminmesh used to define the localization
379       of the first point of the grid along the y direction in a zoom of the original grid
380
381   
382    <a name="#_computegrid_keyword_YMAXMESH"></a>
383    <h4>YMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
384     
385     
386     
387     
388     
389      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
390      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpjglo-1</i></font>
391     
392    </h4>
393
394   
395       Define common (cm_4mesh) variables iymaxmesh used to define the localization
396       of the last point of the grid along the y direction in a zoom of the original grid
397       Note that if YMAXMESH < 0 then iymaxmesh is defined as iymaxmesh = jpjglo -1 + ymaxmesh
398
399   
400    <a name="#_computegrid_keyword_ZMINMESH"></a>
401    <h4>ZMINMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
402     
403     
404     
405     
406     
407      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
408      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0L</i></font>
409     
410    </h4>
411
412   
413       Define common (cm_4mesh) variables izminmesh used to define the localization
414       of the first point of the grid along the z direction in a zoom of the original grid
415
416   
417    <a name="#_computegrid_keyword_ZMAXMESH"></a>
418    <h4>ZMAXMESH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
419     
420     
421     
422     
423     
424      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
425      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>jpkglo-1</i></font>
426     
427    </h4>
428
429   
430       Define common (cm_4mesh) variables izmaxmesh used to define the localization
431       of the last point of the grid along the z direction in a zoom of the original grid
432       Note that if ZMAXMESH < 0 then izmaxmesh is defined as izmaxmesh = jpkglo -1 + maxmesh
433
434   
435    <a name="#_computegrid_keyword_ONEARTH"></a>
436    <h4>ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
437     
438     
439     
440     
441     
442      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
443      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
444     
445    </h4>
446
447   
448       Force the manual definition of data localization on the earth or not
449          0) if the data are not on the earth
450          1) if the data are on earth (in that case we can for example use
451             the labels 'longitude', 'latitude' in plots).
452       The resulting value will be stored in the common (cm_4mesh) variable key_onearth
453       ONEARTH=0 forces PERIODIC=0, SHIFT=0 and is cancelling GLAMBOUNDARY
454
455   
456    <a name="#_computegrid_keyword_PERIODIC"></a>
457    <h4>PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
458     
459     
460     
461     
462     
463      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
464      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed by using the first line of glamt</i></font>
465     
466    </h4>
467
468   
469       Force the manual definition of the grid zonal periodicity.
470       The resulting value will be stored in the common (cm_4mesh) variable key_periodic
471       PERIODIC=0 forces SHIFT=0
472
473   
474    <a name="#_computegrid_keyword_PLAIN"></a>
475    <h4>PLAIN&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476     
477     
478     
479     
480     
481      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
482      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
483     
484    </h4>
485
486   
487       Force YREVERSE=0, ZREVERSE=0, PERIODIC=0, SHIFT=0, STRIDE=[1, 1, 1] and
488       suppress the automatic redefinition of the domain in case of x periodicity overlap,
489       y periodicity overlap (ORCA type only) and mask border to 0.
490
491   
492    <a name="#_computegrid_keyword_SHIFT"></a>
493    <h4>SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
494     
495     
496     
497     
498     
499      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
500      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font>
501     
502    </h4>
503
504   
505       Force the manual definition of the zonal shift that must be apply to the data.
506       The resulting value will be stored in the common (cm_4mesh) variable key_shift
507       Note that if key_periodic=0 then in any case key_shift=0.
508
509   
510    <a name="#_computegrid_keyword_STRIDE"></a>
511    <h4>STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
512     
513     
514     
515     
516     
517      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font>
518      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font>
519     
520    </h4>
521
522   
523       Specify the stride in x, y and z direction. The resulting
524       value will be stored in the common (cm_4mesh) variable key_stride
525
526   
527    <a name="#_computegrid_keyword_YREVERSE"></a>
528    <h4>YREVERSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
529     
530     
531     
532     
533     
534      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
535      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to gphit[0, 1:jpj-1] LT gphit[0, 0:jpj-2]</i></font>
536     
537    </h4>
538
539   
540       Force the manual definition of the y reverse that must be apply to the data.
541       The resulting value will be stored in the common (cm_4mesh) variable key_yreverse
542
543   
544    <a name="#_computegrid_keyword_ZREVERSE"></a>
545    <h4>ZREVERSE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
546     
547     
548     
549     
550     
551      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
552      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to gdept[0] GT gdept[1]</i></font>
553     
554    </h4>
555
556   
557       Force the manual definition of the z reverse that must be apply to the data.
558       The resulting value will be stored in the common (cm_4mesh) variable key_zreverse
559
560   
561    <a name="#_computegrid_keyword_FULLCGRID"></a>
562    <h4>FULLCGRID&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
563     
564     
565     
566     
567     
568      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
569      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
570     
571    </h4>
572
573   
574       Activate to specify that you want to compute all the C grid parameters:
575       definition of glam[uv], gphi[uv], e1[uvf], e2[uvf], [uv]maskred and
576       fmaskred[xy] will be add to the default computations
577
578   
579    <a name="#_computegrid_keyword_XYINDEX"></a>
580    <h4>XYINDEX&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
581     
582     
583     
584     
585     
586     
587     
588     
589    </h4>
590
591     activate to specify that the horizontal grid should
592       be simply defined by using the index of the points
593          (xaxis = findgen(nx) and yaxis = findgen(ny))
594       using this keyword forces key_onearth=0
595
596   
597    <a name="#_computegrid_keyword_UBASE2TBASE"></a>
598    <h4>UBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
599     
600     
601     
602     
603     
604     
605     
606     
607    </h4>
608
609   
610       Activate when the model is a C grid based on a U point
611       (with a U point at the bottom-left corner and a T point at the
612       upper-right corner). In this case, we ignore
613         - if the grid is not x-periodic, the first column of F and U points
614         - if the grid is not x-periodic, the last  column of T and V points.
615       => we are back to a C grid based on T point as for OPA model.
616       Note that in that case, key_gridtype = 'c_u' and not 'c' (-> used in read_ncdf)
617       Note that activate UBASE2TBASE forces FULLCGRID=1
618
619   
620    <a name="#_computegrid_keyword_VBASE2TBASE"></a>
621    <h4>VBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
622     
623     
624     
625     
626     
627     
628     
629     
630    </h4>
631
632   
633       Activate when the model is a C grid based on a V point
634       (with a V point at the bottom-left corner and a T point at the
635       upper-right corner). In this case, we ignore
636         - the first line of F and V points
637         - the last  line of T and U points
638       => we are back to a C grid based on T point as for OPA model.
639       Note that in that case, key_gridtype = 'c_v' and not 'c' (-> used in read_ncdf)
640       Note that activate VBASE2TBASE forces FULLCGRID=1
641
642   
643    <a name="#_computegrid_keyword_FBASE2TBASE"></a>
644    <h4>FBASE2TBASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
645     
646     
647     
648     
649     
650     
651     
652     
653    </h4>
654
655   
656       Activate when the model is a C grid based on a F point
657       (with a F point at the bottom-left corner and a T point at the
658       upper-right corner). In this case, we ignore
659         - the first line of F and V points
660         - the last  line of T and U points
661         - if the grid is not x-periodic, the first column of F and U points
662         - if the grid is not x-periodic, the last  column of T and V points.
663       => we are back to a C grid based on T point as for OPA model.
664       Note that in that case, key_gridtype = 'c_f' and not 'c' (-> used in read_ncdf)
665       Note that activate FBASE2TBASE forces FULLCGRID=1
666
667   
668    <a name="#_computegrid_keyword_STRCALLING"></a>
669    <h4>STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
670     
671     
672     
673     
674     
675      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
676     
677     
678    </h4>
679
680   
681       a string containing the calling command used to
682       call computegrid (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>)
683
684
685       Used by xxx...
686
687   
688    <a name="#_computegrid_keyword_ROMSH"></a>
689    <h4>ROMSH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
690     
691     
692     
693     
694     
695      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D array</i></font>
696     
697     
698    </h4>
699
700   
701       This array is the final bathymetry at RHO-points. It is stored in the common
702       variable (cm_4mesh) romszinfos.h
703       Used when the model is a ROMS C-grid with one more point
704       in longitude for T and V grid and one more point in latitude
705       for T and U grid. In this case, we ignore
706         - the last line of T and U points
707         - the last column of T and V points.
708      => we are back to a C grid based on T point as for OPA model.
709       Note that activate ROMSH forces FULLCGRID=1
710
711   
712    <a name="#_computegrid_keyword__EXTRA"></a>
713    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
714     
715     
716     
717     
718     
719     
720     
721     
722    </h4>
723
724   
725 not used in the present case ...
726
727   
728   
729
730   
731    </pre><h3>Version history</h3>
732   
733    <h4>Version</h4>
734 $Id: computegrid.pro 399 2009-07-02 08:38:54Z smasson $
735
736    <h4>History</h4>
737 Sebastien Masson (smasson@lodyc.jussieu.fr)
738                      2000-04-20
739 Sept 2004, several bug fix to suit C grid type...
740 Aug 2005, rewritte almost everything...
741
742   
743
744    <h3>Known issues</h3>
745   
746   
747   
748    <h4>Restrictions</h4>
749 if the grid has x/y periodicity overlap and/or if
750 the mask has 0 everywhere at the border (like a closed sea) and
751 if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
752 ymaxmesh keywords are defined to their default values), we redefine
753 xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the
754 overlapping part and/or to open the domain (avoid it be forced
755 to use cell_fill = 1).
756
757 FUV points definition is not exact if the grid is irregular
758
759
760    <h3>Other attributes</h3>
761   
762   
763    <h4>Uses routines</h4>
764 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
765 <a href="..//Commons/cm_4data.html">cm_4data</a>
766 <a href="..//Commons/cm_4cal.html">cm_4cal</a>
767
768
769   
770   
771   
772
773    <font size="-3"><p>&nbsp;</p></font>
774    <hr size="1" color="#CCCCCC"/>
775     
776
777   
778
779    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
780
781  </body>
782</html>
Note: See TracBrowser for help on using the repository browser.