Changeset 338 for trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_oasis.html

Timestamp:

03/20/08 23:06:02 (16 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_oasis.html (modified) (3 diffs)

trunk/SRC/Documentation/idldoc_html_output/ReadWrite/write_oasis.html

@@ -107 +107 @@
         
           <p class="header">
-            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></p>
+            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>
         
           <div class="comments">
@@ -240 +240 @@
 </div>
             
-          
-
-          
+            <h4 id="_write_oasis_keyword_RECSIZE">RECSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ define the size of the full data array to be written. Usefull when
+ you want to save memory and write the data in several write_oasis
+ instructions. see example
+</div>
+            
+            <h4 id="_write_oasis_keyword_TEMPORARY">TEMPORARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ activate undefine z2d when yo write it (to save memory) -> z2d will
+ be lost once write_oasis is returning.
+</div>
+            
+            <h4 id="_write_oasis_keyword_HEADER">HEADER&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ activate to write the header ("character*8" contained in varname)
+ before writting the data. Used when recsize is defined and /= 0, see example
+</div>
+            
+            <h4 id="_write_oasis_keyword_ENDING">ENDING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ activate when you write the last part of the data. Used when recsize
+ is defined and /= 0, see example
+</div>
+            
+            <h4 id="_write_oasis_keyword_POSITION">POSITION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ specify the position (in byte) at which you want to write the
+ data. Used when recsize is defined and /= 0, see example
+</div>
+            
+          
+
+          <h3>Examples</h3><div class="preformat">
+
+   write_oasis, fa2of, 'WEIGHTS5', weig
+
+ or in several call so save memory
+
+   ysz = 100L
+   recsz8 = 16L * jpio * jpjo * 8L
+   FOR i = 0L, jpjo-1L, ysz DO BEGIN 
+     ii = (i+ysz-1L) < (jpjo-1L)
+     position = (4L + 8L + 4L + 4L)*(i NE 0) + 16L * jpio * i * 8L
+     weig = .... 
+     write_oasis, fa2ou, 'WEIGHTS3', temporary(weig), /temporary, append = i NE 0, header = i EQ 0 $
+                  , ending = ii EQ jpjo-1, recsize = recsz8, position = position
+   ENDFOR
+
+</div>
           <h3>Version history</h3>
           
           <h4>Version</h4><div class="preformat">
- $Id: write_oasis.pro 238 2007-03-27 13:43:18Z pinsard $
+ $Id: write_oasis.pro 332 2008-02-11 16:48:24Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
@@ -272 +369 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>           7</td></tr>
+            <tr><td>McCabe cyclic</td><td>          17</td></tr>
             <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>