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

Timestamp:

09/06/06 12:46:29 (18 years ago)

Author:

pinsard

Message:

Main document available on top directory, Source links available in idldoc html output

Location:

trunk/SRC/Documentation/idldoc_html_output/Computation

Files:

• . (added)
• div.html (moved) (moved from trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/div.html) (14 diffs)

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

@@ -645 +645 @@
     <tr>
       
-      <td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
+      <td><a href="./../overview.html?format=raw" title="Overview of library">Overview</a></td>
       
 
@@ -653 +653 @@
 
       
-      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
-      
-
-      
-      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
-      
-
-      
-      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
+      <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
+      
+
+      
+      <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
+      
+
+      
+      <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td>
       
 
@@ -667 +667 @@
 
       
-      <td >Source</td>
-      
-
-      
-      <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
+      <td><a href="../../../Computation//div.pro?format=raw" title="Source code of a file">Source</a></td>
+      
+
+      
+      <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
       
 
@@ -684 +684 @@
 <div id="secondary_navbar">
 
-<a href="determ3.html?format=raw">&lt;&lt;prev file</a> | <a href="floatlevel2depth.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="div.html?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
+<a href="curl.html?format=raw">&lt;&lt;prev file</a> | <a href="grad.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="div.html?format=raw" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
 
 </div>
@@ -691 +691 @@
     <div id="container">
 
-      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/CALCULS/</a></h1>
+      <h1 class="directory"><a href="directory-overview.html?format=raw">Computation/</a></h1>
       <h2 class="pro_file">div.pro</h2>
 
@@ -700 +700 @@
 
       <div id="file_comments">
- calculation of the divergence of a 2d field
+ compute the horizontal divergence of a vectors field
 </div>
 
@@ -721 +721 @@
         
           <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>)</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>)</p>
         
           <div class="comments">
@@ -727 +727 @@
 
           <h3>Return value</h3><div class="preformat"> RES
- A 2d matrix
+ the divergence of the input data (with the same size)
 </div>
 
@@ -746 +746 @@
         
           <div class="comments"> 
- Matrix representing coordinates of a field of vectors
+ Matrix representing the zonal coordinates (U point) of a field of vectors
+ A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
+ a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
+ note that the dimension of the arry must suit the domain dimension.
 </div>
             
@@ -761 +764 @@
         
           <div class="comments"> 
- Matrix representing coordinates of a field of vectors
+ Matrix representing the meridional coordinates (V point) of a field of vectors
+ A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
+ a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
+ note that the dimension of the arry must suit the domain dimension.
 </div>
             
@@ -769 +775 @@
           
 
-          
+            <h3>Keywords</h3>
+            
+            <h4 id="_div_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              
+              
+              
+              
+              
+              <span class="attr">type:</span> <span class="value">scalar string</span>
+              
+              
+            </h4>
+        
+            <div class="comments">
+ Use if you want to call moyenne or grossemoyenne after the div computation
+ (stupid ?) with a mean done in the DIREC direction
+</div>
+            
+          
+
+          <h3>Examples</h3><div class="preformat">
+ IDL> @tst_initorca2
+ IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj))
+</div>
           <h3>Version history</h3>
           
           <h4>Version</h4><div class="preformat">
- $Id: div.pro 157 2006-08-21 09:01:50Z navarro $
+ $Id: div.pro 167 2006-09-05 12:24:07Z smasson $
 </div>
           <h4>History</h4><div class="preformat">
- Guillaume Roullet (grlod@ipsl.jussieu.fr)
-                      Creation : printemps 1998
-                      Sebastien Masson (smasson@lodyc.jussieu.fr)
-                      adaptation to work with a reduce domain
-                      12/1/2000;
+ Guillaume Roullet (grlod@ipsl.jussieu.fr): creation; spring 1998
+ Sebastien Masson (smasson@lodyc.jussieu.fr)
+ adaptation to work with a reduce domain; 12/1/2000
 </div>
           
@@ -787 +814 @@
           
           
-          
+          <h4>Todo items</h4><div class="preformat"> 
+ code the 4d case</div>
           <h4>Restrictions</h4><div class="preformat">
- U and V matrices can be 2 or 4d.
- Beware, to discern different configuration of U and V (xy, xyz, xyt, xyzt), 
- we look at the variable of the common 
-        -time which contain the calendar in IDL julian days to which U and 
- V refered to, in the same way as the variable 
-        -jpt which is the number of time's step to consider in time.
- U and V arrays are cut in the same geographic domain. Because of the gap of 
- T, U, V and F grids, it is possible that these two arrays has not the same 
- size and refered to different indexes. In this case, arrays are re-cut on 
- common indexes and the domain is redefined to match with these common 
- indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro
-
-
- Points on the drawing edge are at !values.f_nan 
-
+
+ - Works only for Arakawa C-grid. 
+ - UU must be on U grid, VV must be on V grid
+ - 4d case is not coded yet
+ - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
+ - U and V arrays are cut in the same geographic domain. Because of the shift between 
+   T, U, V and F grids, it is possible that these two arrays do not have the same 
+   size and refer to different indexes. In this case, arrays are re-cut on 
+   common indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro
+ - When computing the divergence, we update, vargrid, varname, varunits and the
+   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt).
+ - points that cannot be computed (domain bondaries, coastline) are set to NaN
 </div>
         
@@ -810 +835 @@
           
           <h4>Uses routines</h4><div class="preformat">
- common.pro
+ cm_4cal, cm_4data, cm_4mmesh 
 </div>
           
@@ -818 +843 @@
           <h3>Statistics</h3>
           <table class="statistics">
-            <tr><td>McCabe cyclic</td><td>          54</td></tr>
-            <tr><td>McCabe essential</td><td>           5</td></tr>
+            <tr><td>McCabe cyclic</td><td>          49</td></tr>
+            <tr><td>McCabe essential</td><td>           1</td></tr>
             <tr><td>McCabe modular design</td><td>           1</td></tr>
           </table>