Context Navigation

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

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

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

Download in other formats: