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

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation

File size: 8.5 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>readoldopadistcoast.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="readoldopadistcoast.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//readoldopadistcoast.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="readbat.html">&lt;&lt;prev file</a> | <a href="readoldoparestart.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="readoldopadistcoast.html" target="_TOP">view single page</a> | <a href="./../index.html" 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">ReadWrite/</a></h1>
82      <h2 class="pro_file">readoldopadistcoast.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 read the old binary direct access file that contains the
91 distance to the coast in OPA.
92 based on the OPA subroutines dtacof and parctl
93
94
95</div>
96
97     
98
99     
100
101     
102
103     
104      <div id="routine_summary">               
105        <h2>Routine summary</h2>
106       
107        <dl>
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="#_readoldopadistcoast"><span class="result">result = </span>readoldopadistcoast(<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>)</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="_read3fromopa">
123
124          <h2><a class="top" href="#container">top</a>read3fromopa <span class="categories">
125 For OPA
126</span></h2>
127       
128          <p class="header">
129            <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>
130       
131          <div class="comments">
132</div>
133
134          <h3>Return value</h3><div class="preformat">
135 a structure that contains two elements: tdistcoast (the
136 distance for the t-points) and fdiscoast (the distance for the
137 f-points).
138</div>
139
140         
141            <h3>Parameters</h3>
142       
143           
144            <h4 id="_read3fromopa_param_unit">unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145             
146             
147             
148             
149             
150             
151             
152             
153            </h4>
154       
155          <div class="comments">
156</div>
157           
158            <h4 id="_read3fromopa_param_params">params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
159             
160             
161             
162             
163             
164             
165             
166             
167            </h4>
168       
169          <div class="comments">
170</div>
171           
172            <h4 id="_read3fromopa_param_num">num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173             
174             
175             
176             
177             
178             
179             
180             
181            </h4>
182       
183          <div class="comments">
184</div>
185           
186
187         
188
189         
190
191         
192          <h3>Version history</h3>
193         
194          <h4>Version</h4><div class="preformat">
195 $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $
196</div>
197          <h4>History</h4><div class="preformat">
198 Sebastien Masson (smasson@lodyc.jussieu.fr)
199                      June, 2002</div>
200         
201         
202         
203         
204         
205         
206         
207       
208         
209         
210         
211         
212         
213         
214         
215       
216          <h3>Statistics</h3>
217          <table class="statistics">
218            <tr><td>McCabe cyclic</td><td>           1</td></tr>
219            <tr><td>McCabe essential</td><td>           1</td></tr>
220            <tr><td>McCabe modular design</td><td>           1</td></tr>
221          </table>
222         
223       
224        </div>
225       
226
227        <div class="routine_details" id="_readoldopadistcoast">
228
229          <h2><a class="top" href="#container">top</a>readoldopadistcoast <span class="categories">
230 For OPA
231</span></h2>
232       
233          <p class="header">
234            <span class="result">result = </span>readoldopadistcoast(<span class="result"><a href="#_readoldopadistcoast_param_filename">filename</a>, <a href="#_readoldopadistcoast_param_jpiglo">jpiglo</a>, <a href="#_readoldopadistcoast_param_jpjglo">jpjglo</a>, <a href="#_readoldopadistcoast_param_jpk">jpk</a></span>, <a href="#_readoldopadistcoast_keyword_IBLOC">IBLOC</a>=<span class="result">IBLOC</span>, <a href="#_readoldopadistcoast_keyword_JPBYT">JPBYT</a>=<span class="result">JPBYT</span>, <a href="#_readoldopadistcoast_keyword_NUMREC">NUMREC</a>=<span class="result">NUMREC</span>)</p>
235       
236          <div class="comments">
237</div>
238
239         
240
241         
242            <h3>Parameters</h3>
243       
244           
245            <h4 id="_readoldopadistcoast_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246              <span class="attr">in</span>
247             
248             
249              <span class="attr">required</span>
250             
251             
252             
253             
254            </h4>
255       
256          <div class="comments">
257 Filename (with the whole path if necessary)
258</div>
259           
260            <h4 id="_readoldopadistcoast_param_jpiglo">jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
261              <span class="attr">in</span>
262             
263             
264              <span class="attr">required</span>
265             
266             
267             
268             
269            </h4>
270       
271          <div class="comments">
272</div>
273           
274            <h4 id="_readoldopadistcoast_param_jpjglo">jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275              <span class="attr">in</span>
276             
277             
278              <span class="attr">required</span>
279             
280             
281             
282             
283            </h4>
284       
285          <div class="comments">
286</div>
287           
288            <h4 id="_readoldopadistcoast_param_jpk">jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
289              <span class="attr">in</span>
290             
291             
292              <span class="attr">required</span>
293             
294             
295             
296             
297            </h4>
298       
299          <div class="comments">
300 Dimensions of the opa grid
301</div>
302           
303
304         
305
306         
307
308            <h3>Keywords</h3>
309           
310            <h4 id="_readoldopadistcoast_keyword_IBLOC">IBLOC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
311             
312             
313             
314             
315             
316             
317              <span class="attr">default:</span> <span class="value">4096L</span>
318             
319            </h4>
320       
321            <div class="comments">
322 Ibloc size
323</div>
324           
325            <h4 id="_readoldopadistcoast_keyword_JPBYT">JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
326             
327             
328             
329             
330             
331             
332              <span class="attr">default:</span> <span class="value">8L</span>
333             
334            </h4>
335       
336            <div class="comments">
337 Jpbyt size
338</div>
339           
340            <h4 id="_readoldopadistcoast_keyword_NUMREC">NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
341             
342             
343             
344             
345             
346             
347              <span class="attr">default:</span> <span class="value">19L*jpk</span>
348             
349            </h4>
350       
351            <div class="comments">
352 Number of records in the file.
353</div>
354           
355         
356
357         
358          <h3>Version history</h3>
359         
360          <h4>Version</h4><div class="preformat">
361 $Id: readoldopadistcoast.pro 327 2007-12-13 16:22:35Z pinsard $
362</div>
363          <h4>History</h4><div class="preformat">
364 Sebastien Masson (smasson@lodyc.jussieu.fr)
365                      June, 2002
366</div>
367         
368         
369         
370         
371         
372         
373         
374       
375         
376         
377         
378         
379         
380         
381         
382       
383          <h3>Statistics</h3>
384          <table class="statistics">
385            <tr><td>McCabe cyclic</td><td>           9</td></tr>
386            <tr><td>McCabe essential</td><td>           1</td></tr>
387            <tr><td>McCabe modular design</td><td>           1</td></tr>
388          </table>
389         
390       
391        </div>
392       
393      </div>
394
395     
396
397      <div id="tagline">Produced by IDLdoc 2.0.</div>
398
399    </div>
400
401  </body>
402</html>
Note: See TracBrowser for help on using the repository browser.