Ignore:
Timestamp:
04/06/07 10:35:17 (17 years ago)
Author:
pinsard
Message:

improvements/corrections of some *.pro headers + replace some message by some report

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Computation
Files:
3 edited

Legend:

Unmodified
Added
Removed

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

    r234 r242  
    7979 
    8080 
    81     <h3>Return value</h3> RES 
     81    <h3>Return value</h3> 
    8282 the vertical component of the curl of the input data (with the same size) 
    8383 
    … …  
    102102 Matrix representing the zonal coordinates (U point) of a field of vectors 
    103103 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    104  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    105  note that the dimension of the array must suit the domain dimension. 
     104 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
     105 Note that the dimension of the array must suit the domain dimension. 
    106106 
    107107     
    … …  
    122122 Matrix representing the meridional coordinates (V point) of a field of vectors 
    123123 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    124  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    125  note that the dimension of the array must suit the domain dimension. 
     124 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
     125 Note that the dimension of the array must suit the domain dimension. 
    126126 
    127127     
    … …  
    145145 
    146146     
    147  Use if you want to call moyenne or grossemoyenne after the div computation 
     147 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or 
     148 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation 
    148149 with a mean done in the DIREC direction 
    149150 
    … …  
    158159     
    159160    <h4>Version</h4> 
    160  $Id: curl.pro 231 2007-03-19 17:15:51Z pinsard $ 
     161 $Id: curl.pro 238 2007-03-27 13:43:18Z pinsard $ 
    161162 
    162163    <h4>History</h4> 
    … …  
    172173     
    173174    <h4>Todo items</h4> 
    174  code the 4d case 
     175 code the 4D case 
     176 
    175177    <h4>Restrictions</h4> 
    176178 
    177179 - Works only for Arakawa C-grid. 
    178180 - UU must be on U grid, VV must be on V grid 
    179  - 4d case is not coded yet 
     181 - 4D case is not coded yet 
    180182 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    181183 - U and V arrays are cut in the same geographic domain. Because of the shift between 
    … …  
    183185   size and refer to different indexes. In this case, arrays are re-cut on 
    184186   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
    185  <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a> 
     187 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    186188 - When computing the divergence, we update, vargrid, varname, varunits and the 
    187189   grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf). 
    … …  
    193195     
    194196    <h4>Uses routines</h4> 
    195  cm_4cal, cm_4data, cm_4mmesh 
     197 cm_4cal 
     198 cm_4data 
     199 cm_4mmesh 
    196200 
    197201     

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

    r234 r242  
    7979 
    8080 
    81     <h3>Return value</h3> RES 
     81    <h3>Return value</h3> 
    8282 the divergence of the input data (with the same size) 
    8383 
    … …  
    102102 Matrix representing the zonal coordinates (U point) of a field of vectors 
    103103 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    104  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
     104 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    105105 note that the dimension of the array must suit the domain dimension. 
    106106 
    … …  
    122122 Matrix representing the meridional coordinates (V point) of a field of vectors 
    123123 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    124  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
     124 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    125125 note that the dimension of the array must suit the domain dimension. 
    126126 
    … …  
    145145 
    146146     
    147  Use if you want to call moyenne or grossemoyenne after the div computation 
     147 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or 
     148 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation 
    148149 (stupid ?) with a mean done in the DIREC direction 
    149150 
    … …  
    158159     
    159160    <h4>Version</h4> 
    160  $Id: div.pro 231 2007-03-19 17:15:51Z pinsard $ 
     161 $Id: div.pro 238 2007-03-27 13:43:18Z pinsard $ 
    161162 
    162163    <h4>History</h4> 
    … …  
    171172     
    172173    <h4>Todo items</h4> 
    173  code the 4d case 
     174 code the 4D case 
     175 
    174176    <h4>Restrictions</h4> 
    175177 
    176178 - Works only for Arakawa C-grid. 
    177179 - UU must be on U grid, VV must be on V grid 
    178  - 4d case is not coded yet 
     180 - 4D case is not coded yet 
    179181 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    180182 - U and V arrays are cut in the same geographic domain. Because of the shift between 
    181183   T, U, V and F grids, it is possible that these two arrays do not have the same 
    182184   size and refer to different indexes. In this case, arrays are re-cut on 
    183    common indexes. To avoid these re-cuts, use the keyword /memeindice in  
    184  <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a> 
     185   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
     186 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    185187 - When computing the divergence, we update, vargrid, varname, varunits and the 
    186188   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt). 
    … …  
    192194     
    193195    <h4>Uses routines</h4> 
    194  cm_4cal, cm_4data, cm_4mmesh 
     196 cm_4cal 
     197 cm_4data 
     198 cm_4mmesh 
    195199 
    196200     

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

    r234 r242  
    7979 
    8080 
    81     <h3>Return value</h3> RES {type=2D, 3D or 4D array} 
    82  the gradient of the input data (with the same size) 
     81    <h3>Return value</h3> 
     82 the gradient of the input data with the same size 2D, 3D or 4D array 
    8383 
    8484 
    … …  
    100100 
    101101     
    102  The field for which we want to compute the gradient.  A 2D (xy), 
    103  3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp 
     102 The field for which we want to compute the gradient. A 2D (xy), 
     103 3D (xyz or yt) or 4D (xyzt) array or a structure readable by  
     104 <proidl>litchamp</proidl> 
    104105 and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
    105  note that the dimension of the array must suit the domain dimension. 
     106 Note that the dimension of the array must suit the domain dimension. 
    106107 
    107108     
    … …  
    135136     
    136137    <h4>Version</h4> 
    137  $Id: grad.pro 232 2007-03-20 16:59:36Z pinsard $ 
     138 $Id: grad.pro 238 2007-03-27 13:43:18Z pinsard $ 
    138139 
    139140    <h4>History</h4> 
    … …  
    160161     
    161162    <h4>Uses routines</h4> 
    162  cm_4cal, cm_4data, cm_4mmesh 
     163 cm_4cal 
     164 cm_4data 
     165 cm_4mmesh 
    163166 
    164167     
Note: See TracChangeset for help on using the changeset viewer.