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

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

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation

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