Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: