Context Navigation

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

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

Download in other formats: