source: trunk/SRC/Documentation/idldoc_assistant_output/ReadWrite/readoldopadistcoast.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs

File size: 6.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>readoldopadistcoast.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="readbat.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="readoldoparestart.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>readoldopadistcoast.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 read the old binary direct access file that contains the
65 distance to the coast in OPA.
66 based on the OPA subroutines dtacof and parctl
67
68
69
70
71
72   
73    <h2>Routine summary</h2>
74
75    <dl>
76     
77      <dt><a href="#_read3fromopa"><i>result = </i>read3fromopa(<i>unit, params, num</i>)</a><dt>
78      <dd><font size="-1"> </font></dd>
79     
80      <dt><a href="#_readoldopadistcoast"><i>result = </i>readoldopadistcoast(<i>filename, jpiglo, jpjglo, jpk</i>, IBLOC=<i>IBLOC</i>, JPBYT=<i>JPBYT</i>, NUMREC=<i>NUMREC</i>)</a><dt>
81      <dd><font size="-1"></font></dd>
82     
83    </dl>
84
85    <p>&nbsp;</p>
86   
87
88     
89      <a name="#_read3fromopa"></a>
90
91      <h2>read3fromopa  <font size="-1" color="#006633"> 
92 For OPA
93</font></h2>
94
95      <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>
96
97   
98
99
100    <h3>Return value</h3> 
101 a structure that contains two elements: tdistcoast (the
102 distance for the t-points) and fdiscoast (the distance for the
103 f-points).
104
105
106   
107    <h3>Parameters</h3>
108   
109
110    <a name="#_read3fromopa_keyword_unit"></a>
111    <h4>unit&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117     
118     
119     
120    </h4>
121
122   
123
124
125   
126
127    <a name="#_read3fromopa_keyword_params"></a>
128    <h4>params&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130     
131     
132     
133     
134     
135     
136     
137    </h4>
138
139   
140 
141 
142   
143
144    <a name="#_read3fromopa_keyword_num"></a>
145    <h4>num&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152     
153     
154    </h4>
155
156   
157 
158
159   
160   
161
162   
163
164   
165    </pre><h3>Version history</h3>
166   
167    <h4>Version</h4> $Id: readoldopadistcoast.pro 232 2007-03-20 16:59:36Z pinsard $
168    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr)
169                      June, 2002
170   
171
172   
173   
174   
175   
176   
177
178   
179   
180   
181   
182   
183   
184   
185
186    <font size="-3"><p>&nbsp;</p></font>
187    <hr size="1" color="#CCCCCC"/>
188     
189      <a name="#_readoldopadistcoast"></a>
190
191      <h2>readoldopadistcoast  <font size="-1" color="#006633">
192 For OPA
193</font></h2>
194
195      <p><font face="Courier"><i>result = </i>readoldopadistcoast(<i><a href="#_readoldopadistcoast_keyword_filename">filename</a>, <a href="#_readoldopadistcoast_keyword_jpiglo">jpiglo</a>, <a href="#_readoldopadistcoast_keyword_jpjglo">jpjglo</a>, <a href="#_readoldopadistcoast_keyword_jpk">jpk</a></i>, <a href="#_readoldopadistcoast_keyword_IBLOC">IBLOC</a>=<i>IBLOC</i>, <a href="#_readoldopadistcoast_keyword_JPBYT">JPBYT</a>=<i>JPBYT</i>, <a href="#_readoldopadistcoast_keyword_NUMREC">NUMREC</a>=<i>NUMREC</i>)</font></p>
196
197   
198
199   
200
201   
202    <h3>Parameters</h3>
203   
204
205    <a name="#_readoldopadistcoast_keyword_filename"></a>
206    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207      <font size="-1" color="#006633">in</font>
208     
209     
210      <font size="-1" color="#006633">required</font>
211     
212     
213     
214     
215    </h4>
216
217   
218 Filename (with the whole path if necessary)
219
220   
221
222    <a name="#_readoldopadistcoast_keyword_jpiglo"></a>
223    <h4>jpiglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224      <font size="-1" color="#006633">in</font>
225     
226     
227      <font size="-1" color="#006633">required</font>
228     
229     
230     
231     
232    </h4>
233
234   
235
236
237   
238
239    <a name="#_readoldopadistcoast_keyword_jpjglo"></a>
240    <h4>jpjglo&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241      <font size="-1" color="#006633">in</font>
242     
243     
244      <font size="-1" color="#006633">required</font>
245     
246     
247     
248     
249    </h4>
250
251   
252
253
254   
255
256    <a name="#_readoldopadistcoast_keyword_jpk"></a>
257    <h4>jpk&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
258      <font size="-1" color="#006633">in</font>
259     
260     
261      <font size="-1" color="#006633">required</font>
262     
263     
264     
265     
266    </h4>
267
268   
269 Dimensions of the opa grid
270
271   
272   
273
274   
275    <h3>Keywords</h3>
276
277   
278    <a name="#_readoldopadistcoast_keyword_IBLOC"></a>
279    <h4>IBLOC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
280     
281     
282     
283     
284     
285     
286      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>4096L</i></font>
287     
288    </h4>
289
290   
291 Ibloc size
292 
293   
294    <a name="#_readoldopadistcoast_keyword_JPBYT"></a>
295    <h4>JPBYT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296     
297     
298     
299     
300     
301     
302      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>8L</i></font>
303     
304    </h4>
305
306   
307 Jpbyt size
308 
309   
310    <a name="#_readoldopadistcoast_keyword_NUMREC"></a>
311    <h4>NUMREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
312     
313     
314     
315     
316     
317     
318      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>19L*jpk</i></font>
319     
320    </h4>
321
322   
323 Number of records in the file.
324
325   
326   
327
328   
329    </pre><h3>Version history</h3>
330   
331    <h4>Version</h4>
332 $Id: readoldopadistcoast.pro 232 2007-03-20 16:59:36Z pinsard $
333    <h4>History</h4>
334 Sebastien Masson (smasson@lodyc.jussieu.fr)
335                      June, 2002
336
337   
338
339   
340   
341   
342   
343   
344
345   
346   
347   
348   
349   
350   
351   
352
353    <font size="-3"><p>&nbsp;</p></font>
354    <hr size="1" color="#CCCCCC"/>
355     
356
357   
358
359    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
360
361  </body>
362</html>
Note: See TracBrowser for help on using the repository browser.