Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readoldoparestart.html @ 290

Last change on this file since 290 was 290, checked in by smasson, 17 years ago
update documentation
File size: 16.8 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>readoldoparestart.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="readoldoparestart.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="../../../ReadWrite//readoldoparestart.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
[189]	74	<a href="readoldopadistcoast.html"><<prev file</a> \| <a href="scanctl.html">next file >></a>    <a href="readoldoparestart.html" target="_TOP">view single page</a> \| <a href="./../index.html" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    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">ReadWrite/</a></h1>
[89]	82	<h2 class="pro_file">readoldoparestart.pro</h2>
	83
	84	<div id="file_attr">
	85	<dl>
	86	</dl>
	87	</div>
	88
[138]	89	<div id="file_comments">
	90	read the old restart files of OPA (before NetCDF)
	91	based on the OPA subroutine dtrlec included at the end of the file.
	92	</div>
[89]	93
	94
	95
	96
	97
	98
	99
	100
	101	<div id="routine_summary">
	102	<h2>Routine summary</h2>
	103
	104	<dl>
	105
	106	<dt><p><a href="#_read2fromopa"><span class="result">result = </span>read2fromopa(<span class="result">unit, params, num</span>)</a></p><dt>
[106]	107	<dd> </dd>
[89]	108
	109	<dt><p><a href="#_read3fromopa"><span class="result">result = </span>read3fromopa(<span class="result">unit, params, num</span>)</a></p><dt>
	110	<dd></dd>
	111
[290]	112	<dt><p><a href="#_readoldoparestart">readoldoparestart<span class="result">, filename, jpiglo, jpjglo, jpk</span>, IBLOC=<span class="result">IBLOC</span>, JPBYT=<span class="result">JPBYT</span>, NUMREC=<span class="result">NUMREC</span>, UB=<span class="result">UB</span>, VB=<span class="result">VB</span>, TB=<span class="result">TB</span>, SB=<span class="result">SB</span>, ROTB=<span class="result">ROTB</span>, HDIVB=<span class="result">HDIVB</span>, UN=<span class="result">UN</span>, VN=<span class="result">VN</span>, TN=<span class="result">TN</span>, SN=<span class="result">SN</span>, ROTN=<span class="result">ROTN</span>, HDIVN=<span class="result">HDIVN</span>, GCX=<span class="result">GCX</span>, GCXB=<span class="result">GCXB</span>, ETAB=<span class="result">ETAB</span>, ETAN=<span class="result">ETAN</span>, BSFB=<span class="result">BSFB</span>, BSFN=<span class="result">BSFN</span>, BSFD=<span class="result">BSFD</span>, EN=<span class="result">EN</span></a></p><dt>
[89]	113	<dd></dd>
	114
	115	</dl>
	116	</div>
	117
	118
	119	<div id="routine_details">
	120
	121
	122	<div class="routine_details" id="_read2fromopa">
	123
[157]	124	<h2><a class="top" href="#container">top</a>read2fromopa <span class="categories">
	125	For OPA
[106]	126	</span></h2>
[89]	127
	128	<p class="header">
	129	<span class="result">result = </span>read2fromopa(<span class="result"><a href="#_read2fromopa_param_unit">unit</a>, <a href="#_read2fromopa_param_params">params</a>, <a href="#_read2fromopa_param_num">num</a></span>)</p>
	130
	131	<div class="comments">
	132	</div>
	133
	134
	135
	136
	137	<h3>Parameters</h3>
	138
	139
	140	<h4 id="_read2fromopa_param_unit">unit
	141
	142
	143
	144
	145
	146
	147
	148
	149	</h4>
	150
[157]	151	<div class="comments">
	152
	153	</div>
[89]	154
	155	<h4 id="_read2fromopa_param_params">params
	156
	157
	158
	159
	160
	161
	162
	163
	164	</h4>
	165
[157]	166	<div class="comments">
[234]	167	</div>
[89]	168
	169	<h4 id="_read2fromopa_param_num">num
	170
	171
	172
	173
	174
	175
	176
	177
	178	</h4>
	179
[157]	180	<div class="comments">
	181	</div>
[89]	182
	183
	184
	185
	186
	187
	188
[106]	189	<h3>Version history</h3>
[89]	190
[234]	191	<h4>Version</h4><div class="preformat">
[290]	192	$Id: readoldoparestart.pro 262 2007-08-21 14:19:32Z pinsard $</div>
[234]	193	<h4>History</h4><div class="preformat">
	194	Sebastien Masson (smasson@lodyc.jussieu.fr)
	195	June 2002
	196	</div>
[89]	197
	198
[106]	199	<h3>Known issues</h3>
[89]	200
	201
	202
[234]	203	<h4>Restrictions</h4><div class="preformat">
[138]	204	bug for etab and etan written on the same record???
[106]	205	</div>
[89]	206
	207
	208
	209
	210
	211
	212
	213
	214
[163]	215	<h3>Statistics</h3>
	216	<table class="statistics">
	217	<tr><td>McCabe cyclic</td><td> 1</td></tr>
	218	<tr><td>McCabe essential</td><td> 1</td></tr>
	219	<tr><td>McCabe modular design</td><td> 1</td></tr>
	220	</table>
[89]	221
	222
	223	</div>
	224
	225
	226	<div class="routine_details" id="_read3fromopa">
	227
[157]	228	<h2><a class="top" href="#container">top</a>read3fromopa <span class="categories">
	229	For OPA
	230	</span></h2>
[89]	231
	232	<p class="header">
	233	<span class="result">result = </span>read3fromopa(<span class="result"><a href="#_read3fromopa_param_unit">unit</a>, <a href="#_read3fromopa_param_params">params</a>, <a href="#_read3fromopa_param_num">num</a></span>)</p>
	234
	235	<div class="comments"></div>
	236
	237
	238
	239
	240	<h3>Parameters</h3>
	241
	242
	243	<h4 id="_read3fromopa_param_unit">unit
	244
	245
	246
	247
	248
	249
	250
	251
	252	</h4>
	253
[157]	254	<div class="comments">
	255
	256	</div>
[89]	257
	258	<h4 id="_read3fromopa_param_params">params
	259
	260
	261
	262
	263
	264
	265
	266
	267	</h4>
	268
[157]	269	<div class="comments">
[234]	270	</div>
[89]	271
	272	<h4 id="_read3fromopa_param_num">num
	273
	274
	275
	276
	277
	278
	279
	280
	281	</h4>
	282
[157]	283	<div class="comments">
	284	</div>
[89]	285
	286
	287
	288
	289
	290
	291
[106]	292	<h3>Version history</h3>
[89]	293
	294
[234]	295	<h4>History</h4><div class="preformat">
	296	Sebastien Masson (smasson@lodyc.jussieu.fr)
[106]	297	June 2002</div>
[89]	298
	299
	300
	301
	302
	303
	304
	305
	306
	307
	308
	309
	310
	311
	312
	313
[163]	314	<h3>Statistics</h3>
	315	<table class="statistics">
	316	<tr><td>McCabe cyclic</td><td> 1</td></tr>
	317	<tr><td>McCabe essential</td><td> 1</td></tr>
	318	<tr><td>McCabe modular design</td><td> 1</td></tr>
	319	</table>
[89]	320
	321
	322	</div>
	323
	324
	325	<div class="routine_details" id="_readoldoparestart">
	326
[234]	327	<h2><a class="top" href="#container">top</a>readoldoparestart <span class="categories">
[157]	328	For OPA
[138]	329	</span></h2>
[89]	330
	331	<p class="header">
[290]	332	readoldoparestart<span class="result">, <a href="#_readoldoparestart_param_filename">filename</a>, <a href="#_readoldoparestart_param_jpiglo">jpiglo</a>, <a href="#_readoldoparestart_param_jpjglo">jpjglo</a>, <a href="#_readoldoparestart_param_jpk">jpk</a></span>, <a href="#_readoldoparestart_keyword_IBLOC">IBLOC</a>=<span class="result">IBLOC</span>, <a href="#_readoldoparestart_keyword_JPBYT">JPBYT</a>=<span class="result">JPBYT</span>, <a href="#_readoldoparestart_keyword_NUMREC">NUMREC</a>=<span class="result">NUMREC</span>, <a href="#_readoldoparestart_keyword_UB">UB</a>=<span class="result">UB</span>, <a href="#_readoldoparestart_keyword_VB">VB</a>=<span class="result">VB</span>, <a href="#_readoldoparestart_keyword_TB">TB</a>=<span class="result">TB</span>, <a href="#_readoldoparestart_keyword_SB">SB</a>=<span class="result">SB</span>, <a href="#_readoldoparestart_keyword_ROTB">ROTB</a>=<span class="result">ROTB</span>, <a href="#_readoldoparestart_keyword_HDIVB">HDIVB</a>=<span class="result">HDIVB</span>, <a href="#_readoldoparestart_keyword_UN">UN</a>=<span class="result">UN</span>, <a href="#_readoldoparestart_keyword_VN">VN</a>=<span class="result">VN</span>, <a href="#_readoldoparestart_keyword_TN">TN</a>=<span class="result">TN</span>, <a href="#_readoldoparestart_keyword_SN">SN</a>=<span class="result">SN</span>, <a href="#_readoldoparestart_keyword_ROTN">ROTN</a>=<span class="result">ROTN</span>, <a href="#_readoldoparestart_keyword_HDIVN">HDIVN</a>=<span class="result">HDIVN</span>, <a href="#_readoldoparestart_keyword_GCX">GCX</a>=<span class="result">GCX</span>, <a href="#_readoldoparestart_keyword_GCXB">GCXB</a>=<span class="result">GCXB</span>, <a href="#_readoldoparestart_keyword_ETAB">ETAB</a>=<span class="result">ETAB</span>, <a href="#_readoldoparestart_keyword_ETAN">ETAN</a>=<span class="result">ETAN</span>, <a href="#_readoldoparestart_keyword_BSFB">BSFB</a>=<span class="result">BSFB</span>, <a href="#_readoldoparestart_keyword_BSFN">BSFN</a>=<span class="result">BSFN</span>, <a href="#_readoldoparestart_keyword_BSFD">BSFD</a>=<span class="result">BSFD</span>, <a href="#_readoldoparestart_keyword_EN">EN</a>=<span class="result">EN</span></p>
[89]	333
	334	<div class="comments"></div>
	335
[234]	336	<h3>Return value</h3><div class="preformat">
[157]	337	According to the given keywords.
[234]	338	</div>
[89]	339
	340
	341	<h3>Parameters</h3>
	342
	343
	344	<h4 id="_readoldoparestart_param_filename">filename
[106]	345	<span class="attr">in</span>
[89]	346
	347
[106]	348	<span class="attr">required</span>
[89]	349
	350
	351
	352
	353	</h4>
	354
[138]	355	<div class="comments">
	356	with the whole path if necessary
	357	</div>
[89]	358
	359	<h4 id="_readoldoparestart_param_jpiglo">jpiglo
[106]	360	<span class="attr">in</span>
[89]	361
	362
[106]	363	<span class="attr">required</span>
[89]	364
	365
	366
	367
	368	</h4>
	369
[157]	370	<div class="comments">
[234]	371	</div>
[89]	372
	373	<h4 id="_readoldoparestart_param_jpjglo">jpjglo
[106]	374	<span class="attr">in</span>
[89]	375
	376
[106]	377	<span class="attr">required</span>
[89]	378
	379
	380
	381
	382	</h4>
	383
[157]	384	<div class="comments">
[234]	385	</div>
[89]	386
	387	<h4 id="_readoldoparestart_param_jpk">jpk
[106]	388	<span class="attr">in</span>
[89]	389
	390
[106]	391	<span class="attr">required</span>
[89]	392
	393
	394
	395
	396	</h4>
	397
[106]	398	<div class="comments">
[138]	399	dimensions of the opa grid
	400	</div>
[89]	401
	402
	403
	404
	405
	406
	407	<h3>Keywords</h3>
	408
	409	<h4 id="_readoldoparestart_keyword_IBLOC">IBLOC
	410
	411
	412
	413
	414
	415
[121]	416	<span class="attr">default:</span> <span class="value">4096L</span>
[89]	417
	418	</h4>
	419
[234]	420	<div class="comments">
[157]	421	Ibloc size
[234]	422	</div>
[89]	423
	424	<h4 id="_readoldoparestart_keyword_JPBYT">JPBYT
	425
	426
	427
	428
	429
	430
[121]	431	<span class="attr">default:</span> <span class="value">8L</span>
[89]	432
	433	</h4>
	434
[157]	435	<div class="comments">
	436	Jpbyt size
[234]	437	</div>
[89]	438
	439	<h4 id="_readoldoparestart_keyword_NUMREC">NUMREC
	440
	441
	442
	443
	444
	445
[121]	446	<span class="attr">default:</span> <span class="value">19L*jpk</span>
[89]	447
	448	</h4>
	449
[234]	450	<div class="comments">
[157]	451	Number of records in the file
[234]	452	</div>
[89]	453
[290]	454	<h4 id="_readoldoparestart_keyword_UB">UB
[89]	455
	456
	457
	458
	459
	460
	461
	462
	463	</h4>
	464
[157]	465	<div class="comments">
[234]	466
	467	</div>
[89]	468
[290]	469	<h4 id="_readoldoparestart_keyword_VB">VB
[89]	470
	471
	472
	473
	474
	475
	476
	477
	478	</h4>
	479
[157]	480	<div class="comments">
[234]	481
	482	</div>
[89]	483
[290]	484	<h4 id="_readoldoparestart_keyword_TB">TB
[89]	485
	486
	487
	488
	489
	490
	491
	492
	493	</h4>
	494
[157]	495	<div class="comments">
[234]	496	</div>
[89]	497
[290]	498	<h4 id="_readoldoparestart_keyword_SB">SB
[89]	499
	500
	501
	502
	503
	504
	505
	506
	507	</h4>
	508
[157]	509	<div class="comments">
[234]	510	</div>
[89]	511
[290]	512	<h4 id="_readoldoparestart_keyword_ROTB">ROTB
[89]	513
	514
	515
	516
	517
	518
	519
	520
	521	</h4>
	522
[157]	523	<div class="comments">
[234]	524	</div>
[89]	525
[290]	526	<h4 id="_readoldoparestart_keyword_HDIVB">HDIVB
[89]	527
	528
	529
	530
	531
	532
	533
	534
	535	</h4>
	536
[157]	537	<div class="comments">
[234]	538	</div>
[89]	539
[290]	540	<h4 id="_readoldoparestart_keyword_UN">UN
[89]	541
	542
	543
	544
	545
	546
	547
	548
	549	</h4>
	550
[157]	551	<div class="comments">
[234]	552	</div>
[89]	553
[290]	554	<h4 id="_readoldoparestart_keyword_VN">VN
[89]	555
	556
	557
	558
	559
	560
	561
	562
	563	</h4>
	564
[157]	565	<div class="comments">
[234]	566	</div>
[89]	567
[290]	568	<h4 id="_readoldoparestart_keyword_TN">TN
[89]	569
	570
	571
	572
	573
	574
	575
	576
	577	</h4>
	578
[157]	579	<div class="comments">
[234]	580	</div>
[89]	581
[290]	582	<h4 id="_readoldoparestart_keyword_SN">SN
[89]	583
	584
	585
	586
	587
	588
	589
	590
	591	</h4>
	592
[157]	593	<div class="comments">
[234]	594	</div>
[89]	595
[290]	596	<h4 id="_readoldoparestart_keyword_ROTN">ROTN
[89]	597
	598
	599
	600
	601
	602
	603
	604
	605	</h4>
	606
[157]	607	<div class="comments">
[234]	608	</div>
[89]	609
[290]	610	<h4 id="_readoldoparestart_keyword_HDIVN">HDIVN
[89]	611
	612
	613
	614
	615
	616
	617
	618
	619	</h4>
	620
[157]	621	<div class="comments">
[234]	622	</div>
[89]	623
[290]	624	<h4 id="_readoldoparestart_keyword_GCX">GCX
[89]	625
	626
	627
	628
	629
	630
	631
	632
	633	</h4>
	634
[157]	635	<div class="comments">
[234]	636	</div>
[89]	637
[290]	638	<h4 id="_readoldoparestart_keyword_GCXB">GCXB
[89]	639
	640
	641
	642
	643
	644
	645
	646
	647	</h4>
	648
[157]	649	<div class="comments">
[234]	650	</div>
[89]	651
[290]	652	<h4 id="_readoldoparestart_keyword_ETAB">ETAB
[89]	653
	654
	655
	656
	657
	658
	659
	660
	661	</h4>
	662
[157]	663	<div class="comments">
[234]	664	</div>
[89]	665
[290]	666	<h4 id="_readoldoparestart_keyword_ETAN">ETAN
[89]	667
	668
	669
	670
	671
	672
	673
	674
	675	</h4>
	676
[157]	677	<div class="comments">
[234]	678	</div>
[89]	679
[290]	680	<h4 id="_readoldoparestart_keyword_BSFB">BSFB
[89]	681
	682
	683
	684
	685
	686
	687
	688
	689	</h4>
	690
[157]	691	<div class="comments">
[234]	692	</div>
[89]	693
[290]	694	<h4 id="_readoldoparestart_keyword_BSFN">BSFN
[89]	695
	696
	697
	698
	699
	700
	701
	702
	703	</h4>
	704
[157]	705	<div class="comments">
[234]	706	</div>
[89]	707
[290]	708	<h4 id="_readoldoparestart_keyword_BSFD">BSFD
[89]	709
	710
	711
	712
	713
	714
	715
	716
	717	</h4>
	718
[157]	719	<div class="comments">
[234]	720	</div>
[89]	721
[290]	722	<h4 id="_readoldoparestart_keyword_EN">EN
[89]	723
	724
	725
	726
	727
	728
	729
	730
	731	</h4>
	732
[106]	733	<div class="comments">
[138]	734	the variable we want to read.
[106]	735	</div>
[89]	736
	737
	738
	739
[106]	740	<h3>Version history</h3>
[89]	741
[157]	742	<h4>Version</h4><div class="preformat">
[290]	743	$Id: readoldoparestart.pro 262 2007-08-21 14:19:32Z pinsard $</div>
[234]	744	<h4>History</h4><div class="preformat">
[157]	745	Sebastien Masson (smasson@lodyc.jussieu.fr)
	746	June 2002
[234]	747	</div>
[89]	748
	749
[106]	750	<h3>Known issues</h3>
[89]	751
	752
	753
[234]	754	<h4>Restrictions</h4><div class="preformat">
[157]	755	Bug for etab and etan written on the same record???
[106]	756	</div>
[89]	757
	758
	759
	760
	761
	762
	763
	764
	765
[163]	766	<h3>Statistics</h3>
	767	<table class="statistics">
	768	<tr><td>McCabe cyclic</td><td> 26</td></tr>
	769	<tr><td>McCabe essential</td><td> 1</td></tr>
	770	<tr><td>McCabe modular design</td><td> 1</td></tr>
	771	</table>
[89]	772
	773
	774	</div>
	775
	776	</div>
	777
	778
	779
	780	<div id="tagline">Produced by IDLdoc 2.0.</div>
	781
	782	</div>
	783
	784	</body>
[249]	785	</html>

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

Download in other formats: