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_html_output/Computation
Files:
3 edited

Legend:

Unmodified
Added
Removed

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

    r234 r242  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat"> RES 
     116          <h3>Return value</h3><div class="preformat"> 
    117117 the vertical component of the curl of the input data (with the same size) 
    118118</div> 
    … …  
    136136 Matrix representing the zonal coordinates (U point) of a field of vectors 
    137137 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    138  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    139  note that the dimension of the array must suit the domain dimension. 
     138 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
     139 Note that the dimension of the array must suit the domain dimension. 
    140140</div> 
    141141             
    … …  
    154154 Matrix representing the meridional coordinates (V point) of a field of vectors 
    155155 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    156  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    157  note that the dimension of the array must suit the domain dimension. 
     156 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
     157 Note that the dimension of the array must suit the domain dimension. 
    158158</div> 
    159159             
    … …  
    177177         
    178178            <div class="comments"> 
    179  Use if you want to call moyenne or grossemoyenne after the div computation 
     179 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or 
     180 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation 
    180181 with a mean done in the DIREC direction 
    181182</div> 
    … …  
    190191           
    191192          <h4>Version</h4><div class="preformat"> 
    192  $Id: curl.pro 231 2007-03-19 17:15:51Z pinsard $ 
     193 $Id: curl.pro 238 2007-03-27 13:43:18Z pinsard $ 
    193194</div> 
    194195          <h4>History</h4><div class="preformat"> 
    … …  
    204205           
    205206          <h4>Todo items</h4><div class="preformat"> 
    206  code the 4d case</div> 
     207 code the 4D case 
     208</div> 
    207209          <h4>Restrictions</h4><div class="preformat"> 
    208210 
    209211 - Works only for Arakawa C-grid. 
    210212 - UU must be on U grid, VV must be on V grid 
    211  - 4d case is not coded yet 
     213 - 4D case is not coded yet 
    212214 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    213215 - U and V arrays are cut in the same geographic domain. Because of the shift between 
    … …  
    215217   size and refer to different indexes. In this case, arrays are re-cut on 
    216218   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
    217  <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a> 
     219 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    218220 - When computing the divergence, we update, vargrid, varname, varunits and the 
    219221   grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf). 
    … …  
    225227           
    226228          <h4>Uses routines</h4><div class="preformat"> 
    227  cm_4cal, cm_4data, cm_4mmesh 
     229 cm_4cal 
     230 cm_4data 
     231 cm_4mmesh 
    228232</div> 
    229233           

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

    r234 r242  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat"> RES 
     116          <h3>Return value</h3><div class="preformat"> 
    117117 the divergence of the input data (with the same size) 
    118118</div> 
    … …  
    136136 Matrix representing the zonal coordinates (U point) of a field of vectors 
    137137 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    138  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
     138 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    139139 note that the dimension of the array must suit the domain dimension. 
    140140</div> 
    … …  
    154154 Matrix representing the meridional coordinates (V point) of a field of vectors 
    155155 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    156  a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
     156 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    157157 note that the dimension of the array must suit the domain dimension. 
    158158</div> 
    … …  
    177177         
    178178            <div class="comments"> 
    179  Use if you want to call moyenne or grossemoyenne after the div computation 
     179 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or 
     180 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation 
    180181 (stupid ?) with a mean done in the DIREC direction 
    181182</div> 
    … …  
    190191           
    191192          <h4>Version</h4><div class="preformat"> 
    192  $Id: div.pro 231 2007-03-19 17:15:51Z pinsard $ 
     193 $Id: div.pro 238 2007-03-27 13:43:18Z pinsard $ 
    193194</div> 
    194195          <h4>History</h4><div class="preformat"> 
    … …  
    203204           
    204205          <h4>Todo items</h4><div class="preformat"> 
    205  code the 4d case</div> 
     206 code the 4D case 
     207</div> 
    206208          <h4>Restrictions</h4><div class="preformat"> 
    207209 
    208210 - Works only for Arakawa C-grid. 
    209211 - UU must be on U grid, VV must be on V grid 
    210  - 4d case is not coded yet 
     212 - 4D case is not coded yet 
    211213 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    212214 - U and V arrays are cut in the same geographic domain. Because of the shift between 
    213215   T, U, V and F grids, it is possible that these two arrays do not have the same 
    214216   size and refer to different indexes. In this case, arrays are re-cut on 
    215    common indexes. To avoid these re-cuts, use the keyword /memeindice in  
    216  <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a> 
     217   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
     218 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    217219 - When computing the divergence, we update, vargrid, varname, varunits and the 
    218220   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt). 
    … …  
    224226           
    225227          <h4>Uses routines</h4><div class="preformat"> 
    226  cm_4cal, cm_4data, cm_4mmesh 
     228 cm_4cal 
     229 cm_4data 
     230 cm_4mmesh 
    227231</div> 
    228232           

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

    r234 r242  
    114114</div> 
    115115 
    116           <h3>Return value</h3><div class="preformat"> RES {type=2D, 3D or 4D array} 
    117  the gradient of the input data (with the same size) 
     116          <h3>Return value</h3><div class="preformat"> 
     117 the gradient of the input data with the same size 2D, 3D or 4D array 
    118118</div> 
    119119 
    … …  
    134134         
    135135          <div class="comments"> 
    136  The field for which we want to compute the gradient.  A 2D (xy), 
    137  3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp 
     136 The field for which we want to compute the gradient. A 2D (xy), 
     137 3D (xyz or yt) or 4D (xyzt) array or a structure readable by  
     138 <proidl>litchamp</proidl> 
    138139 and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
    139  note that the dimension of the array must suit the domain dimension. 
     140 Note that the dimension of the array must suit the domain dimension. 
    140141</div> 
    141142             
    … …  
    168169           
    169170          <h4>Version</h4><div class="preformat"> 
    170  $Id: grad.pro 232 2007-03-20 16:59:36Z pinsard $ 
     171 $Id: grad.pro 238 2007-03-27 13:43:18Z pinsard $ 
    171172</div> 
    172173          <h4>History</h4><div class="preformat"> 
    … …  
    193194           
    194195          <h4>Uses routines</h4><div class="preformat"> 
    195  cm_4cal, cm_4data, cm_4mmesh 
     196 cm_4cal 
     197 cm_4data 
     198 cm_4mmesh 
    196199</div> 
    197200           
Note: See TracChangeset for help on using the changeset viewer.