Ignore:
Timestamp:
03/21/07 10:14:37 (17 years ago)
Author:
pinsard
Message:

new idldoc html and assistant outputs

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

Legend:

Unmodified
Added
Removed

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

    r200 r234  
    106106          <h2><a class="top" href="#container">top</a>curl <span class="categories"> 
    107107 Calculation 
    108  </span></h2> 
     108</span></h2> 
    109109         
    110110          <p class="header"> 
    … …  
    137137 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing 
    138138 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    139  note that the dimension of the arry must suit the domain dimension. 
     139 note that the dimension of the array must suit the domain dimension. 
    140140</div> 
    141141             
    … …  
    151151            </h4> 
    152152         
    153           <div class="comments">  
     153          <div class="comments"> 
    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 
    156156 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    157  note that the dimension of the arry must suit the domain dimension. 
     157 note that the dimension of the array must suit the domain dimension. 
    158158</div> 
    159159             
    … …  
    190190           
    191191          <h4>Version</h4><div class="preformat"> 
    192  $Id: curl.pro 168 2006-09-06 10:46:29Z pinsard $ 
    193 </div> 
    194           <h4>History</h4><div class="preformat">  
     192 $Id: curl.pro 231 2007-03-19 17:15:51Z pinsard $ 
     193</div> 
     194          <h4>History</h4><div class="preformat"> 
    195195 Guillaume Roullet (grlod@ipsl.jussieu.fr) 
    196196 Sebastien Masson (smasson@lodyc.jussieu.fr) 
    197197 adaptation to work with a reduce domain 
    198198 21/5/1999: missing values at !values.f_nan 
    199  </div> 
     199</div> 
    200200           
    201201           
    … …  
    203203           
    204204           
    205           <h4>Todo items</h4><div class="preformat">  
     205          <h4>Todo items</h4><div class="preformat"> 
    206206 code the 4d case</div> 
    207207          <h4>Restrictions</h4><div class="preformat"> 
    208208 
    209  - Works only for Arakawa C-grid.  
     209 - Works only for Arakawa C-grid. 
    210210 - UU must be on U grid, VV must be on V grid 
    211211 - 4d case is not coded yet 
    212212 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    213  - U and V arrays are cut in the same geographic domain. Because of the shift between  
    214    T, U, V and F grids, it is possible that these two arrays do not have the same  
    215    size and refer to different indexes. In this case, arrays are re-cut on  
    216    common indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro 
     213 - U and V arrays are cut in the same geographic domain. Because of the shift between 
     214   T, U, V and F grids, it is possible that these two arrays do not have the same 
     215   size and refer to different indexes. In this case, arrays are re-cut on 
     216   common indexes. To avoid these re-cuts, use the keyword /memeindice in 
     217 <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a> 
    217218 - When computing the divergence, we update, vargrid, varname, varunits and the 
    218219   grid position parameters (firstxf, lastxf, nxf, firstyf, lastyf, nyf). 
    219  - points that cannot be computed (domain bondaries, coastline) are set to NaN 
     220 - points that cannot be computed (domain boundaries, coastline) are set to NaN 
    220221</div> 
    221222         
    … …  
    224225           
    225226          <h4>Uses routines</h4><div class="preformat"> 
    226  cm_4cal, cm_4data, cm_4mmesh  
     227 cm_4cal, cm_4data, cm_4mmesh 
    227228</div> 
    228229           

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

    r200 r234  
    133133            </h4> 
    134134         
    135           <div class="comments">  
     135          <div class="comments"> 
    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 
    138138 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    139  note that the dimension of the arry must suit the domain dimension. 
     139 note that the dimension of the array must suit the domain dimension. 
    140140</div> 
    141141             
    … …  
    151151            </h4> 
    152152         
    153           <div class="comments">  
     153          <div class="comments"> 
    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 
    156156 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet). 
    157  note that the dimension of the arry must suit the domain dimension. 
     157 note that the dimension of the array must suit the domain dimension. 
    158158</div> 
    159159             
    … …  
    190190           
    191191          <h4>Version</h4><div class="preformat"> 
    192  $Id: div.pro 168 2006-09-06 10:46:29Z pinsard $ 
     192 $Id: div.pro 231 2007-03-19 17:15:51Z pinsard $ 
    193193</div> 
    194194          <h4>History</h4><div class="preformat"> 
    … …  
    202202           
    203203           
    204           <h4>Todo items</h4><div class="preformat">  
     204          <h4>Todo items</h4><div class="preformat"> 
    205205 code the 4d case</div> 
    206206          <h4>Restrictions</h4><div class="preformat"> 
    207207 
    208  - Works only for Arakawa C-grid.  
     208 - Works only for Arakawa C-grid. 
    209209 - UU must be on U grid, VV must be on V grid 
    210210 - 4d case is not coded yet 
    211211 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    212  - U and V arrays are cut in the same geographic domain. Because of the shift between  
    213    T, U, V and F grids, it is possible that these two arrays do not have the same  
    214    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 domdef.pro 
     212 - U and V arrays are cut in the same geographic domain. Because of the shift between 
     213   T, U, V and F grids, it is possible that these two arrays do not have the same 
     214   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> 
    216217 - When computing the divergence, we update, vargrid, varname, varunits and the 
    217218   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt). 
    218  - points that cannot be computed (domain bondaries, coastline) are set to NaN 
     219 - points that cannot be computed (domain boundaries, coastline) are set to NaN 
    219220</div> 
    220221         
    … …  
    223224           
    224225          <h4>Uses routines</h4><div class="preformat"> 
    225  cm_4cal, cm_4data, cm_4mmesh  
     226 cm_4cal, cm_4data, cm_4mmesh 
    226227</div> 
    227228           

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

    r200 r234  
    111111            <span class="result">result = </span>grad(<span class="result"><a href="#_grad_param_field">field</a>, <a href="#_grad_param_direc">direc</a></span>)</p> 
    112112         
    113           <div class="comments"></div> 
     113          <div class="comments"> 
     114</div> 
    114115 
    115116          <h3>Return value</h3><div class="preformat"> RES {type=2D, 3D or 4D array} 
    … …  
    136137 3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp 
    137138 and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
    138  note that the dimension of the arry must suit the domain dimension. 
     139 note that the dimension of the array must suit the domain dimension. 
    139140</div> 
    140141             
    … …  
    167168           
    168169          <h4>Version</h4><div class="preformat"> 
    169  $Id: grad.pro 168 2006-09-06 10:46:29Z pinsard $ 
     170 $Id: grad.pro 232 2007-03-20 16:59:36Z pinsard $ 
    170171</div> 
    171172          <h4>History</h4><div class="preformat"> 
    … …  
    179180           
    180181          <h4>Restrictions</h4><div class="preformat"> 
    181  - Works only for Arakawa C-grid.  
     182 - Works only for Arakawa C-grid. 
    182183 - When computing the gradient, the result is not on the same grid point 
    183184   than the input data. In consequence, we update, vargrid and the grid position 
    184185   parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf], 
    185186   ny[tuvf], firstz[tw], lastz[tw], nz[tw]). 
    186  - points that cannot be computed (domain bondaries, coastline) are set to NaN 
     187 - points that cannot be computed (domain boundaries, coastline) are set to NaN 
    187188 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases. 
    188189</div> 
    … …  
    192193           
    193194          <h4>Uses routines</h4><div class="preformat"> 
    194  cm_4cal, cm_4data, cm_4mmesh  
     195 cm_4cal, cm_4data, cm_4mmesh 
    195196</div> 
    196197           
Note: See TracChangeset for help on using the changeset viewer.