Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Grid/computegrid.html @ 138

Last change on this file since 138 was 138, checked in by smasson, 18 years ago
update documentation and .idlwave_catalog
File size: 26.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	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35
36	body {
37	margin: 0;
38	padding: 0;
39	font-size: 10pt;
40	font-family: Verdana, Helvetica, Arial, sans-serif;
41	background-color: #FFFFFF;
42	}
43
44	p {
45	margin-top: 0.5em;
46	margin-bottom: 0;
47	}
48
49	#container { margin: 1em; }
50
51	code.section { white-space: pre; }
52
53	pre.snippet {
54	margin-left: 5%;
55	background: #F0F0F0;
56	border: 1px dashed #999999;
57	width: 43em;
58	padding: 0.5em 0.5em 0.5em 0.5em;
59	white-space: pre;
60	}
61
62	/* Navbar styles ------------------------------------------------------------- */
63
64	#navbar_title {
65	color: #000033;
66	background-color: #F0F0FF;
67	font-family: Arial, Helvetica, sans-serif;
68	padding: 20px 30px;
69	border-bottom: 1px solid #000033;
70	}
71
72	#navbar_title * {
73	margin: 0;
74	padding: 0;
75	}
76
77	#navbar_title h1 {
78	letter-spacing: 0.1em;
79	font-variant: small-caps;
80	font-size: 250%;
81	text-indent: -1em;
82	padding-left: 1em;
83	}
84
85	#navbar_title h2 {
86	font-size: 110%;
87	font-weight: normal;
88	color: #333399;
89	}
90
91	#main_navbar table {
92	width: 100%;
93	border-bottom: 1px solid #666699;
94	}
95
96	#main_navbar td {
97	background: #CCCCFF;
98	font-size: 80%;
99	font-weight: bold;
100	font-family: Arial, Helvetica, sans-serif;
101	border-top: 3px solid #CCCCFF;
102	border-bottom: 3px solid #CCCCFF;
103	padding-left: 6px;
104	padding-right: 6px;
105	margin: 0;
106	}
107
108	#main_navbar td#selected {
109	background: #CCCCFF;
110	font-size: 80%;
111	font-weight: bold;
112	font-family: Arial, Helvetica, sans-serif;
113	border-top: 3px solid #333399;
114	border-bottom: 3px solid #CCCCFF;
115	padding-left: 6px;
116	padding-right: 6px;
117	margin: 0;
118	}
119
120	#main_navbar td#flexible {
121	width: 100%;
122	text-align: right;
123	padding-right: 1em;
124	background: #CCCCFF;
125	font-size: 70%;
126	font-weight: normal;
127	font-family: Arial, Helvetica, sans-serif;
128	text-transform: uppercase;
129	border-top: 3px solid #CCCCFF;
130	border-bottom: 3px solid #CCCCFF;
131	}
132
133	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
134
135	#main_navbar a:hover, #main_navbar a:focus {
136	color: #FFFF66;
137	background: #CCCCFF;
138	border-bottom: 1px none #606099;
139	border: 0;
140	}
141
142	#secondary_navbar {
143	font-size: 80%;
144	font-weight: normal;
145	font-family: Arial, Helvetica, sans-serif;
146	margin-top: 4px;
147	margin-left: 20px;
148	white-space: nowrap;
149	}
150
151
152	/* Tagline and footer styles ------------------------------------------------- */
153
154	div#tagline {
155	margin-top: 6px;
156	border-top: 1px dotted lightsteelblue;
157	padding-top: 6px;
158	font-size: 66%;
159	font-style: italic;
160	}
161
162	div#footer {
163	margin-top: 6px;
164	border-top: 1px dotted lightsteelblue;
165	padding-top: 6px;
166	font-size: 66%;
167	font-style: italic;
168	}
169
170	/* Basic data presenation styles -------------------------------------------- */
171
172	.index_letter {
173	font-size: 300%;
174	font-weight: bold;
175	color: #000066;
176	margin: 0.5em 0 0 -0.1em;
177	}
178
179	h1, h2, h3, h4 {
180	font-weight: normal;
181	color: #3333CC;
182	}
183
184	h1 {
185	padding-top: 0.75em;
186	font-size: 160%;
187	}
188
189	h2 {
190	padding-top: 1em;
191	font-size: 120%;
192	}
193
194	h3 {
195	padding-top: 0.75em;
196	margin-bottom: 0.25em;
197	font-size: 100%;
198	}
199
200	h4 {
201	padding: 0;
202	margin: 0.5em 0 0 0;
203	font-size: 80%;
204	}
205
206	table.basic {
207	empty-cells: show;
208	margin: 1.5em 1em 0 1em;
209	border: 1px dotted #CFCFFF;
210	font-size: 80%;
211	}
212
213	table.basic th {
214	background-color: #F0F0FF;
215	font-weight: bold;
216	text-align: left;
217	padding: 4px 1em 4px 4px;
218	border-bottom: 1px dotted #666699;
219	}
220
221	table.basic td {
222	vertical-align: top;
223	padding: 4px 1em 4px 4px;
224	}
225
226	dd {
227	margin-bottom: 0.25em;
228	font-size: 80%;
229	}
230
231
232	/* Warnings styles ----------------------------------------------------------- */
233
234
235	#todo dl, #bugs dl {
236	margin: 0 0 0 1.5em;
237	font-size: 80%;
238	}
239
240	#todo dd, #bugs dd {
241	margin-left: 3em;
242	font-size: 100%;
243	}
244
245	#undoc table, #obsolete table, #statistics table {
246	width: 80%;
247	margin-left: 2em;
248	}
249
250	#undoc td, #obsolete td, #statistics td {
251	padding: 0 0 0 0;
252	font-size: 80%;
253	white-space: nowrap;
254	}
255
256	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
257
258	#undoc td.docstat, #statistics td.stat {
259	width: 50%;
260	text-align: right;
261	}
262
263	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
264
265	#undoc td.notdoc, #statistics td.warning { color: #993333; }
266
267	/* File + routine styles ----------------------------------------------------- */
268
269	h1.directory {
270	padding: 1em 0 0 0;
271	margin: 0;
272	font-size: 66%;
273	}
274
275	h1.directory a { border-bottom: 0; }
276
277	h2.pro_file {
278	padding: 0;
279	margin: 0;
280	font-size: 140%;
281	}
282
283	div#file_attr {
284	padding: 0 1em 0 1em;
285	margin: 1em;
286	background: #F6F6F6;
287	border: 1px dotted #999999;
288	}
289
290	div#file_attr dt {
291	font-size: 80%;
292	font-weight: bold;
293	}
294
295	div#file_attr dd {
296	font-size: 80%;
297	}
298
299	div#class_diagram {
300	padding: 1em 0 1em 0;
301	white-space: pre;
302	font-family: 'Courier New';
303	}
304
305	table#sav_attr {
306	font-size: 90%;
307	margin: 1em;
308	padding: 1em 1em 1em 1em;
309	background: #F6F6F6;
310	border: 1px dotted #999999;
311	}
312
313	table#sav_attr th { text-align: left; }
314
315	table#sav_attr td { vertical-align: top; padding-right: 2em; }
316
317	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
318
319	p.sav_warning { margin-left: 4em; font-family: 80%; }
320
321	table.variables {
322	font-family: 'Courier New', monospace;
323	font-size: 80%;
324	text-indent: -2em;
325	padding-left: 2em;
326	}
327
328	table.variables td.image { width: 64px; }
329
330	div#file_comments { white-space: pre;
331	margin: 2em;
332	font-size: 80%;
333	}
334
335
336	div.field_summary {
337	padding: 0 1em 0 1em;
338	margin: 1em;
339	background: #FFFFF0;
340	border: 1px dotted #C0C000;
341	}
342
343	div#routine_summary {
344	padding: 0 1em 0 1em;
345	margin: 1em;
346	background: #F0F0FF;
347	border: 1px dotted #9999FF;
348	}
349
350	div.field_summary h2, div#routine_summary h2 {
351	padding: 0.5em 0 0 0;
352	margin: 0;
353	}
354
355	div.field_summary table, div.field_summary p {
356	margin: 1em 1em;
357	}
358
359	div.field_summary td.name {
360	vertical-align: top;
361	padding-bottom: 0.25em;
362	color: #3333CC;
363	}
364
365	div.field_summary span.field_type {
366	font-weight: normal;
367	font-size: 80%;
368	color: black;
369	}
370
371	div.field_summary td.comments {
372	vertical-align: top;
373	padding-left: 2em;
374	font-size: 80%;
375	}
376
377	p.commaList {
378	margin: 1em 1em 1em 1em;
379	}
380
381	span.warning {
382	color: #CC6633;
383	font-weight: bold;
384	font-size: 66%;
385	text-transform: uppercase;
386	}
387
388	span.categories {
389	color: #006633;
390	font-weight: bold;
391	font-size: 66%;
392	text-transform: uppercase;
393	}
394
395	span.undoc {
396	color: #FF6633;
397	font-weight: bold;
398	font-size: 80%;
399	text-transform: uppercase;
400	}
401
402	span.attr {
403	color: #006633;
404	font-weight: bold;
405	font-size: 80%;
406	text-transform: uppercase;
407	}
408
409	span.value {
410	color: #006633;
411	font-weight: normal;
412	text-transform: none;
413	}
414
415	a.top {
416	font-weight: bold;
417	font-size: 66%;
418	text-transform: uppercase;
419	float: right;
420	}
421
422	span.result {
423	font-family: Verdana, Arial, Helvetica, sans-serif;
424	font-style: italic;
425	font-size: 80%;
426	}
427
428	div#routine_summary p, div.routine_details p.header {
429	padding-top: 0.5em;
430	margin-left: 1.5em;
431	text-indent: -1.5em;
432	font-family: 'Courier New', monospace;
433	}
434
435	div.routine_details {
436	padding: 0.5em 1em 0.5em 1em;
437	margin: 1em;
438	border: 1px dotted #CCCCCC;
439	}
440
441	div.routine_details h2 {
442	padding-top: 0;
443	margin-top: 0;
444	}
445
446	div.routine_details div.value {
447	margin: 0 1em 0 1em;
448	font-size: 80%;
449	}
450
451	div.routine_details div.comments {
452	font-size: 80%;
453	margin: 0.75em 1em 1em 1em;
454	}
455
456	div.routine_details div.preformat {
457	white-space: pre;
458	}
459
460	table.statistics {
461	font-size: 80%;
462	margin-left: 1em;
463	}
464
465	table.statistics td {
466	padding: 0 2em 0 0;
467	}
468
469	/* Overview styles ----------------------------------------------------------- */
470
471	div.overview {
472	width: 100%;
473	margin-top: 1em;
474	clear: both;
475	}
476
477	div.overview table {
478	empty-cells: show;
479	font-size: 90%;
480	margin: 1em 1em 1em 1em;
481	padding: 1em 0.5em 1em 0.5em;
482	background: #F6F6F6;
483	border: 1px dotted #999999;
484	}
485
486	div.overview td {
487	padding: 3px 1em 3px 1em;
488	}
489
490	div.overview td.dir {
491	width: 1%;
492	vertical-align: top;
493	text-align: right;
494	padding-right: 1em;
495	}
496
497
498	/* Navigation list styles for tree structures -------------------------------- */
499
500	#tree {
501	text-align: left;
502	font-size: 90%;
503	margin: 0.75em 0 0.75em 0;
504	padding: 0;
505	}
506
507	#tree ul {
508	text-align: left;
509	margin: 0;
510	padding: 0;
511	}
512
513	#tree li {
514	margin: 0 0 0 15px;
515	padding: 0;
516	list-style-type: none;
517	}
518
519	#tree .symbols {
520	float: left;
521	width: 12px;
522	height: 1em;
523	padding-left: 4px;
524	background-position: 0 100%;
525	background-repeat: no-repeat;
526	}
527
528	/* Search styles ------------------------------------------------------------- */
529
530	input.writein {
531	padding-left: 0.5em;
532	border: 1px solid #CCCCCC;
533	font-family: 'Courier New';
534	background: #FFFFF3;
535	}
536
537	#search form {
538	margin-left: 2em;
539	}
540
541	#search table {
542	margin: 1em 1em 0 2em;
543	padding: 1em 2em 1em 2em;
544	background: #F6F6F6;
545	border: 1px dotted #999999;
546	}
547
548	#search tr {
549	text-align: center;
550	}
551
552	#search td {
553	font-size: 80%;
554	text-align: left;
555	}
556
557	#search td * {
558	vertical-align: middle;
559	}
560
561	#search p {
562	font-size: 66%;
563	margin: 0 3em 2em 3em;
564	}
565
566	/* Help styles --------------------------------------------------------------- */
567
568	div.toc {
569	padding: 0 1em 0 1em;
570	margin: 1em;
571	background: #F0F0FF;
572	border: 1px dotted #9999FF;
573	width: 19em;
574	}
575
576	div.right {
577	float: right;
578	width: 22em;
579	}
580
581	ol.toc {
582	list-style-type: upper-roman;
583	}
584
585	ol.toc ol {
586	padding-left: 3em;
587	margin-left: 0;
588	list-style-type: lower-alpha;
589	}
590
591	dl.variables dt { font-size: 80%; }
592	dl.variables dd { margin-bottom: 0.5em; }
593
594	</style>
595	<style type="text/css" media="print">
596	#navbar_title {
597	background-color: #FFFFFF;
598	}
599
600	#main_navbar td {
601	background: #FFFFFF;
602	border-top: 0.25em solid #FFFFFF;
603	border-bottom: 0.25em solid #FFFFFF;
604	}
605
606	#main_navbar td#selected {
607	background: #FFFFFF;
608	border-top: 0.25em solid #333399;
609	border-bottom: 0.25em solid #FFFFFF;
610	}
611
612	#main_navbar td#flexible {
613	background: #FFFFFF;
614	border-top: 0.25em solid #FFFFFF;
615	border-bottom: 0.25em solid #FFFFFF;
616	}
617
618	#secondary_navbar {
619	display: none;
620	}
621
622	</style>
623
624
625	<script type="text/javascript">
626	function setTitle() {
627	parent.document.title="computegrid.pro (SAXO Documentation)";
628	}
629	</script>
630	</head>
631
632	<body onload="setTitle();">
633
634	<div id="navbar_title">
635	<h1>SAXO Documentation</h1>
636	</div>
637
638
639	<div id="main_navbar">
640
641	<table cellspacing="0">
642	<tr>
643
644	<td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
645
646
647
648	<td >Directory</td>
649
650
651
652	<td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
653
654
655
656	<td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
657
658
659
660	<td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
661
662
663	<td id="selected">File</td>
664
665
666	<td >Source</td>
667
668
669
670	<td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
671
672
673	<td >Etc</td>
674
675	<td id="flexible">Developer documentation</td>
676	</tr>
677	</table>
678
679	</div>
680
681	<div id="secondary_navbar">
682
683	<a href="changemsk.html?format=raw"><<prev file</a> \| <a href="micromeshmask.html?format=raw">next file >></a>    <a href="computegrid.html?format=raw" target="_TOP">view single page</a> \| <a href="./../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    details: <a href="#routine_details">routine</a>
684
685	</div>
686
687
688	<div id="container">
689
690	<h1 class="directory"><a href="directory-overview.html?format=raw">Grid/</a></h1>
691	<h2 class="pro_file">computegrid.pro</h2>
692
693	<div id="file_attr">
694	<dl>
695	</dl>
696	</div>
697
698	<div id="file_comments"> compute the grid parameters from cm_4mesh common:
699
700	computegrid, startx, starty, stepx, stepy, nx, ny
701	computegrid, startx, starty, stepx, stepy
702	computegrid, xaxis = xaxis, yaxis = yaxis
703	or a suitable mix...
704
705	glamt
706	glamf
707	gphit
708	gphit
709	e1t
710	e2t
711	horizontal parameters
712
713	glamu {in}
714	glamv {in}
715	gphiu {in}
716	gphiv {in}
717	e1u {in}
718	e1v {in}
719	e1f {in}
720	e2u {in}
721	e2v {in}
722	e2f {in}
723	horizontal parameters if FULLCGRID keyword is defined
724
725	gdept
726	gdepw
727	e3t
728	e3w
729	verticals parameters
730
731	tmask
732	masks
733
734	umaskred {in}
735	vmaskred {in}
736	fmaskredx {in}
737	fmaskredy {in}
738	masks if FULLCGRID keyword is defined
739
740	triangles_list
741	triangulation
742	</div>
743
744
745
746
747
748
749
750
751
752	<div id="routine_details">
753
754
755	<div class="routine_details" id="_computegrid">
756
757	<h2><a class="top" href="#container">top</a>computegrid <span class="categories"> grid
758	</span></h2>
759
760	<p class="header">
761	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">XAXIS</span>, <a href="#_computegrid_keyword_YAXIS">YAXIS</a>=<span class="result">YAXIS</span>, <a href="#_computegrid_keyword_ZAXIS">ZAXIS</a>=<span class="result">ZAXIS</span>, <a href="#_computegrid_keyword_MASK">MASK</a>=<span class="result">MASK</span>, <a href="#_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">GLAMBOUNDARY</span>, <a href="#_computegrid_keyword_XMINMESH">XMINMESH</a>=<span class="result">XMINMESH</span>, <a href="#_computegrid_keyword_XMAXMESH">XMAXMESH</a>=<span class="result">XMAXMESH</span>, <a href="#_computegrid_keyword_YMINMESH">YMINMESH</a>=<span class="result">YMINMESH</span>, <a href="#_computegrid_keyword_YMAXMESH">YMAXMESH</a>=<span class="result">YMAXMESH</span>, <a href="#_computegrid_keyword_ZMINMESH">ZMINMESH</a>=<span class="result">ZMINMESH</span>, <a href="#_computegrid_keyword_ZMAXMESH">ZMAXMESH</a>=<span class="result">ZMAXMESH</span>, <a href="#_computegrid_keyword_ONEARTH">ONEARTH</a>=<span class="result">ONEARTH</span>, <a href="#_computegrid_keyword_PERIODIC">PERIODIC</a>=<span class="result">PERIODIC</span>, <a href="#_computegrid_keyword_PLAIN">PLAIN</a>=<span class="result">PLAIN</span>, <a href="#_computegrid_keyword_SHIFT">SHIFT</a>=<span class="result">SHIFT</span>, <a href="#_computegrid_keyword_STRIDE">STRIDE</a>=<span class="result">STRIDE</span>, <a href="#_computegrid_keyword_FULLCGRID">FULLCGRID</a>=<span class="result">FULLCGRID</span>, <a href="#_computegrid_keyword_XYINDEX">XYINDEX</a>=<span class="result">XYINDEX</span>, <a href="#_computegrid_keyword_FBASE2TBASE">FBASE2TBASE</a>=<span class="result">FBASE2TBASE</span>, <a href="#_computegrid_keyword_STRCALLING">STRCALLING</a>=<span class="result">STRCALLING</span>, <a href="#_computegrid_keyword__extra">_extra</a>=<span class="result">_extra</span></p>
762
763	<div class="comments">
764	</div>
765
766
767
768
769	<h3>Parameters</h3>
770
771
772	<h4 id="_computegrid_param_startx">startx
773	<span class="attr">in</span>
774
775
776	<span class="attr">required</span>
777
778
779
780
781	</h4>
782
783	<div class="comments"> scalar, x starting point</div>
784
785	<h4 id="_computegrid_param_starty">starty
786	<span class="attr">in</span>
787
788
789	<span class="attr">required</span>
790
791
792
793
794	</h4>
795
796	<div class="comments"> scalar, y starting point</div>
797
798	<h4 id="_computegrid_param_stepxin">stepxin
799	<span class="attr">in</span>
800
801
802	<span class="attr">required</span>
803
804
805
806
807	</h4>
808
809	<div class="comments"> scalar or vector: x direction step, must be > 0
810	if vector nx is not used</div>
811
812	<h4 id="_computegrid_param_stepyin">stepyin
813	<span class="attr">in</span>
814
815
816	<span class="attr">required</span>
817
818
819
820
821	</h4>
822
823	<div class="comments"> scalar or vector: y direction step,
824	could be > 0 (south to north) or < 0 (north to south)
825	if vector ny is not used</div>
826
827	<h4 id="_computegrid_param_nxin">nxin
828	<span class="attr">in</span>
829
830
831	<span class="attr">required</span>
832
833
834
835
836	</h4>
837
838	<div class="comments"> scalar, number of points in x direction</div>
839
840	<h4 id="_computegrid_param_nyin">nyin
841	<span class="attr">in</span>
842
843
844	<span class="attr">required</span>
845
846
847
848
849	</h4>
850
851	<div class="comments"> scalar, number of points in y direction
852	</div>
853
854
855
856
857
858
859	<h3>Keywords</h3>
860
861	<h4 id="_computegrid_keyword_XAXIS">XAXIS
862
863
864
865
866
867
868
869
870	</h4>
871
872	<div class="comments"> to specify longitude1 with a 1 or 2 dimension array, in
873	this case startx, stepx and nx are not used but could be
874	necessary if the y axis is not defined with yaxis. It must be
875	possible to sort the first line of xaxis in the increasing
876	order by shifting its elements.
877	</div>
878
879	<h4 id="_computegrid_keyword_YAXIS">YAXIS
880
881
882
883
884
885
886
887
888	</h4>
889
890	<div class="comments"> to specify latitudes with a 1 or 2 dimension array, in
891	this case starty, stepy and ny are not used but starty and
892	stepy could be necessary if the x axis is not defined with xaxis.
893	It must be sorted in the increasing or deceasing order
894	(along each column if 2d array).
895	</div>
896
897	<h4 id="_computegrid_keyword_ZAXIS">ZAXIS
898
899
900
901
902
903
904
905
906	</h4>
907
908	<div class="comments"> to specify the vertical axis with a 1 dimension
909	array. Must be sorted in the increasing or deceasing order
910	</div>
911
912	<h4 id="_computegrid_keyword_MASK">MASK
913
914
915
916
917
918
919
920
921	</h4>
922
923	<div class="comments"> to specify the mask with a 2 or 3 dimension array
924	</div>
925
926	<h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY
927
928
929
930
931
932
933
934
935	</h4>
936
937	<div class="comments"> a 2 elements vector, [lon1,lon2], the longitude
938	boundaries that should be used to visualize the data.
939	we must have lon2 > lon1 and lon2 - lon1 le 360
940	key_shift will be defined automaticaly computed according to
941	glamboundary by using the FIRST LINE of glamt but
942	key_shift will /= 0 only if key_periodic = 1
943	</div>
944
945	<h4 id="_computegrid_keyword_XMINMESH">XMINMESH
946
947
948
949
950
951
952	<span class="attr">default:</span> <span class="value">0L</span>
953
954	</h4>
955
956	<div class="comments"></div>
957
958	<h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH
959
960
961
962
963
964
965	<span class="attr">default:</span> <span class="value">jpiglo-1</span>
966
967	</h4>
968
969	<div class="comments"></div>
970
971	<h4 id="_computegrid_keyword_YMINMESH">YMINMESH
972
973
974
975
976
977
978	<span class="attr">default:</span> <span class="value">0L</span>
979
980	</h4>
981
982	<div class="comments"></div>
983
984	<h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH
985
986
987
988
989
990
991	<span class="attr">default:</span> <span class="value">jpjglo-1</span>
992
993	</h4>
994
995	<div class="comments"></div>
996
997	<h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH
998
999
1000
1001
1002
1003
1004	<span class="attr">default:</span> <span class="value">0L</span>
1005
1006	</h4>
1007
1008	<div class="comments">
1009	to define the common variables i[xyz]minmesh
1010	used to define the grid only in a zoomed part of the original
1011	grid. max value is [XYZ]MAXMESH
1012	</div>
1013
1014	<h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH
1015
1016
1017
1018
1019
1020
1021	<span class="attr">default:</span> <span class="value">jpkglo-1</span>
1022
1023	</h4>
1024
1025	<div class="comments">
1026	to define the common variables i[xyz]maxmesh
1027	used to define the grid only in a zoomed part of the original
1028	grid. max value is jp[ijk]glo-1.
1029	if [XYZ]MAXMESH is negative, then we define i[xyz]maxmesh as
1030	jp[ijk]glo - 1 + [XYZ]MAXMESH instead of [XYZ]MAXMESH
1031	</div>
1032
1033	<h4 id="_computegrid_keyword_ONEARTH">ONEARTH
1034
1035
1036
1037
1038
1039
1040
1041
1042	</h4>
1043
1044	<div class="comments"> = 0 or 1 to force the manual definition of
1045	key_onearth (to specify if the data are on earth -> use longitude
1046	/latitude etc...). By default, key_onearth = 1.
1047	note that ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0,
1048	and is cancelling GLAMBOUNDARY
1049	</div>
1050
1051	<h4 id="_computegrid_keyword_PERIODIC">PERIODIC
1052
1053
1054
1055
1056
1057
1058
1059
1060	</h4>
1061
1062	<div class="comments"> = 0 or 1 to force the manual definition of
1063	key_periodic. By default, key_periodic is automaticaly
1064	computed by using the first line of glamt.
1065	</div>
1066
1067	<h4 id="_computegrid_keyword_PLAIN">PLAIN
1068
1069
1070
1071
1072
1073
1074
1075
1076	</h4>
1077
1078	<div class="comments"> force PERIODIC = 0, SHIFT = 0, STRIDE = [1, 1, 1] and
1079	suppress the automatic redefinition of the domain in case of
1080	x periodicity overlap, y periodicity overlap (ORCA type only)
1081	and mask border to 0.
1082	</div>
1083
1084	<h4 id="_computegrid_keyword_SHIFT">SHIFT
1085
1086
1087
1088
1089
1090
1091
1092
1093	</h4>
1094
1095	<div class="comments"> = scalar to force the manual definition of key_shift. By
1096	default, key_shift is automaticaly computed according to
1097	glamboundary (when defined) by using the FIRST LINE of glamt. if
1098	key_periodic=0 then in any case key_shift = 0.
1099	</div>
1100
1101	<h4 id="_computegrid_keyword_STRIDE">STRIDE
1102
1103
1104
1105
1106
1107
1108	<span class="attr">default:</span> <span class="value">[1, 1, 1]</span>
1109
1110	</h4>
1111
1112	<div class="comments"> a 3 elements vector to specify the stride in x, y, z
1113	direction. The resulting value
1114	will be stored in the common (cm_4mesh) variable key_stride
1115	</div>
1116
1117	<h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID
1118
1119
1120
1121
1122
1123
1124
1125
1126	</h4>
1127
1128	<div class="comments"> activate to specify that you want to compute
1129	all the paremeters of a C grid. Computation of glam[uv],
1130	gphi[uv], e1[uvf], e2[uvf], [uv]maskred and fmaskred[xy]
1131	will be add to the default computations
1132	</div>
1133
1134	<h4 id="_computegrid_keyword_XYINDEX">XYINDEX
1135
1136
1137
1138
1139
1140
1141
1142
1143	</h4>
1144
1145	<div class="comments"> activate to specify that the horizontal grid should
1146	be simply defined by using the index of the points
1147	(xaxis = findgen(nx) and yaxis = findgen(ny))
1148	using this keyword forces key_onearth=0
1149	</div>
1150
1151	<h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE
1152
1153
1154
1155
1156
1157
1158
1159
1160	</h4>
1161
1162	<div class="comments">
1163	</div>
1164
1165	<h4 id="_computegrid_keyword_STRCALLING">STRCALLING
1166
1167
1168
1169
1170
1171
1172
1173
1174	</h4>
1175
1176	<div class="comments"> a string containing the calling command used to
1177	call computegrid (this is used by xxx.pro)
1178
1179
1180	</div>
1181
1182	<h4 id="_computegrid_keyword__extra">_extra
1183
1184
1185
1186
1187
1188
1189
1190
1191	</h4>
1192
1193	<div class="comments"> used to pass your keywords to the created function.
1194	</div>
1195
1196
1197
1198
1199	<h3>Version history</h3>
1200
1201	<h4>Version</h4><div class="preformat"> $Id: computegrid.pro 134 2006-07-07 10:19:08Z navarro $
1202	</div>
1203	<h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr)
1204	2000-04-20
1205	Sept 2004, several bug fixs to suit C grid type...
1206	Aug 2005, rewritte almost everything...
1207	</div>
1208
1209
1210	<h3>Known issues</h3>
1211
1212
1213
1214	<h4>Restrictions</h4><div class="preformat"> if the grid has x/y periodicity orverlap and/or if
1215	the mask has 0 everywhere at the border (like a close sea) and
1216	if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
1217	ymaxmesh keywords are defined to their default values), we redefine
1218	xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the
1219	overlapping part and/or to open the domain (avoid ti be forced
1220	to use cell_fill = 1).
1221
1222	FUV points definition...
1223	</div>
1224
1225	<h3>Other attributes</h3>
1226
1227
1228	<h4>Uses routines</h4><div class="preformat"> cm_4mesh cm_4data cm_4cal
1229	</div>
1230
1231
1232
1233
1234
1235
1236	</div>
1237
1238	</div>
1239
1240
1241
1242	<div id="tagline">Produced by IDLdoc 2.0.</div>
1243
1244	</div>
1245
1246	</body>
1247	</html>

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

Download in other formats: