Context Navigation

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

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

Download in other formats: