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

Timestamp:

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

Author:

smasson

Message:

update documentation

File:

• trunk/SRC/Documentation/idldoc_assistant_output/Computation/div.html (modified) (7 diffs)

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

@@ -62 +62 @@
 
     
- compute the horizontal divergence of a vectors field
+ compute the horizontal divergence of a vectors field located on Arakawa C-grid.
 
 
@@ -74 +74 @@
 </font></h2>
 
-      <p><font face="Courier"><i>result = </i>div(<i><a href="#_div_keyword_uu">uu</a>, <a href="#_div_keyword_vv">vv</a></i>, <a href="#_div_keyword_DIREC">DIREC</a>=<i>scalar string</i>)</font></p>
+      <p><font face="Courier"><i>result = </i>div(<i><a href="#_div_keyword_uu">uu</a>, <a href="#_div_keyword_vv">vv</a></i>, <a href="#_div_keyword_DIREC">DIREC</a>=<i>scalar string</i>, <a href="#_div_keyword_MILLION">MILLION</a>=<i>scalar: 0 or 1</i>, <a href="#_div_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
 
     
@@ -80 +80 @@
 
     <h3>Return value</h3>
- 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).
 
 
@@ -100 +101 @@
 
     
- 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).
@@ -120 +121 @@
 
     
- 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).
@@ -150 +151 @@
 
     
+    <a name="#_div_keyword_MILLION"></a>
+    <h4>MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+      
+      
+      
+      
+      
+      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
+      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
+      
+    </h4>
+
+    
+ Activate to multiply returned array by 1.e6
+ 
+    
+    <a name="#_div_keyword__EXTRA"></a>
+    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+      
+      
+      
+      
+      
+      
+      
+      
+    </h4>
+
+    
+ Used to declare that this routine accepts inherited keywords
+
+    
     
 
@@ -159 +192 @@
     
     <h4>Version</h4>
- $Id: div.pro 268 2007-08-24 14:07:01Z pinsard $
+ $Id: div.pro 314 2007-12-03 14:12:28Z smasson $
 
     <h4>History</h4>