Context Navigation

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

Last change on this file since 242 was 242, checked in by pinsard, 17 years ago
improvements/corrections of some *.pro headers + replace some message by some report
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	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_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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and
488	suppress the automatic redefinition of the domain in case of
489	x periodicity overlap, y periodicity overlap (ORCA type only)
490	and mask border to 0.
491
492
493	<a name="#_computegrid_keyword_SHIFT"></a>
494	<h4>SHIFT
495
496
497
498
499
500	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
501	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font>
502
503	</h4>
504
505
506	Force the manual definition of the zonal shift that must be apply to the data.
507	The resulting value will be stored in the common (cm_4mesh) variable key_shift
508	Note that if key_periodic=0 then in any case key_shift = 0.
509
510
511	<a name="#_computegrid_keyword_STRIDE"></a>
512	<h4>STRIDE
513
514
515
516
517
518	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font>
519	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font>
520
521	</h4>
522
523
524	Specify the stride in x, y and z direction. The resulting
525	value will be stored in the common (cm_4mesh) variable key_stride
526
527
528	<a name="#_computegrid_keyword_FULLCGRID"></a>
529	<h4>FULLCGRID
530
531
532
533
534
535	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
536	<font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
537
538	</h4>
539
540
541	Activate to specify that you want to compute all the C grid parameters:
542	definition of glam[uv], gphi[uv], e1[uvf], e2[uvf], [uv]maskred and
543	fmaskred[xy] will be add to the default computations
544
545
546	<a name="#_computegrid_keyword_XYINDEX"></a>
547	<h4>XYINDEX
548
549
550
551
552
553
554
555
556	</h4>
557
558	activate to specify that the horizontal grid should
559	be simply defined by using the index of the points
560	(xaxis = findgen(nx) and yaxis = findgen(ny))
561	using this keyword forces key_onearth=0
562
563
564	<a name="#_computegrid_keyword_UBASE2TBASE"></a>
565	<h4>UBASE2TBASE
566
567
568
569
570
571
572
573
574	</h4>
575
576
577	Activate when the model is a C grid based on a U point
578	(with a U point at the bottom-left corner and a T point at the
579	upper-right corner). In this case, we ignore
580	- if the grid is not x-periodic, the first column of F and U points
581	- if the grid is not x-periodic, the last column of T and V points.
582	=> we are back to a C grid based on T point as for OPA model.
583	Note that in that case, key_gridtype = 'c_u' and not 'c' (-> used in read_ncdf)
584	Note that activate UBASE2TBASE forces FULLCGRID=1
585
586
587	<a name="#_computegrid_keyword_VBASE2TBASE"></a>
588	<h4>VBASE2TBASE
589
590
591
592
593
594
595
596
597	</h4>
598
599
600	Activate when the model is a C grid based on a V point
601	(with a V point at the bottom-left corner and a T point at the
602	upper-right corner). In this case, we ignore
603	- the first line of F and V points
604	- the last line of T and U points
605	=> we are back to a C grid based on T point as for OPA model.
606	Note that in that case, key_gridtype = 'c_v' and not 'c' (-> used in read_ncdf)
607	Note that activate VBASE2TBASE forces FULLCGRID=1
608
609
610	<a name="#_computegrid_keyword_FBASE2TBASE"></a>
611	<h4>FBASE2TBASE
612
613
614
615
616
617
618
619
620	</h4>
621
622
623	Activate when the model is a C grid based on a F point
624	(with a F point at the bottom-left corner and a T point at the
625	upper-right corner). In this case, we ignore
626	- the first line of F and V points
627	- the last line of T and U points
628	- if the grid is not x-periodic, the first column of F and U points
629	- if the grid is not x-periodic, the last column of T and V points.
630	=> we are back to a C grid based on T point as for OPA model.
631	Note that in that case, key_gridtype = 'c_f' and not 'c' (-> used in read_ncdf)
632	Note that activate FBASE2TBASE forces FULLCGRID=1
633
634
635	<a name="#_computegrid_keyword_STRCALLING"></a>
636	<h4>STRCALLING
637
638
639
640
641
642	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
643
644
645	</h4>
646
647
648	a string containing the calling command used to
649	call computegrid (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>)
650
651
652	Used by xxx...
653
654
655	<a name="#_computegrid_keyword_ROMSH"></a>
656	<h4>ROMSH
657
658
659
660
661
662	<font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2D array</i></font>
663
664
665	</h4>
666
667
668	This array is the final bathymetry at RHO-points. It is stored in the common
669	variable (cm_4mesh) romszinfos.h
670	Used when the model is a ROMS C-grid with one more point
671	in longitude for T and V grid and one more point in latitude
672	for T and U grid. In this case, we ignore
673	- the last line of T and U points
674	- the last column of T and V points.
675	=> we are back to a C grid based on T point as for OPA model.
676	Note that activate ROMSH forces FULLCGRID=1
677
678
679	<a name="#_computegrid_keyword__EXTRA"></a>
680	<h4>_EXTRA
681
682
683
684
685
686
687
688
689	</h4>
690
691
692	not used in the present case ...
693
694
695
696
697
698	</pre><h3>Version history</h3>
699
700	<h4>Version</h4>
701	$Id: computegrid.pro 240 2007-03-28 12:17:24Z pinsard $
702
703	<h4>History</h4>
704	Sebastien Masson (smasson@lodyc.jussieu.fr)
705	2000-04-20
706	Sept 2004, several bug fix to suit C grid type...
707	Aug 2005, rewritte almost everything...
708
709
710
711	<h3>Known issues</h3>
712
713
714
715	<h4>Restrictions</h4>
716	if the grid has x/y periodicity overlap and/or if
717	the mask has 0 everywhere at the border (like a closed sea) and
718	if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
719	ymaxmesh keywords are defined to their default values), we redefine
720	xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the
721	overlapping part and/or to open the domain (avoid it be forced
722	to use cell_fill = 1).
723
724	FUV points definition is not exact if the grid is irregular
725
726
727	<h3>Other attributes</h3>
728
729
730	<h4>Uses routines</h4>
731	cm_4mesh
732	cm_4data
733	cm_4cal
734
735
736
737
738
739	<font size="-3"><p> </p></font>
740	<hr size="1" color="#CCCCCC"/>
741
742
743
744
745	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0.</font></p>
746
747	</body>
748	</html>

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

Download in other formats: