source: trunk/SRC/Documentation/idldoc_html_output/ReadWrite/readoldopadistcoast.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: 7.7 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?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="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?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">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</div>
94
95     
96
97     
98
99     
100
101     
102      <div id="routine_summary">               
103        <h2>Routine summary</h2>
104       
105        <dl>
106         
107          <dt><p><a href="#_read3fromopa"><span class="result">result = </span>read3fromopa(<span class="result">unit, params, num</span>)</a></p><dt>
108          <dd></dd>     
109         
110          <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>
111          <dd></dd>     
112               
113        </dl>
114      </div>
115     
116
117      <div id="routine_details">
118       
119
120        <div class="routine_details" id="_read3fromopa">
121
122          <h2><a class="top" href="#container">top</a>read3fromopa <span class="categories"> for OPA before NetCDF
123
124</span></h2>
125       
126          <p class="header">
127            <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>
128       
129          <div class="comments"></div>
130
131          <h3>Return value</h3><div class="value">  a structure that contains two elements: tdistcoast (the
132 distance for the t-points) and fdiscoast (the distance for the
133 f-points).
134</div>
135
136         
137            <h3>Parameters</h3>
138       
139           
140            <h4 id="_read3fromopa_param_unit">unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141             
142             
143             
144             
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments"></div>
152           
153            <h4 id="_read3fromopa_param_params">params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154             
155             
156             
157             
158             
159             
160             
161             
162            </h4>
163       
164          <div class="comments"></div>
165           
166            <h4 id="_read3fromopa_param_num">num&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
180         
181
182         
183
184         
185          <h3>Version history</h3>
186         
187         
188          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
189                      June, 2002</div>
190         
191         
192         
193         
194         
195         
196         
197       
198         
199         
200         
201         
202         
203         
204         
205       
206         
207       
208        </div>
209       
210
211        <div class="routine_details" id="_readoldopadistcoast">
212
213          <h2><a class="top" href="#container">top</a>readoldopadistcoast </h2>
214       
215          <p class="header">
216            <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>
217       
218          <div class="comments"></div>
219
220         
221
222         
223            <h3>Parameters</h3>
224       
225           
226            <h4 id="_readoldopadistcoast_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
227              <span class="attr">in</span>
228             
229             
230              <span class="attr">required</span>
231             
232             
233             
234             
235            </h4>
236       
237          <div class="comments"> filename (with the whole path if necessary)</div>
238           
239            <h4 id="_readoldopadistcoast_param_jpiglo">jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
240              <span class="attr">in</span>
241             
242             
243              <span class="attr">required</span>
244             
245             
246             
247             
248            </h4>
249       
250          <div class="comments"></div>
251           
252            <h4 id="_readoldopadistcoast_param_jpjglo">jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253              <span class="attr">in</span>
254             
255             
256              <span class="attr">required</span>
257             
258             
259             
260             
261            </h4>
262       
263          <div class="comments"></div>
264           
265            <h4 id="_readoldopadistcoast_param_jpk">jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266              <span class="attr">in</span>
267             
268             
269              <span class="attr">required</span>
270             
271             
272             
273             
274            </h4>
275       
276          <div class="comments">
277      dimensions of the opa grid</div>
278           
279
280         
281
282         
283
284            <h3>Keywords</h3>
285           
286            <h4 id="_readoldopadistcoast_keyword_IBLOC">IBLOC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
287             
288             
289             
290             
291             
292             
293             
294             
295            </h4>
296       
297            <div class="comments"> ibloc size, default: ibloc = 4096L</div>
298           
299            <h4 id="_readoldopadistcoast_keyword_JPBYT">JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
300             
301             
302             
303             
304             
305             
306             
307             
308            </h4>
309       
310            <div class="comments"> jpbyt size, default: jpbyt = 8L</div>
311           
312            <h4 id="_readoldopadistcoast_keyword_NUMREC">NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
313             
314             
315             
316             
317             
318             
319             
320             
321            </h4>
322       
323            <div class="comments"> number of records in the file. default: numrec = 19L*jpk</div>
324           
325         
326
327         
328          <h3>Version history</h3>
329         
330         
331          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
332                      June, 2002</div>
333         
334         
335         
336         
337         
338         
339         
340       
341         
342         
343         
344         
345         
346         
347         
348       
349         
350       
351        </div>
352       
353      </div>
354
355     
356
357      <div id="tagline">Produced by IDLdoc 2.0.</div>
358
359    </div>
360
361  </body>
362</html>
Note: See TracBrowser for help on using the repository browser.