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

Last change on this file since 106 was 106, checked in by pinsard, 18 years ago

start to modify headers of ReadWrite? *.pro files for better idldoc output

File size: 15.6 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="readoldopadistcoast.html">&lt;&lt;prev file</a> | <a href="scanctl.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="readoldoparestart.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;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?format=raw">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"> read the old restart files of OPA (before NetCDF)
90      based on the OPA subroutine dtrlec included at the end of the
91      file.</div>
92
93     
94
95     
96
97     
98
99     
100      <div id="routine_summary">               
101        <h2>Routine summary</h2>
102       
103        <dl>
104         
105          <dt><p><a href="#_read2fromopa"><span class="result">result = </span>read2fromopa(<span class="result">unit, params, num</span>)</a></p><dt>
106          <dd> </dd>   
107         
108          <dt><p><a href="#_read3fromopa"><span class="result">result = </span>read3fromopa(<span class="result">unit, params, num</span>)</a></p><dt>
109          <dd></dd>     
110         
111          <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>
112          <dd></dd>     
113               
114        </dl>
115      </div>
116     
117
118      <div id="routine_details">
119       
120
121        <div class="routine_details" id="_read2fromopa">
122
123          <h2><a class="top" href="#container">top</a>read2fromopa <span class="categories"> for OPA before NetCDF
124</span></h2>
125       
126          <p class="header">
127            <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>
128       
129          <div class="comments">
130</div>
131
132         
133
134         
135            <h3>Parameters</h3>
136       
137           
138            <h4 id="_read2fromopa_param_unit">unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139             
140             
141             
142             
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments"></div>
150           
151            <h4 id="_read2fromopa_param_params">params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
152             
153             
154             
155             
156             
157             
158             
159             
160            </h4>
161       
162          <div class="comments"></div>
163           
164            <h4 id="_read2fromopa_param_num">num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165             
166             
167             
168             
169             
170             
171             
172             
173            </h4>
174       
175          <div class="comments"></div>
176           
177
178         
179
180         
181
182         
183          <h3>Version history</h3>
184         
185         
186          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
187                      June 2002</div>
188         
189         
190          <h3>Known issues</h3>
191         
192         
193         
194          <h4>Restrictions</h4><div class="value"> bug for etab and etan written on the same record???
195</div>
196       
197         
198         
199         
200         
201         
202         
203         
204       
205         
206       
207        </div>
208       
209
210        <div class="routine_details" id="_read3fromopa">
211
212          <h2><a class="top" href="#container">top</a>read3fromopa </h2>
213       
214          <p class="header">
215            <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>
216       
217          <div class="comments"></div>
218
219         
220
221         
222            <h3>Parameters</h3>
223       
224           
225            <h4 id="_read3fromopa_param_unit">unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231             
232             
233             
234            </h4>
235       
236          <div class="comments"></div>
237           
238            <h4 id="_read3fromopa_param_params">params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239             
240             
241             
242             
243             
244             
245             
246             
247            </h4>
248       
249          <div class="comments"></div>
250           
251            <h4 id="_read3fromopa_param_num">num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
252             
253             
254             
255             
256             
257             
258             
259             
260            </h4>
261       
262          <div class="comments"></div>
263           
264
265         
266
267         
268
269         
270          <h3>Version history</h3>
271         
272         
273          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
274                      June 2002</div>
275         
276         
277         
278         
279         
280         
281         
282       
283         
284         
285         
286         
287         
288         
289         
290       
291         
292       
293        </div>
294       
295
296        <div class="routine_details" id="_readoldoparestart">
297
298          <h2><a class="top" href="#container">top</a>readoldoparestart <span class="categories"> for OPA before NetCDF</span></h2>
299       
300          <p class="header">
301            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>
302       
303          <div class="comments"></div>
304
305          <h3>Return value</h3><div class="value"> according to the given keywords.</div>
306
307         
308            <h3>Parameters</h3>
309       
310           
311            <h4 id="_readoldoparestart_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312              <span class="attr">in</span>
313             
314             
315              <span class="attr">required</span>
316             
317             
318             
319             
320            </h4>
321       
322          <div class="comments"> with the whole path if necessary</div>
323           
324            <h4 id="_readoldoparestart_param_jpiglo">jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
325              <span class="attr">in</span>
326             
327             
328              <span class="attr">required</span>
329             
330             
331             
332             
333            </h4>
334       
335          <div class="comments"></div>
336           
337            <h4 id="_readoldoparestart_param_jpjglo">jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
338              <span class="attr">in</span>
339             
340             
341              <span class="attr">required</span>
342             
343             
344             
345             
346            </h4>
347       
348          <div class="comments"></div>
349           
350            <h4 id="_readoldoparestart_param_jpk">jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
351              <span class="attr">in</span>
352             
353             
354              <span class="attr">required</span>
355             
356             
357             
358             
359            </h4>
360       
361          <div class="comments">
362       dimensions of the opa grid</div>
363           
364
365         
366
367         
368
369            <h3>Keywords</h3>
370           
371            <h4 id="_readoldoparestart_keyword_IBLOC">IBLOC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372             
373             
374             
375             
376             
377             
378             
379             
380            </h4>
381       
382            <div class="comments"> ibloc size, default: ibloc = 4096L</div>
383           
384            <h4 id="_readoldoparestart_keyword_JPBYT">JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
385             
386             
387             
388             
389             
390             
391             
392             
393            </h4>
394       
395            <div class="comments"> jpbyt size, defalut: jpbyt = 8L</div>
396           
397            <h4 id="_readoldoparestart_keyword_NUMREC">NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
398             
399             
400             
401             
402             
403             
404             
405             
406            </h4>
407       
408            <div class="comments"> number of records in the file. defalut: numrec = 19L*jpk</div>
409           
410            <h4 id="_readoldoparestart_keyword_ub">ub&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
411             
412             
413             
414             
415             
416             
417             
418             
419            </h4>
420       
421            <div class="comments"></div>
422           
423            <h4 id="_readoldoparestart_keyword_vb">vb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
424             
425             
426             
427             
428             
429             
430             
431             
432            </h4>
433       
434            <div class="comments"></div>
435           
436            <h4 id="_readoldoparestart_keyword_tb">tb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
437             
438             
439             
440             
441             
442             
443             
444             
445            </h4>
446       
447            <div class="comments"></div>
448           
449            <h4 id="_readoldoparestart_keyword_sb">sb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
450             
451             
452             
453             
454             
455             
456             
457             
458            </h4>
459       
460            <div class="comments"></div>
461           
462            <h4 id="_readoldoparestart_keyword_rotb">rotb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
463             
464             
465             
466             
467             
468             
469             
470             
471            </h4>
472       
473            <div class="comments"></div>
474           
475            <h4 id="_readoldoparestart_keyword_hdivb">hdivb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
476             
477             
478             
479             
480             
481             
482             
483             
484            </h4>
485       
486            <div class="comments"></div>
487           
488            <h4 id="_readoldoparestart_keyword_un">un&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
489             
490             
491             
492             
493             
494             
495             
496             
497            </h4>
498       
499            <div class="comments"></div>
500           
501            <h4 id="_readoldoparestart_keyword_vn">vn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
502             
503             
504             
505             
506             
507             
508             
509             
510            </h4>
511       
512            <div class="comments"></div>
513           
514            <h4 id="_readoldoparestart_keyword_tn">tn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
515             
516             
517             
518             
519             
520             
521             
522             
523            </h4>
524       
525            <div class="comments"></div>
526           
527            <h4 id="_readoldoparestart_keyword_sn">sn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
528             
529             
530             
531             
532             
533             
534             
535             
536            </h4>
537       
538            <div class="comments"></div>
539           
540            <h4 id="_readoldoparestart_keyword_rotn">rotn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
541             
542             
543             
544             
545             
546             
547             
548             
549            </h4>
550       
551            <div class="comments"></div>
552           
553            <h4 id="_readoldoparestart_keyword_hdivn">hdivn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
554             
555             
556             
557             
558             
559             
560             
561             
562            </h4>
563       
564            <div class="comments"></div>
565           
566            <h4 id="_readoldoparestart_keyword_gcx">gcx&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
567             
568             
569             
570             
571             
572             
573             
574             
575            </h4>
576       
577            <div class="comments"></div>
578           
579            <h4 id="_readoldoparestart_keyword_gcxb">gcxb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
580             
581             
582             
583             
584             
585             
586             
587             
588            </h4>
589       
590            <div class="comments"></div>
591           
592            <h4 id="_readoldoparestart_keyword_etab">etab&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
593             
594             
595             
596             
597             
598             
599             
600             
601            </h4>
602       
603            <div class="comments"></div>
604           
605            <h4 id="_readoldoparestart_keyword_etan">etan&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
606             
607             
608             
609             
610             
611             
612             
613             
614            </h4>
615       
616            <div class="comments"></div>
617           
618            <h4 id="_readoldoparestart_keyword_bsfb">bsfb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
619             
620             
621             
622             
623             
624             
625             
626             
627            </h4>
628       
629            <div class="comments"></div>
630           
631            <h4 id="_readoldoparestart_keyword_bsfn">bsfn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
632             
633             
634             
635             
636             
637             
638             
639             
640            </h4>
641       
642            <div class="comments"></div>
643           
644            <h4 id="_readoldoparestart_keyword_bsfd">bsfd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
645             
646             
647             
648             
649             
650             
651             
652             
653            </h4>
654       
655            <div class="comments"></div>
656           
657            <h4 id="_readoldoparestart_keyword_en">en&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
658             
659             
660             
661             
662             
663             
664             
665             
666            </h4>
667       
668            <div class="comments">
669       the variable we want to read.
670</div>
671           
672         
673
674         
675          <h3>Version history</h3>
676         
677         
678          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
679                      June 2002</div>
680         
681         
682          <h3>Known issues</h3>
683         
684         
685         
686          <h4>Restrictions</h4><div class="value"> bug for etab and etan written on the same record???
687</div>
688       
689         
690         
691         
692         
693         
694         
695         
696       
697         
698       
699        </div>
700       
701      </div>
702
703     
704
705      <div id="tagline">Produced by IDLdoc 2.0.</div>
706
707    </div>
708
709  </body>
710</html>
Note: See TracBrowser for help on using the repository browser.