source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readoldoparestart.html @ 249

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation

File size: 13.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>readoldoparestart.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="readoldopadistcoast.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="scanctl.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ReadWrite/</font></h1>
58    <h2>readoldoparestart.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 read the old restart files of OPA (before NetCDF)
65 based on the OPA subroutine dtrlec included at the end of the file.
66
67
68   
69    <h2>Routine summary</h2>
70
71    <dl>
72     
73      <dt><a href="#_read2fromopa"><i>result = </i>read2fromopa(<i>unit, params, num</i>)</a><dt>
74      <dd><font size="-1"> </font></dd>
75     
76      <dt><a href="#_read3fromopa"><i>result = </i>read3fromopa(<i>unit, params, num</i>)</a><dt>
77      <dd><font size="-1"></font></dd>
78     
79      <dt><a href="#_readoldoparestart">readoldoparestart<i>, filename, jpiglo, jpjglo, jpk</i>, IBLOC=<i>IBLOC</i>, JPBYT=<i>JPBYT</i>, NUMREC=<i>NUMREC</i>, ub=<i>ub</i>, vb=<i>vb</i>, tb=<i>tb</i>, sb=<i>sb</i>, rotb=<i>rotb</i>, hdivb=<i>hdivb</i>, un=<i>un</i>, vn=<i>vn</i>, tn=<i>tn</i>, sn=<i>sn</i>, rotn=<i>rotn</i>, hdivn=<i>hdivn</i>, gcx=<i>gcx</i>, gcxb=<i>gcxb</i>, etab=<i>etab</i>, etan=<i>etan</i>, bsfb=<i>bsfb</i>, bsfn=<i>bsfn</i>, bsfd=<i>bsfd</i>, en=<i>en</i></a><dt>
80      <dd><font size="-1"></font></dd>
81     
82    </dl>
83
84    <p>&nbsp;</p>
85   
86
87     
88      <a name="#_read2fromopa"></a>
89
90      <h2>read2fromopa  <font size="-1" color="#006633">
91 For OPA
92</font></h2>
93
94      <p><font face="Courier"><i>result = </i>read2fromopa(<i><a href="#_read2fromopa_keyword_unit">unit</a>, <a href="#_read2fromopa_keyword_params">params</a>, <a href="#_read2fromopa_keyword_num">num</a></i>)</font></p>
95
96   
97
98
99   
100
101   
102    <h3>Parameters</h3>
103   
104
105    <a name="#_read2fromopa_keyword_unit"></a>
106    <h4>unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
107     
108     
109     
110     
111     
112     
113     
114     
115    </h4>
116
117   
118
119
120   
121
122    <a name="#_read2fromopa_keyword_params"></a>
123    <h4>params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124     
125     
126     
127     
128     
129     
130     
131     
132    </h4>
133
134   
135
136   
137
138    <a name="#_read2fromopa_keyword_num"></a>
139    <h4>num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
140     
141     
142     
143     
144     
145     
146     
147     
148    </h4>
149
150   
151
152   
153   
154
155   
156
157   
158    </pre><h3>Version history</h3>
159   
160    <h4>Version</h4>
161 $Id: readoldoparestart.pro 240 2007-03-28 12:17:24Z pinsard $
162    <h4>History</h4>
163 Sebastien Masson (smasson@lodyc.jussieu.fr)
164                      June 2002
165
166   
167
168    <h3>Known issues</h3>
169   
170   
171   
172    <h4>Restrictions</h4>
173 bug for etab and etan written on the same record???
174
175
176   
177   
178   
179   
180   
181   
182   
183
184    <font size="-3"><p>&nbsp;</p></font>
185    <hr size="1" color="#CCCCCC"/>
186     
187      <a name="#_read3fromopa"></a>
188
189      <h2>read3fromopa  <font size="-1" color="#006633">
190 For OPA
191</font></h2>
192
193      <p><font face="Courier"><i>result = </i>read3fromopa(<i><a href="#_read3fromopa_keyword_unit">unit</a>, <a href="#_read3fromopa_keyword_params">params</a>, <a href="#_read3fromopa_keyword_num">num</a></i>)</font></p>
194
195   
196
197   
198
199   
200    <h3>Parameters</h3>
201   
202
203    <a name="#_read3fromopa_keyword_unit"></a>
204    <h4>unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205     
206     
207     
208     
209     
210     
211     
212     
213    </h4>
214
215   
216
217
218   
219
220    <a name="#_read3fromopa_keyword_params"></a>
221    <h4>params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222     
223     
224     
225     
226     
227     
228     
229     
230    </h4>
231
232   
233
234   
235
236    <a name="#_read3fromopa_keyword_num"></a>
237    <h4>num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238     
239     
240     
241     
242     
243     
244     
245     
246    </h4>
247
248   
249
250   
251   
252
253   
254
255   
256    </pre><h3>Version history</h3>
257   
258   
259    <h4>History</h4>
260 Sebastien Masson (smasson@lodyc.jussieu.fr)
261                      June 2002
262   
263
264   
265   
266   
267   
268   
269
270   
271   
272   
273   
274   
275   
276   
277
278    <font size="-3"><p>&nbsp;</p></font>
279    <hr size="1" color="#CCCCCC"/>
280     
281      <a name="#_readoldoparestart"></a>
282
283      <h2>readoldoparestart  <font size="-1" color="#006633">
284 For OPA
285</font></h2>
286
287      <p><font face="Courier">readoldoparestart<i>, <a href="#_readoldoparestart_keyword_filename">filename</a>, <a href="#_readoldoparestart_keyword_jpiglo">jpiglo</a>, <a href="#_readoldoparestart_keyword_jpjglo">jpjglo</a>, <a href="#_readoldoparestart_keyword_jpk">jpk</a></i>, <a href="#_readoldoparestart_keyword_IBLOC">IBLOC</a>=<i>IBLOC</i>, <a href="#_readoldoparestart_keyword_JPBYT">JPBYT</a>=<i>JPBYT</i>, <a href="#_readoldoparestart_keyword_NUMREC">NUMREC</a>=<i>NUMREC</i>, <a href="#_readoldoparestart_keyword_ub">ub</a>=<i>ub</i>, <a href="#_readoldoparestart_keyword_vb">vb</a>=<i>vb</i>, <a href="#_readoldoparestart_keyword_tb">tb</a>=<i>tb</i>, <a href="#_readoldoparestart_keyword_sb">sb</a>=<i>sb</i>, <a href="#_readoldoparestart_keyword_rotb">rotb</a>=<i>rotb</i>, <a href="#_readoldoparestart_keyword_hdivb">hdivb</a>=<i>hdivb</i>, <a href="#_readoldoparestart_keyword_un">un</a>=<i>un</i>, <a href="#_readoldoparestart_keyword_vn">vn</a>=<i>vn</i>, <a href="#_readoldoparestart_keyword_tn">tn</a>=<i>tn</i>, <a href="#_readoldoparestart_keyword_sn">sn</a>=<i>sn</i>, <a href="#_readoldoparestart_keyword_rotn">rotn</a>=<i>rotn</i>, <a href="#_readoldoparestart_keyword_hdivn">hdivn</a>=<i>hdivn</i>, <a href="#_readoldoparestart_keyword_gcx">gcx</a>=<i>gcx</i>, <a href="#_readoldoparestart_keyword_gcxb">gcxb</a>=<i>gcxb</i>, <a href="#_readoldoparestart_keyword_etab">etab</a>=<i>etab</i>, <a href="#_readoldoparestart_keyword_etan">etan</a>=<i>etan</i>, <a href="#_readoldoparestart_keyword_bsfb">bsfb</a>=<i>bsfb</i>, <a href="#_readoldoparestart_keyword_bsfn">bsfn</a>=<i>bsfn</i>, <a href="#_readoldoparestart_keyword_bsfd">bsfd</a>=<i>bsfd</i>, <a href="#_readoldoparestart_keyword_en">en</a>=<i>en</i></font></p>
288
289   
290
291    <h3>Return value</h3>
292 According to the given keywords.
293
294
295   
296    <h3>Parameters</h3>
297   
298
299    <a name="#_readoldoparestart_keyword_filename"></a>
300    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
301      <font size="-1" color="#006633">in</font>
302     
303     
304      <font size="-1" color="#006633">required</font>
305     
306     
307     
308     
309    </h4>
310
311   
312 with the whole path if necessary
313
314   
315
316    <a name="#_readoldoparestart_keyword_jpiglo"></a>
317    <h4>jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
318      <font size="-1" color="#006633">in</font>
319     
320     
321      <font size="-1" color="#006633">required</font>
322     
323     
324     
325     
326    </h4>
327
328   
329
330   
331
332    <a name="#_readoldoparestart_keyword_jpjglo"></a>
333    <h4>jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
334      <font size="-1" color="#006633">in</font>
335     
336     
337      <font size="-1" color="#006633">required</font>
338     
339     
340     
341     
342    </h4>
343
344   
345
346   
347
348    <a name="#_readoldoparestart_keyword_jpk"></a>
349    <h4>jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
350      <font size="-1" color="#006633">in</font>
351     
352     
353      <font size="-1" color="#006633">required</font>
354     
355     
356     
357     
358    </h4>
359
360   
361 dimensions of the opa grid
362
363   
364   
365
366   
367    <h3>Keywords</h3>
368
369   
370    <a name="#_readoldoparestart_keyword_IBLOC"></a>
371    <h4>IBLOC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372     
373     
374     
375     
376     
377     
378      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>4096L</i></font>
379     
380    </h4>
381
382   
383 Ibloc size
384
385   
386    <a name="#_readoldoparestart_keyword_JPBYT"></a>
387    <h4>JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
388     
389     
390     
391     
392     
393     
394      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>8L</i></font>
395     
396    </h4>
397
398   
399 Jpbyt size
400
401   
402    <a name="#_readoldoparestart_keyword_NUMREC"></a>
403    <h4>NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
404     
405     
406     
407     
408     
409     
410      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>19L*jpk</i></font>
411     
412    </h4>
413
414   
415 Number of records in the file
416
417   
418    <a name="#_readoldoparestart_keyword_ub"></a>
419    <h4>ub&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
420     
421     
422     
423     
424     
425     
426     
427     
428    </h4>
429
430   
431
432
433   
434    <a name="#_readoldoparestart_keyword_vb"></a>
435    <h4>vb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
436     
437     
438     
439     
440     
441     
442     
443     
444    </h4>
445
446   
447
448
449   
450    <a name="#_readoldoparestart_keyword_tb"></a>
451    <h4>tb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
452     
453     
454     
455     
456     
457     
458     
459     
460    </h4>
461
462   
463
464   
465    <a name="#_readoldoparestart_keyword_sb"></a>
466    <h4>sb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
467     
468     
469     
470     
471     
472     
473     
474     
475    </h4>
476
477   
478
479   
480    <a name="#_readoldoparestart_keyword_rotb"></a>
481    <h4>rotb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
482     
483     
484     
485     
486     
487     
488     
489     
490    </h4>
491
492   
493
494   
495    <a name="#_readoldoparestart_keyword_hdivb"></a>
496    <h4>hdivb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
497     
498     
499     
500     
501     
502     
503     
504     
505    </h4>
506
507   
508
509   
510    <a name="#_readoldoparestart_keyword_un"></a>
511    <h4>un&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
512     
513     
514     
515     
516     
517     
518     
519     
520    </h4>
521
522   
523
524   
525    <a name="#_readoldoparestart_keyword_vn"></a>
526    <h4>vn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
527     
528     
529     
530     
531     
532     
533     
534     
535    </h4>
536
537   
538
539   
540    <a name="#_readoldoparestart_keyword_tn"></a>
541    <h4>tn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
542     
543     
544     
545     
546     
547     
548     
549     
550    </h4>
551
552   
553
554   
555    <a name="#_readoldoparestart_keyword_sn"></a>
556    <h4>sn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
557     
558     
559     
560     
561     
562     
563     
564     
565    </h4>
566
567   
568
569   
570    <a name="#_readoldoparestart_keyword_rotn"></a>
571    <h4>rotn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
572     
573     
574     
575     
576     
577     
578     
579     
580    </h4>
581
582   
583
584   
585    <a name="#_readoldoparestart_keyword_hdivn"></a>
586    <h4>hdivn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
587     
588     
589     
590     
591     
592     
593     
594     
595    </h4>
596
597   
598
599   
600    <a name="#_readoldoparestart_keyword_gcx"></a>
601    <h4>gcx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
602     
603     
604     
605     
606     
607     
608     
609     
610    </h4>
611
612   
613
614   
615    <a name="#_readoldoparestart_keyword_gcxb"></a>
616    <h4>gcxb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
617     
618     
619     
620     
621     
622     
623     
624     
625    </h4>
626
627   
628
629   
630    <a name="#_readoldoparestart_keyword_etab"></a>
631    <h4>etab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
632     
633     
634     
635     
636     
637     
638     
639     
640    </h4>
641
642   
643
644   
645    <a name="#_readoldoparestart_keyword_etan"></a>
646    <h4>etan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
647     
648     
649     
650     
651     
652     
653     
654     
655    </h4>
656
657   
658
659   
660    <a name="#_readoldoparestart_keyword_bsfb"></a>
661    <h4>bsfb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
662     
663     
664     
665     
666     
667     
668     
669     
670    </h4>
671
672   
673
674   
675    <a name="#_readoldoparestart_keyword_bsfn"></a>
676    <h4>bsfn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
677     
678     
679     
680     
681     
682     
683     
684     
685    </h4>
686
687   
688
689   
690    <a name="#_readoldoparestart_keyword_bsfd"></a>
691    <h4>bsfd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
692     
693     
694     
695     
696     
697     
698     
699     
700    </h4>
701
702   
703
704   
705    <a name="#_readoldoparestart_keyword_en"></a>
706    <h4>en&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
707     
708     
709     
710     
711     
712     
713     
714     
715    </h4>
716
717   
718 the variable we want to read.
719
720   
721   
722
723   
724    </pre><h3>Version history</h3>
725   
726    <h4>Version</h4>
727 $Id: readoldoparestart.pro 240 2007-03-28 12:17:24Z pinsard $
728    <h4>History</h4>
729 Sebastien Masson (smasson@lodyc.jussieu.fr)
730                      June 2002
731
732   
733
734    <h3>Known issues</h3>
735   
736   
737   
738    <h4>Restrictions</h4>
739 Bug for etab and etan written on the same record???
740
741
742   
743   
744   
745   
746   
747   
748   
749
750    <font size="-3"><p>&nbsp;</p></font>
751    <hr size="1" color="#CCCCCC"/>
752     
753
754   
755
756    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
757
758  </body>
759</html>
Note: See TracBrowser for help on using the repository browser.