Context Navigation

readoldoparestart.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago
update documentation
File size: 16.8 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>readoldoparestart.pro (SAXO Documentation)</title>
10
11
12	<link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13	<link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14
15
16	<script type="text/javascript">
17	function setTitle() {
18	parent.document.title="readoldoparestart.pro (SAXO Documentation)";
19	}
20	</script>
21	</head>
22
23	<body onload="setTitle();">
24
25	<div id="navbar_title">
26	<h1>SAXO Documentation</h1>
27	</div>
28
29
30	<div id="main_navbar">
31
32	<table cellspacing="0">
33	<tr>
34
35	<td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36
37
38
39	<td >Directory</td>
40
41
42
43	<td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44
45
46
47	<td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48
49
50
51	<td><a href="./../search-page.html" title="Search library">Search</a></td>
52
53
54	<td id="selected">File</td>
55
56
57	<td><a href="../../../ReadWrite//readoldoparestart.pro" title="Source code of a file">Source</a></td>
58
59
60
61	<td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62
63
64	<td >Etc</td>
65
66	<td id="flexible">Developer documentation</td>
67	</tr>
68	</table>
69
70	</div>
71
72	<div id="secondary_navbar">
73
74	<a href="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>
75
76	</div>
77
78
79	<div id="container">
80
81	<h1 class="directory"><a href="directory-overview.html">ReadWrite/</a></h1>
82	<h2 class="pro_file">readoldoparestart.pro</h2>
83
84	<div id="file_attr">
85	<dl>
86	</dl>
87	</div>
88
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>
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>
107	<dd> </dd>
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
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>
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
124	<h2><a class="top" href="#container">top</a>read2fromopa <span class="categories">
125	For OPA
126	</span></h2>
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
151	<div class="comments">
152	</div>
153
154	<h4 id="_read2fromopa_param_params">params
155
156
157
158
159
160
161
162
163	</h4>
164
165	<div class="comments">
166	</div>
167
168	<h4 id="_read2fromopa_param_num">num
169
170
171
172
173
174
175
176
177	</h4>
178
179	<div class="comments">
180	</div>
181
182
183
184
185
186
187
188	<h3>Version history</h3>
189
190	<h4>Version</h4><div class="preformat">
191	$Id: readoldoparestart.pro 327 2007-12-13 16:22:35Z pinsard $
192	</div>
193	<h4>History</h4><div class="preformat">
194	Sebastien Masson (smasson@lodyc.jussieu.fr)
195	June 2002
196	</div>
197
198
199	<h3>Known issues</h3>
200
201
202
203	<h4>Restrictions</h4><div class="preformat">
204	bug for etab and etan written on the same record???
205	</div>
206
207
208
209
210
211
212
213
214
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>
221
222
223	</div>
224
225
226	<div class="routine_details" id="_read3fromopa">
227
228	<h2><a class="top" href="#container">top</a>read3fromopa <span class="categories">
229	For OPA
230	</span></h2>
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
254	<div class="comments">
255	</div>
256
257	<h4 id="_read3fromopa_param_params">params
258
259
260
261
262
263
264
265
266	</h4>
267
268	<div class="comments">
269	</div>
270
271	<h4 id="_read3fromopa_param_num">num
272
273
274
275
276
277
278
279
280	</h4>
281
282	<div class="comments">
283	</div>
284
285
286
287
288
289
290
291	<h3>Version history</h3>
292
293
294	<h4>History</h4><div class="preformat">
295	Sebastien Masson (smasson@lodyc.jussieu.fr)
296	June 2002</div>
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313	<h3>Statistics</h3>
314	<table class="statistics">
315	<tr><td>McCabe cyclic</td><td> 1</td></tr>
316	<tr><td>McCabe essential</td><td> 1</td></tr>
317	<tr><td>McCabe modular design</td><td> 1</td></tr>
318	</table>
319
320
321	</div>
322
323
324	<div class="routine_details" id="_readoldoparestart">
325
326	<h2><a class="top" href="#container">top</a>readoldoparestart <span class="categories">
327	For OPA
328	</span></h2>
329
330	<p class="header">
331	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>
332
333	<div class="comments"></div>
334
335	<h3>Return value</h3><div class="preformat">
336	According to the given keywords.
337	</div>
338
339
340	<h3>Parameters</h3>
341
342
343	<h4 id="_readoldoparestart_param_filename">filename
344	<span class="attr">in</span>
345
346
347	<span class="attr">required</span>
348
349
350
351
352	</h4>
353
354	<div class="comments">
355	with the whole path if necessary
356	</div>
357
358	<h4 id="_readoldoparestart_param_jpiglo">jpiglo
359	<span class="attr">in</span>
360
361
362	<span class="attr">required</span>
363
364
365
366
367	</h4>
368
369	<div class="comments">
370	</div>
371
372	<h4 id="_readoldoparestart_param_jpjglo">jpjglo
373	<span class="attr">in</span>
374
375
376	<span class="attr">required</span>
377
378
379
380
381	</h4>
382
383	<div class="comments">
384	</div>
385
386	<h4 id="_readoldoparestart_param_jpk">jpk
387	<span class="attr">in</span>
388
389
390	<span class="attr">required</span>
391
392
393
394
395	</h4>
396
397	<div class="comments">
398	dimensions of the opa grid
399	</div>
400
401
402
403
404
405
406	<h3>Keywords</h3>
407
408	<h4 id="_readoldoparestart_keyword_IBLOC">IBLOC
409
410
411
412
413
414
415	<span class="attr">default:</span> <span class="value">4096L</span>
416
417	</h4>
418
419	<div class="comments">
420	Ibloc size
421	</div>
422
423	<h4 id="_readoldoparestart_keyword_JPBYT">JPBYT
424
425
426
427
428
429
430	<span class="attr">default:</span> <span class="value">8L</span>
431
432	</h4>
433
434	<div class="comments">
435	Jpbyt size
436	</div>
437
438	<h4 id="_readoldoparestart_keyword_NUMREC">NUMREC
439
440
441
442
443
444
445	<span class="attr">default:</span> <span class="value">19L*jpk</span>
446
447	</h4>
448
449	<div class="comments">
450	Number of records in the file
451	</div>
452
453	<h4 id="_readoldoparestart_keyword_UB">UB
454
455
456
457
458
459
460
461
462	</h4>
463
464	<div class="comments">
465	</div>
466
467	<h4 id="_readoldoparestart_keyword_VB">VB
468
469
470
471
472
473
474
475
476	</h4>
477
478	<div class="comments">
479	</div>
480
481	<h4 id="_readoldoparestart_keyword_TB">TB
482
483
484
485
486
487
488
489
490	</h4>
491
492	<div class="comments">
493	</div>
494
495	<h4 id="_readoldoparestart_keyword_SB">SB
496
497
498
499
500
501
502
503
504	</h4>
505
506	<div class="comments">
507	</div>
508
509	<h4 id="_readoldoparestart_keyword_ROTB">ROTB
510
511
512
513
514
515
516
517
518	</h4>
519
520	<div class="comments">
521	</div>
522
523	<h4 id="_readoldoparestart_keyword_HDIVB">HDIVB
524
525
526
527
528
529
530
531
532	</h4>
533
534	<div class="comments">
535	</div>
536
537	<h4 id="_readoldoparestart_keyword_UN">UN
538
539
540
541
542
543
544
545
546	</h4>
547
548	<div class="comments">
549	</div>
550
551	<h4 id="_readoldoparestart_keyword_VN">VN
552
553
554
555
556
557
558
559
560	</h4>
561
562	<div class="comments">
563	</div>
564
565	<h4 id="_readoldoparestart_keyword_TN">TN
566
567
568
569
570
571
572
573
574	</h4>
575
576	<div class="comments">
577	</div>
578
579	<h4 id="_readoldoparestart_keyword_SN">SN
580
581
582
583
584
585
586
587
588	</h4>
589
590	<div class="comments">
591	</div>
592
593	<h4 id="_readoldoparestart_keyword_ROTN">ROTN
594
595
596
597
598
599
600
601
602	</h4>
603
604	<div class="comments">
605	</div>
606
607	<h4 id="_readoldoparestart_keyword_HDIVN">HDIVN
608
609
610
611
612
613
614
615
616	</h4>
617
618	<div class="comments">
619	</div>
620
621	<h4 id="_readoldoparestart_keyword_GCX">GCX
622
623
624
625
626
627
628
629
630	</h4>
631
632	<div class="comments">
633	</div>
634
635	<h4 id="_readoldoparestart_keyword_GCXB">GCXB
636
637
638
639
640
641
642
643
644	</h4>
645
646	<div class="comments">
647	</div>
648
649	<h4 id="_readoldoparestart_keyword_ETAB">ETAB
650
651
652
653
654
655
656
657
658	</h4>
659
660	<div class="comments">
661	</div>
662
663	<h4 id="_readoldoparestart_keyword_ETAN">ETAN
664
665
666
667
668
669
670
671
672	</h4>
673
674	<div class="comments">
675	</div>
676
677	<h4 id="_readoldoparestart_keyword_BSFB">BSFB
678
679
680
681
682
683
684
685
686	</h4>
687
688	<div class="comments">
689	</div>
690
691	<h4 id="_readoldoparestart_keyword_BSFN">BSFN
692
693
694
695
696
697
698
699
700	</h4>
701
702	<div class="comments">
703	</div>
704
705	<h4 id="_readoldoparestart_keyword_BSFD">BSFD
706
707
708
709
710
711
712
713
714	</h4>
715
716	<div class="comments">
717	</div>
718
719	<h4 id="_readoldoparestart_keyword_EN">EN
720
721
722
723
724
725
726
727
728	</h4>
729
730	<div class="comments">
731	the variable we want to read.
732	</div>
733
734
735
736
737	<h3>Version history</h3>
738
739	<h4>Version</h4><div class="preformat">
740	$Id: readoldoparestart.pro 327 2007-12-13 16:22:35Z pinsard $</div>
741	<h4>History</h4><div class="preformat">
742	Sebastien Masson (smasson@lodyc.jussieu.fr)
743	June 2002
744	</div>
745
746
747	<h3>Known issues</h3>
748
749
750
751	<h4>Restrictions</h4><div class="preformat">
752	Bug for etab and etan written on the same record???
753	</div>
754
755
756
757
758
759
760
761
762
763	<h3>Statistics</h3>
764	<table class="statistics">
765	<tr><td>McCabe cyclic</td><td> 26</td></tr>
766	<tr><td>McCabe essential</td><td> 1</td></tr>
767	<tr><td>McCabe modular design</td><td> 1</td></tr>
768	</table>
769
770
771	</div>
772
773	</div>
774
775
776
777	<div id="tagline">Produced by IDLdoc 2.0.</div>
778
779	</div>
780
781	</body>
782	</html>

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

Context Navigation

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

Download in other formats: