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>write_oasis.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="write_oasis.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//write_oasis.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 documentation</td> |
---|
67 | </tr> |
---|
68 | </table> |
---|
69 | |
---|
70 | </div> |
---|
71 | |
---|
72 | <div id="secondary_navbar"> |
---|
73 | |
---|
74 | <a href="write_ncdf.html"><<prev file</a> | <a href="writebat.html">next file >></a> <a href="write_oasis.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a> summary: fields | routine 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">write_oasis.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> |
---|
90 | write an Oasis file (version < 2.5) |
---|
91 | </div> |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | <div id="routine_details"> |
---|
102 | |
---|
103 | |
---|
104 | <div class="routine_details" id="_write_oasis"> |
---|
105 | |
---|
106 | <h2><a class="top" href="#container">top</a>write_oasis </h2> |
---|
107 | |
---|
108 | <p class="header"> |
---|
109 | write_oasis<span class="result">, <a href="#_write_oasis_param_filename">filename</a>, <a href="#_write_oasis_param_varname">varname</a>, <a href="#_write_oasis_param_z2d">z2d</a></span>, <a href="#_write_oasis_keyword_I2">I2</a>=<span class="result">I2</span>, <a href="#_write_oasis_keyword_I4">I4</a>=<span class="result">I4</span>, <a href="#_write_oasis_keyword_I8">I8</a>=<span class="result">I8</span>, <a href="#_write_oasis_keyword_R4">R4</a>=<span class="result">R4</span>, <a href="#_write_oasis_keyword_APPEND">APPEND</a>=<span class="result">APPEND</span>, <a href="#_write_oasis_keyword_RECSIZE">RECSIZE</a>=<span class="result">RECSIZE</span>, <a href="#_write_oasis_keyword_TEMPORARY">TEMPORARY</a>=<span class="result">TEMPORARY</span>, <a href="#_write_oasis_keyword_HEADER">HEADER</a>=<span class="result">HEADER</span>, <a href="#_write_oasis_keyword_ENDING">ENDING</a>=<span class="result">ENDING</span>, <a href="#_write_oasis_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span></p> |
---|
110 | |
---|
111 | <div class="comments"> |
---|
112 | </div> |
---|
113 | |
---|
114 | |
---|
115 | |
---|
116 | |
---|
117 | <h3>Parameters</h3> |
---|
118 | |
---|
119 | |
---|
120 | <h4 id="_write_oasis_param_filename">filename |
---|
121 | <span class="attr">in</span> |
---|
122 | |
---|
123 | |
---|
124 | <span class="attr">required</span> |
---|
125 | |
---|
126 | |
---|
127 | |
---|
128 | |
---|
129 | </h4> |
---|
130 | |
---|
131 | <div class="comments"> |
---|
132 | the filename |
---|
133 | </div> |
---|
134 | |
---|
135 | <h4 id="_write_oasis_param_varname">varname |
---|
136 | <span class="attr">in</span> |
---|
137 | |
---|
138 | |
---|
139 | <span class="attr">required</span> |
---|
140 | |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | </h4> |
---|
145 | |
---|
146 | <div class="comments"> |
---|
147 | the name of the variable to be written |
---|
148 | </div> |
---|
149 | |
---|
150 | <h4 id="_write_oasis_param_z2d">z2d |
---|
151 | <span class="attr">in</span> |
---|
152 | |
---|
153 | |
---|
154 | <span class="attr">required</span> |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | |
---|
159 | </h4> |
---|
160 | |
---|
161 | <div class="comments"> |
---|
162 | the variable (2D array) to be written |
---|
163 | </div> |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | <h3>Keywords</h3> |
---|
171 | |
---|
172 | <h4 id="_write_oasis_keyword_I2">I2 |
---|
173 | |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | |
---|
181 | </h4> |
---|
182 | |
---|
183 | <div class="comments"></div> |
---|
184 | |
---|
185 | <h4 id="_write_oasis_keyword_I4">I4 |
---|
186 | |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | </h4> |
---|
195 | |
---|
196 | <div class="comments"></div> |
---|
197 | |
---|
198 | <h4 id="_write_oasis_keyword_I8">I8 |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | |
---|
204 | |
---|
205 | |
---|
206 | |
---|
207 | </h4> |
---|
208 | |
---|
209 | <div class="comments"></div> |
---|
210 | |
---|
211 | <h4 id="_write_oasis_keyword_R4">R4 |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | </h4> |
---|
221 | |
---|
222 | <div class="comments"> |
---|
223 | to change the default format (R8) of the data to be written. |
---|
224 | </div> |
---|
225 | |
---|
226 | <h4 id="_write_oasis_keyword_APPEND">APPEND |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | |
---|
234 | |
---|
235 | </h4> |
---|
236 | |
---|
237 | <div class="comments"> |
---|
238 | to open the file with the file pointer at the end of the file, ready for |
---|
239 | data to be appended. |
---|
240 | </div> |
---|
241 | |
---|
242 | <h4 id="_write_oasis_keyword_RECSIZE">RECSIZE |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | </h4> |
---|
252 | |
---|
253 | <div class="comments"> |
---|
254 | define the size of the full data array to be written. Usefull when |
---|
255 | you want to save memory and write the data in several write_oasis |
---|
256 | instructions. see example |
---|
257 | </div> |
---|
258 | |
---|
259 | <h4 id="_write_oasis_keyword_TEMPORARY">TEMPORARY |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | |
---|
265 | |
---|
266 | |
---|
267 | |
---|
268 | </h4> |
---|
269 | |
---|
270 | <div class="comments"> |
---|
271 | activate undefine z2d when yo write it (to save memory) -> z2d will |
---|
272 | be lost once write_oasis is returning. |
---|
273 | </div> |
---|
274 | |
---|
275 | <h4 id="_write_oasis_keyword_HEADER">HEADER |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | </h4> |
---|
285 | |
---|
286 | <div class="comments"> |
---|
287 | activate to write the header ("character*8" contained in varname) |
---|
288 | before writting the data. Used when recsize is defined and /= 0, see example |
---|
289 | </div> |
---|
290 | |
---|
291 | <h4 id="_write_oasis_keyword_ENDING">ENDING |
---|
292 | |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | </h4> |
---|
301 | |
---|
302 | <div class="comments"> |
---|
303 | activate when you write the last part of the data. Used when recsize |
---|
304 | is defined and /= 0, see example |
---|
305 | </div> |
---|
306 | |
---|
307 | <h4 id="_write_oasis_keyword_POSITION">POSITION |
---|
308 | |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | </h4> |
---|
317 | |
---|
318 | <div class="comments"> |
---|
319 | specify the position (in byte) at which you want to write the |
---|
320 | data. Used when recsize is defined and /= 0, see example |
---|
321 | </div> |
---|
322 | |
---|
323 | |
---|
324 | |
---|
325 | <h3>Examples</h3><div class="preformat"> |
---|
326 | |
---|
327 | write_oasis, fa2of, 'WEIGHTS5', weig |
---|
328 | |
---|
329 | or in several call so save memory |
---|
330 | |
---|
331 | ysz = 100L |
---|
332 | recsz8 = 16L * jpio * jpjo * 8L |
---|
333 | FOR i = 0L, jpjo-1L, ysz DO BEGIN |
---|
334 | ii = (i+ysz-1L) < (jpjo-1L) |
---|
335 | position = (4L + 8L + 4L + 4L)*(i NE 0) + 16L * jpio * i * 8L |
---|
336 | weig = .... |
---|
337 | write_oasis, fa2ou, 'WEIGHTS3', temporary(weig), /temporary, append = i NE 0, header = i EQ 0 $ |
---|
338 | , ending = ii EQ jpjo-1, recsize = recsz8, position = position |
---|
339 | ENDFOR |
---|
340 | |
---|
341 | </div> |
---|
342 | <h3>Version history</h3> |
---|
343 | |
---|
344 | <h4>Version</h4><div class="preformat"> |
---|
345 | $Id: write_oasis.pro 332 2008-02-11 16:48:24Z smasson $ |
---|
346 | </div> |
---|
347 | <h4>History</h4><div class="preformat"> |
---|
348 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
349 | July 01, 2002</div> |
---|
350 | |
---|
351 | |
---|
352 | <h3>Known issues</h3> |
---|
353 | |
---|
354 | |
---|
355 | |
---|
356 | <h4>Restrictions</h4><div class="preformat"> |
---|
357 | varname is automatically written as a "character*8" |
---|
358 | by default z2d is written as an R8 array |
---|
359 | </div> |
---|
360 | |
---|
361 | |
---|
362 | |
---|
363 | |
---|
364 | |
---|
365 | |
---|
366 | |
---|
367 | |
---|
368 | |
---|
369 | <h3>Statistics</h3> |
---|
370 | <table class="statistics"> |
---|
371 | <tr><td>McCabe cyclic</td><td> 17</td></tr> |
---|
372 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
373 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
374 | </table> |
---|
375 | |
---|
376 | |
---|
377 | </div> |
---|
378 | |
---|
379 | </div> |
---|
380 | |
---|
381 | |
---|
382 | |
---|
383 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
384 | |
---|
385 | </div> |
---|
386 | |
---|
387 | </body> |
---|
388 | </html> |
---|