Changeset 234 for trunk/SRC/Documentation/idldoc_assistant_output/Computation

Timestamp:

03/21/07 10:14:37 (17 years ago)

Author:

pinsard

Message:

new idldoc html and assistant outputs

Location:

trunk/SRC/Documentation/idldoc_assistant_output/Computation

Files:

• curl.html (modified) (6 diffs)
• div.html (modified) (5 diffs)
• grad.html (modified) (5 diffs)

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

@@ -72 +72 @@
       <h2>curl  <font size="-1" color="#006633">
  Calculation
- </font></h2>
+</font></h2>
 
       <p><font face="Courier"><i>result = </i>curl(<i><a href="#_curl_keyword_uu">uu</a>, <a href="#_curl_keyword_vv">vv</a></i>, <a href="#_curl_keyword_DIREC">DIREC</a>=<i>scalar string</i>)</font></p>
@@ -103 +103 @@
  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.
+ note that the dimension of the array must suit the domain dimension.
 
     
@@ -119 +119 @@
     </h4>
 
-     
+    
  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.
+ note that the dimension of the array must suit the domain dimension.
 
     
@@ -151 +151 @@
     
 
-    <h3>Examples</h3>
+    <h3>Examples</h3><pre>
  IDL> @tst_initorca2
  IDL> plt, curl(dist(jpi,jpj), dist(jpi,jpj))
 
-    <h3>Version history</h3>
+    </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: curl.pro 168 2006-09-06 10:46:29Z pinsard $
-
-    <h4>History</h4> 
+ $Id: curl.pro 231 2007-03-19 17:15:51Z pinsard $
+
+    <h4>History</h4>
  Guillaume Roullet (grlod@ipsl.jussieu.fr)
  Sebastien Masson (smasson@lodyc.jussieu.fr)
  adaptation to work with a reduce domain
  21/5/1999: missing values at !values.f_nan
- 
+
     
 
@@ -171 +171 @@
     
     
-    <h4>Todo items</h4> 
+    <h4>Todo items</h4>
  code the 4d case
     <h4>Restrictions</h4>
 
- - Works only for Arakawa C-grid. 
+ - 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
+ - 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
+ <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>
  - When computing the divergence, we update, vargrid, varname, varunits and the
    grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf).
- - points that cannot be computed (domain bondaries, coastline) are set to NaN
+ - points that cannot be computed (domain boundaries, coastline) are set to NaN
 
 
@@ -192 +193 @@
     
     <h4>Uses routines</h4>
- cm_4cal, cm_4data, cm_4mmesh 
+ cm_4cal, cm_4data, cm_4mmesh
 
     

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

@@ -99 +99 @@
     </h4>
 
-     
+    
  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.
+ note that the dimension of the array must suit the domain dimension.
 
     
@@ -119 +119 @@
     </h4>
 
-     
+    
  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.
+ note that the dimension of the array must suit the domain dimension.
 
     
@@ -151 +151 @@
     
 
-    <h3>Examples</h3>
+    <h3>Examples</h3><pre>
  IDL> @tst_initorca2
  IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj))
 
-    <h3>Version history</h3>
+    </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: div.pro 168 2006-09-06 10:46:29Z pinsard $
+ $Id: div.pro 231 2007-03-19 17:15:51Z pinsard $
 
     <h4>History</h4>
@@ -170 +170 @@
     
     
-    <h4>Todo items</h4> 
+    <h4>Todo items</h4>
  code the 4d case
     <h4>Restrictions</h4>
 
- - Works only for Arakawa C-grid. 
+ - 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
+ - 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 
+ <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>
  - 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
+ - points that cannot be computed (domain boundaries, coastline) are set to NaN
 
 
@@ -191 +192 @@
     
     <h4>Uses routines</h4>
- cm_4cal, cm_4data, cm_4mmesh 
+ cm_4cal, cm_4data, cm_4mmesh
 
     

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

@@ -78 +78 @@
     
 
+
     <h3>Return value</h3> RES {type=2D, 3D or 4D array}
  the gradient of the input data (with the same size)
@@ -102 +103 @@
  3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp
  and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
- note that the dimension of the arry must suit the domain dimension.
+ note that the dimension of the array must suit the domain dimension.
 
     
@@ -126 +127 @@
     
 
-    <h3>Examples</h3>
+    <h3>Examples</h3><pre>
  IDL> @tst_initorca2
  IDL> plt, grad({arr:gphit,g:'T'}, 'x')
  IDL> plt, grad({arr:gphit,g:'T'}, 'y')
 
-    <h3>Version history</h3>
+    </pre><h3>Version history</h3>
     
     <h4>Version</h4>
- $Id: grad.pro 168 2006-09-06 10:46:29Z pinsard $
+ $Id: grad.pro 232 2007-03-20 16:59:36Z pinsard $
 
     <h4>History</h4>
@@ -146 +147 @@
     
     <h4>Restrictions</h4>
- - Works only for Arakawa C-grid. 
+ - Works only for Arakawa C-grid.
  - When computing the gradient, the result is not on the same grid point
    than the input data. In consequence, we update, vargrid and the grid position
    parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf],
    ny[tuvf], firstz[tw], lastz[tw], nz[tw]).
- - points that cannot be computed (domain bondaries, coastline) are set to NaN
+ - points that cannot be computed (domain boundaries, coastline) are set to NaN
  - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
 
@@ -159 +160 @@
     
     <h4>Uses routines</h4>
- cm_4cal, cm_4data, cm_4mmesh 
+ cm_4cal, cm_4data, cm_4mmesh