Context Navigation

computegrid.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago
update documentation
File size: 25.0 KB

Rev	Line
[89]	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>
[104]	9	<title>computegrid.pro (SAXO Documentation)</title>
[89]	10
	11
[191]	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" />
[89]	14
	15
	16	<script type="text/javascript">
	17	function setTitle() {
[104]	18	parent.document.title="computegrid.pro (SAXO Documentation)";
[89]	19	}
	20	</script>
	21	</head>
	22
	23	<body onload="setTitle();">
	24
	25	<div id="navbar_title">
[104]	26	<h1>SAXO Documentation</h1>
[89]	27	</div>
	28
	29
	30	<div id="main_navbar">
	31
	32	<table cellspacing="0">
	33	<tr>
	34
[189]	35	<td><a href="./../overview.html" title="Overview of library">Overview</a></td>
[89]	36
	37
	38
	39	<td >Directory</td>
	40
	41
	42
[189]	43	<td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]	44
	45
	46
[189]	47	<td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]	48
	49
	50
[189]	51	<td><a href="./../search-page.html" title="Search library">Search</a></td>
[89]	52
	53
	54	<td id="selected">File</td>
	55
	56
[189]	57	<td><a href="../../../Grid//computegrid.pro" title="Source code of a file">Source</a></td>
[89]	58
	59
	60
[189]	61	<td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]	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
[321]	74	<a href="changemsk.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>
[89]	75
	76	</div>
	77
	78
	79	<div id="container">
	80
[189]	81	<h1 class="directory"><a href="directory-overview.html">Grid/</a></h1>
[89]	82	<h2 class="pro_file">computegrid.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[234]	89	<div id="file_comments">
[177]	90	compute the grid parameters (cm_4mesh) common
[89]	91
[195]	92	domains sizes:
	93	---------------
	94	jpi, jpj, jpk, jpiglo, jpjglo, jpkglo, jpidta, jpjdta, jpkdta
[118]	95
[195]	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
[103]	135
[89]	136
[103]	137
[89]	138
[103]	139
[89]	140
[103]	141
[89]	142
[103]	143	<div id="routine_details">
	144
[89]	145
[103]	146	<div class="routine_details" id="_computegrid">
[89]	147
[234]	148	<h2><a class="top" href="#container">top</a>computegrid <span class="categories">
[195]	149	Grid
	150	</span></h2>
[103]	151
	152	<p class="header">
[290]	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_YREVERSE">YREVERSE</a>=<span class="result">scalar</span>, <a href="#_computegrid_keyword_ZREVERSE">ZREVERSE</a>=<span class="result">scalar</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>
[103]	154
	155	<div class="comments">
[89]	156	</div>
	157
	158
	159
	160
	161	<h3>Parameters</h3>
	162
	163
	164	<h4 id="_computegrid_param_startx">startx
[195]	165	<span class="attr">in</span>
[89]	166
[195]	167	<span class="attr">optional</span>
[89]	168
	169
[195]	170	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	171
	172
	173	</h4>
	174
[195]	175	<div class="comments">
	176	x starting point, optional if [XY]AXIS keyword is used
	177	</div>
[89]	178
	179	<h4 id="_computegrid_param_starty">starty
[195]	180	<span class="attr">in</span>
[89]	181
[195]	182	<span class="attr">optional</span>
[89]	183
	184
[195]	185	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	186
	187
	188	</h4>
	189
[195]	190	<div class="comments">
	191	y starting point, optional if [XY]AXIS keyword is used
	192	</div>
[89]	193
	194	<h4 id="_computegrid_param_stepxin">stepxin
[195]	195	<span class="attr">in</span>
[89]	196
[195]	197	<span class="attr">optional</span>
[89]	198
	199
[195]	200	<span class="attr">type:</span> <span class="value">scalar or vector</span>
[89]	201
	202
	203	</h4>
	204
[195]	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>
[89]	209
	210	<h4 id="_computegrid_param_stepyin">stepyin
[195]	211	<span class="attr">in</span>
[89]	212
[195]	213	<span class="attr">optional</span>
[89]	214
	215
[195]	216	<span class="attr">type:</span> <span class="value">scalar or vector</span>
[89]	217
	218
	219	</h4>
	220
[195]	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>
[89]	226
	227	<h4 id="_computegrid_param_nxin">nxin
[195]	228	<span class="attr">in</span>
[89]	229
[195]	230	<span class="attr">optional</span>
[89]	231
	232
[195]	233	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	234
	235
	236	</h4>
	237
[195]	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>
[89]	242
	243	<h4 id="_computegrid_param_nyin">nyin
[195]	244	<span class="attr">in</span>
[89]	245
[195]	246	<span class="attr">optional</span>
[89]	247
	248
[195]	249	<span class="attr">type:</span> <span class="value">scalar</span>
[89]	250
	251
	252	</h4>
	253
[234]	254	<div class="comments">
[195]	255	number of points in y direction,
	256	optional if [XY]AXIS keyword is used or stepyin is a vector
	257	</div>
[89]	258
	259
	260
	261
	262
	263
	264	<h3>Keywords</h3>
	265
	266	<h4 id="_computegrid_keyword_XAXIS">XAXIS
	267
	268
	269
	270
	271
[195]	272	<span class="attr">type:</span> <span class="value">1D or 2D array</span>
[89]	273
	274
	275	</h4>
	276
[195]	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>
[89]	283
	284	<h4 id="_computegrid_keyword_YAXIS">YAXIS
	285
	286
	287
	288
	289
[195]	290	<span class="attr">type:</span> <span class="value">1D or 2D array</span>
[89]	291
	292
	293	</h4>
	294
[195]	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
[242]	298	xaxis. It must be sorted in the increasing or decreasing order (along each column if 2d array).
[195]	299	</div>
[89]	300
	301	<h4 id="_computegrid_keyword_ZAXIS">ZAXIS
	302
	303
	304
	305
	306
[195]	307	<span class="attr">type:</span> <span class="value">1D</span>
[89]	308
	309
	310	</h4>
	311
[195]	312	<div class="comments">
[242]	313	Specify the vertical axis. Must be sorted in the increasing or decreasing order
[195]	314	</div>
[89]	315
	316	<h4 id="_computegrid_keyword_MASK">MASK
	317
	318
	319
	320
	321
[195]	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>
[89]	324
	325	</h4>
	326
[195]	327	<div class="comments">
	328	Specify the land(0)/sea(1) mask
	329	</div>
[89]	330
	331	<h4 id="_computegrid_keyword_GLAMBOUNDARY">GLAMBOUNDARY
	332
	333
	334
	335
	336
[195]	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>
[89]	339
	340	</h4>
	341
[195]	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>
[89]	349
	350	<h4 id="_computegrid_keyword_XMINMESH">XMINMESH
	351
	352
	353
	354
	355
[195]	356	<span class="attr">type:</span> <span class="value">scalar</span>
	357	<span class="attr">default:</span> <span class="value">0L</span>
[89]	358
	359	</h4>
	360
[195]	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>
[89]	365
	366	<h4 id="_computegrid_keyword_XMAXMESH">XMAXMESH
	367
	368
	369
	370
	371
[195]	372	<span class="attr">type:</span> <span class="value">scalar</span>
	373	<span class="attr">default:</span> <span class="value">jpiglo-1</span>
[89]	374
	375	</h4>
	376
[195]	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>
[89]	382
	383	<h4 id="_computegrid_keyword_YMINMESH">YMINMESH
	384
	385
	386
	387
	388
[195]	389	<span class="attr">type:</span> <span class="value">scalar</span>
	390	<span class="attr">default:</span> <span class="value">0L</span>
[89]	391
	392	</h4>
	393
[195]	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>
[89]	398
	399	<h4 id="_computegrid_keyword_YMAXMESH">YMAXMESH
	400
	401
	402
	403
	404
[195]	405	<span class="attr">type:</span> <span class="value">scalar</span>
	406	<span class="attr">default:</span> <span class="value">jpjglo-1</span>
[89]	407
	408	</h4>
	409
[195]	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>
[89]	415
	416	<h4 id="_computegrid_keyword_ZMINMESH">ZMINMESH
	417
	418
	419
	420
	421
[195]	422	<span class="attr">type:</span> <span class="value">scalar</span>
	423	<span class="attr">default:</span> <span class="value">0L</span>
[89]	424
	425	</h4>
	426
[195]	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>
[89]	431
	432	<h4 id="_computegrid_keyword_ZMAXMESH">ZMAXMESH
	433
	434
	435
	436
	437
[195]	438	<span class="attr">type:</span> <span class="value">scalar</span>
	439	<span class="attr">default:</span> <span class="value">jpkglo-1</span>
[89]	440
	441	</h4>
	442
[195]	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>
[89]	448
	449	<h4 id="_computegrid_keyword_ONEARTH">ONEARTH
	450
	451
	452
	453
	454
[195]	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>
[89]	457
	458	</h4>
	459
[195]	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
[338]	466	ONEARTH=0 forces PERIODIC=0, SHIFT=0 and is cancelling GLAMBOUNDARY
[195]	467	</div>
[89]	468
	469	<h4 id="_computegrid_keyword_PERIODIC">PERIODIC
	470
	471
	472
	473
	474
[195]	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>
[89]	477
	478	</h4>
	479
[195]	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
[338]	483	PERIODIC=0 forces SHIFT=0
[195]	484	</div>
[89]	485
	486	<h4 id="_computegrid_keyword_PLAIN">PLAIN
	487
	488
	489
	490
	491
[195]	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>
[89]	494
	495	</h4>
	496
[195]	497	<div class="comments">
[338]	498	Force YREVERSE=0, ZREVERSE=0, PERIODIC=0, SHIFT=0, STRIDE=[1, 1, 1] and
[290]	499	suppress the automatic redefinition of the domain in case of x periodicity overlap,
	500	y periodicity overlap (ORCA type only) and mask border to 0.
[195]	501	</div>
[89]	502
	503	<h4 id="_computegrid_keyword_SHIFT">SHIFT
	504
	505
	506
	507
	508
[195]	509	<span class="attr">type:</span> <span class="value">scalar</span>
	510	<span class="attr">default:</span> <span class="value">computed according to glamboundary</span>
[89]	511
	512	</h4>
	513
[195]	514	<div class="comments">
[234]	515	Force the manual definition of the zonal shift that must be apply to the data.
[195]	516	The resulting value will be stored in the common (cm_4mesh) variable key_shift
[338]	517	Note that if key_periodic=0 then in any case key_shift=0.
[195]	518	</div>
[89]	519
	520	<h4 id="_computegrid_keyword_STRIDE">STRIDE
	521
	522
	523
	524
	525
[195]	526	<span class="attr">type:</span> <span class="value">3 elements vector</span>
	527	<span class="attr">default:</span> <span class="value">[1, 1, 1]</span>
[89]	528
	529	</h4>
	530
[195]	531	<div class="comments">
	532	Specify the stride in x, y and z direction. The resulting
	533	value will be stored in the common (cm_4mesh) variable key_stride
	534	</div>
[89]	535
[290]	536	<h4 id="_computegrid_keyword_YREVERSE">YREVERSE
	537
	538
	539
	540
	541
	542	<span class="attr">type:</span> <span class="value">scalar</span>
	543	<span class="attr">default:</span> <span class="value">computed according to gphit[0, 1:jpj-1] LT gphit[0, 0:jpj-2]</span>
	544
	545	</h4>
	546
	547	<div class="comments">
	548	Force the manual definition of the y reverse that must be apply to the data.
	549	The resulting value will be stored in the common (cm_4mesh) variable key_yreverse
	550	</div>
	551
	552	<h4 id="_computegrid_keyword_ZREVERSE">ZREVERSE
	553
	554
	555
	556
	557
	558	<span class="attr">type:</span> <span class="value">scalar</span>
	559	<span class="attr">default:</span> <span class="value">computed according to gdept[0] GT gdept[1]</span>
	560
	561	</h4>
	562
	563	<div class="comments">
	564	Force the manual definition of the z reverse that must be apply to the data.
	565	The resulting value will be stored in the common (cm_4mesh) variable key_zreverse
	566	</div>
	567
[89]	568	<h4 id="_computegrid_keyword_FULLCGRID">FULLCGRID
	569
	570
	571
	572
	573
[195]	574	<span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
	575	<span class="attr">default:</span> <span class="value">0</span>
[89]	576
	577	</h4>
	578
[195]	579	<div class="comments">
	580	Activate to specify that you want to compute all the C grid parameters:
	581	definition of glam[uv], gphi[uv], e1[uvf], e2[uvf], [uv]maskred and
	582	fmaskred[xy] will be add to the default computations
	583	</div>
[89]	584
	585	<h4 id="_computegrid_keyword_XYINDEX">XYINDEX
	586
	587
	588
	589
	590
	591
	592
	593
	594	</h4>
	595
[195]	596	<div class="comments"> activate to specify that the horizontal grid should
	597	be simply defined by using the index of the points
	598	(xaxis = findgen(nx) and yaxis = findgen(ny))
	599	using this keyword forces key_onearth=0
	600	</div>
[89]	601
[210]	602	<h4 id="_computegrid_keyword_UBASE2TBASE">UBASE2TBASE
	603
	604
	605
	606
	607
	608
	609
	610
	611	</h4>
	612
	613	<div class="comments">
	614	Activate when the model is a C grid based on a U point
	615	(with a U point at the bottom-left corner and a T point at the
[234]	616	upper-right corner). In this case, we ignore
[210]	617	- if the grid is not x-periodic, the first column of F and U points
	618	- if the grid is not x-periodic, the last column of T and V points.
	619	=> we are back to a C grid based on T point as for OPA model.
	620	Note that in that case, key_gridtype = 'c_u' and not 'c' (-> used in read_ncdf)
	621	Note that activate UBASE2TBASE forces FULLCGRID=1
	622	</div>
	623
	624	<h4 id="_computegrid_keyword_VBASE2TBASE">VBASE2TBASE
	625
	626
	627
	628
	629
	630
	631
	632
	633	</h4>
	634
	635	<div class="comments">
	636	Activate when the model is a C grid based on a V point
	637	(with a V point at the bottom-left corner and a T point at the
[234]	638	upper-right corner). In this case, we ignore
[210]	639	- the first line of F and V points
	640	- the last line of T and U points
	641	=> we are back to a C grid based on T point as for OPA model.
	642	Note that in that case, key_gridtype = 'c_v' and not 'c' (-> used in read_ncdf)
	643	Note that activate VBASE2TBASE forces FULLCGRID=1
	644	</div>
	645
[89]	646	<h4 id="_computegrid_keyword_FBASE2TBASE">FBASE2TBASE
	647
	648
	649
	650
	651
	652
	653
	654
	655	</h4>
	656
[195]	657	<div class="comments">
	658	Activate when the model is a C grid based on a F point
	659	(with a F point at the bottom-left corner and a T point at the
[234]	660	upper-right corner). In this case, we ignore
[210]	661	- the first line of F and V points
	662	- the last line of T and U points
	663	- if the grid is not x-periodic, the first column of F and U points
	664	- if the grid is not x-periodic, the last column of T and V points.
	665	=> we are back to a C grid based on T point as for OPA model.
	666	Note that in that case, key_gridtype = 'c_f' and not 'c' (-> used in read_ncdf)
	667	Note that activate FBASE2TBASE forces FULLCGRID=1
[195]	668	</div>
[89]	669
	670	<h4 id="_computegrid_keyword_STRCALLING">STRCALLING
	671
	672
	673
	674
	675
[195]	676	<span class="attr">type:</span> <span class="value">scalar string</span>
[89]	677
	678
	679	</h4>
	680
[195]	681	<div class="comments">
	682	a string containing the calling command used to
[242]	683	call computegrid (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>)
[195]	684
	685
	686	Used by xxx...
	687	</div>
[89]	688
[177]	689	<h4 id="_computegrid_keyword_ROMSH">ROMSH
	690
	691
	692
	693
	694
[195]	695	<span class="attr">type:</span> <span class="value">2D array</span>
[177]	696
	697
	698	</h4>
	699
[195]	700	<div class="comments">
	701	This array is the final bathymetry at RHO-points. It is stored in the common
	702	variable (cm_4mesh) romszinfos.h
	703	Used when the model is a ROMS C-grid with one more point
	704	in longitude for T and V grid and one more point in latitude
[234]	705	for T and U grid. In this case, we ignore
[195]	706	- the last line of T and U points
	707	- the last column of T and V points.
	708	=> we are back to a C grid based on T point as for OPA model.
	709	Note that activate ROMSH forces FULLCGRID=1
	710	</div>
[177]	711
[234]	712	<h4 id="_computegrid_keyword__EXTRA">_EXTRA
[89]	713
	714
	715
	716
	717
	718
	719
	720
	721	</h4>
	722
[234]	723	<div class="comments">
[242]	724	not used in the present case ...
[195]	725	</div>
[89]	726
	727
	728
	729
[195]	730	<h3>Version history</h3>
[89]	731
[234]	732	<h4>Version</h4><div class="preformat">
[402]	733	$Id: computegrid.pro 399 2009-07-02 08:38:54Z smasson $
[195]	734	</div>
[234]	735	<h4>History</h4><div class="preformat">
	736	Sebastien Masson (smasson@lodyc.jussieu.fr)
[195]	737	2000-04-20
[402]	738	Sept 2004, several bug fix to suit C grid type...
	739	Aug 2005, rewritte almost everything...
[195]	740	</div>
[89]	741
	742
[195]	743	<h3>Known issues</h3>
[89]	744
	745
	746
[242]	747	<h4>Restrictions</h4><div class="preformat">
	748	if the grid has x/y periodicity overlap and/or if
[402]	749	the mask has 0 everywhere at the border (like a closed sea) and
	750	if (we did not activate /plain and xminmesh, xmaxmesh, yminmesh,
	751	ymaxmesh keywords are defined to their default values), we redefine
	752	xminmesh, xmaxmesh, yminmesh, ymaxmesh in order to reove the
	753	overlapping part and/or to open the domain (avoid it be forced
	754	to use cell_fill = 1).
[195]	755
	756	FUV points definition is not exact if the grid is irregular
	757	</div>
[89]	758
[195]	759	<h3>Other attributes</h3>
[89]	760
	761
[242]	762	<h4>Uses routines</h4><div class="preformat">
[402]	763	<a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
	764	<a href="..//Commons/cm_4data.html">cm_4data</a>
	765	<a href="..//Commons/cm_4cal.html">cm_4cal</a>
[290]	766
[195]	767	</div>
[89]	768
	769
	770
	771
[163]	772	<h3>Statistics</h3>
	773	<table class="statistics">
[402]	774	<tr><td>McCabe cyclic</td><td> 241</td></tr>
[163]	775	<tr><td>McCabe essential</td><td> 1</td></tr>
	776	<tr><td>McCabe modular design</td><td> 1</td></tr>
	777	</table>
[89]	778
	779
	780	</div>
	781
	782	</div>
	783
	784
	785
	786	<div id="tagline">Produced by IDLdoc 2.0.</div>
	787
	788	</div>
	789
	790	</body>
[249]	791	</html>

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

Context Navigation

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

Download in other formats: