Ignore:
Timestamp:
12/03/07 16:41:25 (17 years ago)
Author:
smasson
Message:

update documentation

Location:
trunk/SRC/Documentation/idldoc_assistant_output/Computation
Files:
1 added
4 edited

Legend:

Unmodified
Added
Removed

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

    r290 r321  
    6262 
    6363     
    64  Calculate the vertical component of the curl of a field of horizontal vectors 
     64 Calculate the vertical component of the curl of a vectors field 
     65 located on Arakawa C-grid. 
    6566 
    6667 
    … …  
    7475</font></h2> 
    7576 
    76       <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> 
     77      <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>, <a href="#_curl_keyword_MILLION">MILLION</a>=<i>scalar: 0 or 1</i>, <a href="#_curl_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7778 
    7879     
    … …  
    8081 
    8182    <h3>Return value</h3> 
    82  the vertical component of the curl of the input data (with the same size) 
     83 the vertical component of the curl of the input data (with the same 
     84 size) located at F point (see restrictions) 
    8385 
    8486 
    … …  
    100102 
    101103     
    102  Matrix representing the zonal coordinates (U point) of a field of vectors 
     104 Matrix representing the zonal coordinates (at U point) of a field of vectors 
    103105 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing 
    104106 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    … …  
    120122 
    121123     
    122  Matrix representing the meridional coordinates (V point) of a field of vectors 
     124 Matrix representing the meridional coordinates (at V point) of a field of vectors 
    123125 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing 
    124126 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    … …  
    150152 
    151153     
     154    <a name="#_curl_keyword_MILLION"></a> 
     155    <h4>MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     156       
     157       
     158       
     159       
     160       
     161      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     162      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     163       
     164    </h4> 
     165 
     166     
     167 Activate to multiply returned array by 1.e6 
     168  
     169     
     170    <a name="#_curl_keyword__EXTRA"></a> 
     171    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     172       
     173       
     174       
     175       
     176       
     177       
     178       
     179       
     180    </h4> 
     181 
     182     
     183 Used to declare that this routine accepts inherited keywords 
     184 
     185     
    152186     
    153187 
    154188    <h3>Examples</h3><pre> 
    155  IDL> @tst_initorca2 
    156  IDL> plt, curl(dist(jpi,jpj), dist(jpi,jpj)) 
    157  
    158189    </pre><h3>Version history</h3> 
    159190     
    160191    <h4>Version</h4> 
    161  $Id: curl.pro 268 2007-08-24 14:07:01Z pinsard $ 
     192 $Id: curl.pro 314 2007-12-03 14:12:28Z smasson $ 
    162193 
    163194    <h4>History</h4> 
    … …  
    197228 cm_4cal 
    198229 cm_4data 
    199  cm_4mmesh 
     230 cm_4mesh 
    200231 
    201232     

  • trunk/SRC/Documentation/idldoc_assistant_output/Computation/directory-overview.html

    r249 r321  
    2424        <li><a href="div.html" target="file_frame">div.pro</a></li> 
    2525        <li><a href="grad.html" target="file_frame">grad.pro</a></li> 
     26        <li><a href="norm.html" target="file_frame">norm.pro</a></li> 
    2627      </ul> 
    2728 
    28       <div id="tagline">3 files</div> 
     29      <div id="tagline">4 files</div> 
    2930       
    3031 

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

    r290 r321  
    6262 
    6363     
    64  compute the horizontal divergence of a vectors field 
     64 compute the horizontal divergence of a vectors field located on Arakawa C-grid. 
    6565 
    6666 
    … …  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier"><i>result = </i>div(<i><a href="#_div_keyword_uu">uu</a>, <a href="#_div_keyword_vv">vv</a></i>, <a href="#_div_keyword_DIREC">DIREC</a>=<i>scalar string</i>)</font></p> 
     76      <p><font face="Courier"><i>result = </i>div(<i><a href="#_div_keyword_uu">uu</a>, <a href="#_div_keyword_vv">vv</a></i>, <a href="#_div_keyword_DIREC">DIREC</a>=<i>scalar string</i>, <a href="#_div_keyword_MILLION">MILLION</a>=<i>scalar: 0 or 1</i>, <a href="#_div_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7777 
    7878     
    … …  
    8080 
    8181    <h3>Return value</h3> 
    82  the divergence of the input data (with the same size) 
     82 the divergence of the input data (with the same size) located at T 
     83point (see restrictions). 
    8384 
    8485 
    … …  
    100101 
    101102     
    102  Matrix representing the zonal coordinates (U point) of a field of vectors 
     103 Matrix representing the zonal coordinates (at U point) of a field of vectors 
    103104 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing 
    104105 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    … …  
    120121 
    121122     
    122  Matrix representing the meridional coordinates (V point) of a field of vectors 
     123 Matrix representing the meridional coordinates (at V point) of a field of vectors 
    123124 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing 
    124125 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet). 
    … …  
    150151 
    151152     
     153    <a name="#_div_keyword_MILLION"></a> 
     154    <h4>MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     155       
     156       
     157       
     158       
     159       
     160      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     161      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     162       
     163    </h4> 
     164 
     165     
     166 Activate to multiply returned array by 1.e6 
     167  
     168     
     169    <a name="#_div_keyword__EXTRA"></a> 
     170    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     171       
     172       
     173       
     174       
     175       
     176       
     177       
     178       
     179    </h4> 
     180 
     181     
     182 Used to declare that this routine accepts inherited keywords 
     183 
     184     
    152185     
    153186 
    … …  
    159192     
    160193    <h4>Version</h4> 
    161  $Id: div.pro 268 2007-08-24 14:07:01Z pinsard $ 
     194 $Id: div.pro 314 2007-12-03 14:12:28Z smasson $ 
    162195 
    163196    <h4>History</h4> 

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

    r290 r321  
    5050<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td> 
    5151    <td width="10%" align="right"> 
    52 <a href=""><img src="./../next.gif" border="0" alt="Next"></a></td> 
     52<a href="norm.html"><img src="./../next.gif" border="0" alt="Next"></a></td> 
    5353  </tr> 
    5454</table> 
    … …  
    6262 
    6363     
    64  compute the gradient of a variable 
     64 compute the gradient of a variable located on Arakawa C-grid. 
    6565 
    6666 
    … …  
    7474</font></h2> 
    7575 
    76       <p><font face="Courier"><i>result = </i>grad(<i><a href="#_grad_keyword_field">field</a>, <a href="#_grad_keyword_direc">direc</a></i>)</font></p> 
     76      <p><font face="Courier"><i>result = </i>grad(<i><a href="#_grad_keyword_field">field</a>, <a href="#_grad_keyword_direc">direc</a></i>, <a href="#_grad_keyword_MILLION">MILLION</a>=<i>scalar: 0 or 1</i>, <a href="#_grad_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p> 
    7777 
    7878     
    … …  
    8080 
    8181    <h3>Return value</h3> 
    82  the gradient of the input data with the same size 2D, 3D or 4D array 
     82 the gradient of the input data with the same size 2D, 3D or 4D 
     83 array, located on the appropriate grid (see restrictions) 
    8384 
    8485 
    … …  
    102103 The field for which we want to compute the gradient. A 2D (xy), 
    103104 3D (xyz or yt) or 4D (xyzt) array or a structure readable by  
    104  <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> 
    105  and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
     105 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array. 
    106106 Note that the dimension of the array must suit the domain dimension. 
    107107 
    … …  
    126126     
    127127 
     128     
     129    <h3>Keywords</h3> 
     130 
     131     
     132    <a name="#_grad_keyword_MILLION"></a> 
     133    <h4>MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     134       
     135       
     136       
     137       
     138       
     139      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font> 
     140      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font> 
     141       
     142    </h4> 
     143 
     144     
     145 Activate to multiply returned array by 1.e6 
     146  
     147     
     148    <a name="#_grad_keyword__EXTRA"></a> 
     149    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     150       
     151       
     152       
     153       
     154       
     155       
     156       
     157       
     158    </h4> 
     159 
     160     
     161 Used to declare that this routine accepts inherited keywords 
     162 
     163     
    128164     
    129165 
    … …  
    136172     
    137173    <h4>Version</h4> 
    138  $Id: grad.pro 260 2007-08-20 15:24:57Z pinsard $ 
     174 $Id: grad.pro 314 2007-12-03 14:12:28Z smasson $ 
    139175 
    140176    <h4>History</h4> 
    … …  
    163199 cm_4cal 
    164200 cm_4data 
    165  cm_4mmesh 
     201 cm_4mesh 
    166202 
    167203     
Note: See TracChangeset for help on using the changeset viewer.