Changeset 321 for trunk/SRC/Documentation/idldoc_html_output/Computation/div.html

Timestamp:

12/03/07 16:41:25 (17 years ago)

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_html_output/Computation/div.html (modified) (8 diffs)

trunk/SRC/Documentation/idldoc_html_output/Computation/div.html

@@ -88 +88 @@
 
       <div id="file_comments">
- compute the horizontal divergence of a vectors field
+ compute the horizontal divergence of a vectors field located on Arakawa C-grid.
 </div>
 
@@ -109 +109 @@
         
           <p class="header">
-            <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span>, <a href="#_div_keyword_DIREC">DIREC</a>=<span class="result">scalar string</span>)</p>
+            <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span>, <a href="#_div_keyword_DIREC">DIREC</a>=<span class="result">scalar string</span>, <a href="#_div_keyword_MILLION">MILLION</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_div_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span>)</p>
         
           <div class="comments">
@@ -115 +115 @@
 
           <h3>Return value</h3><div class="preformat">
- the divergence of the input data (with the same size)
+ the divergence of the input data (with the same size) located at T
+point (see restrictions).
 </div>
 
@@ -134 +135 @@
         
           <div class="comments">
- Matrix representing the zonal coordinates (U point) of a field of vectors
+ Matrix representing the zonal coordinates (at U point) of a field of vectors
  A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
  a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
@@ -152 +153 @@
         
           <div class="comments">
- Matrix representing the meridional coordinates (V point) of a field of vectors
+ Matrix representing the meridional coordinates (at V point) of a field of vectors
  A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
  a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
@@ -182 +183 @@
 </div>
             
+            <h4 id="_div_keyword_MILLION">MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
+              <span class="attr">default:</span> <span class="value">0</span>
+              
+            </h4>
+        
+            <div class="comments">
+ Activate to multiply returned array by 1.e6
+ </div>
+            
+            <h4 id="_div_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              
+              
+              
+            </h4>
+        
+            <div class="comments">
+ Used to declare that this routine accepts inherited keywords
+</div>
+            
           
 
@@ -191 +222 @@
           
           <h4>Version</h4><div class="preformat">
- $Id: div.pro 268 2007-08-24 14:07:01Z pinsard $
+ $Id: div.pro 314 2007-12-03 14:12:28Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
@@ -236 +267 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>          49</td></tr>
+            <tr><td>McCabe cyclic</td><td>          55</td></tr>
             <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>