Ignore:
Timestamp:
07/23/09 11:18:49 (15 years ago)
Author:
smasson
Message:

update documentation

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

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Computation/curl.html

    r338 r402  
    7272<div id="secondary_navbar"> 
    7373 
    74 &lt;&lt; prev file | <a href="div.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="curl.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="bsf.html">&lt;&lt;prev file</a> | <a href="div.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="curl.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
     
    216216           
    217217 
    218           <h3>Examples</h3><div class="preformat"></div> 
     218          <h3>Examples</h3><div class="preformat"> 
     219</div> 
    219220          <h3>Version history</h3> 
    220221           
    221222          <h4>Version</h4><div class="preformat"> 
    222  $Id: curl.pro 327 2007-12-13 16:22:35Z pinsard $ 
     223 $Id: curl.pro 371 2008-08-07 09:32:02Z pinsard $ 
    223224</div> 
    224225          <h4>History</h4><div class="preformat"> 
     
    256257           
    257258          <h4>Uses routines</h4><div class="preformat"> 
    258  cm_4cal 
    259  cm_4data 
    260  cm_4mesh 
     259 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
     260 <a href="..//Commons/cm_4data.html">cm_4data</a> 
     261 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
    261262</div> 
    262263           
  • trunk/SRC/Documentation/idldoc_html_output/Computation/dir-files.html

    r321 r402  
    2121      <ul> 
    2222         
     23        <li><a href="bsf.html" target="file_frame">bsf.pro</a></li> 
    2324        <li><a href="curl.html" target="file_frame">curl.pro</a></li> 
    2425        <li><a href="div.html" target="file_frame">div.pro</a></li> 
    2526        <li><a href="grad.html" target="file_frame">grad.pro</a></li> 
     27        <li><a href="msf.html" target="file_frame">msf.pro</a></li> 
    2628        <li><a href="norm.html" target="file_frame">norm.pro</a></li> 
    2729      </ul> 
    2830 
    29       <div id="tagline">4 files</div> 
     31      <div id="tagline">6 files</div> 
    3032       
    3133 
  • trunk/SRC/Documentation/idldoc_html_output/Computation/directory-overview.html

    r321 r402  
    8989      <dl> 
    9090       
     91        <dt><a href="bsf.html">bsf.pro</a></dt> 
     92        <dd>  compute the barotropic (along the model grid) stream function in Sv using  the following equation: total(total(e2u*e3u*un),3), 2, /cumulative)/1.</dd> 
     93       
    9194        <dt><a href="curl.html">curl.pro</a></dt> 
    9295        <dd>  Calculate the vertical component of the curl of a vectors field  located on Arakawa C-grid.</dd> 
     
    97100        <dt><a href="grad.html">grad.pro</a></dt> 
    98101        <dd>  compute the gradient of a variable located on Arakawa C-grid.</dd> 
     102       
     103        <dt><a href="msf.html">msf.pro</a></dt> 
     104        <dd>  compute the meridional (along the model grid) stream function in Sv using  the following equation: total(total(e1v*e3v*vn),1), 2, /cumulative)/1.</dd> 
    99105       
    100106        <dt><a href="norm.html">norm.pro</a></dt> 
  • trunk/SRC/Documentation/idldoc_html_output/Computation/div.html

    r338 r402  
    216216 
    217217          <h3>Examples</h3><div class="preformat"> 
    218  IDL> @tst_initorca2 
    219  IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj)) 
     218 
     219   IDL> @tst_initorca2 
     220   IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj)) 
    220221</div> 
    221222          <h3>Version history</h3> 
    222223           
    223224          <h4>Version</h4><div class="preformat"> 
    224  $Id: div.pro 327 2007-12-13 16:22:35Z pinsard $ 
     225 $Id: div.pro 378 2008-08-12 12:35:46Z pinsard $ 
    225226</div> 
    226227          <h4>History</h4><div class="preformat"> 
     
    257258           
    258259          <h4>Uses routines</h4><div class="preformat"> 
    259  cm_4cal 
    260  cm_4data 
    261  cm_4mmesh 
     260 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
     261 <a href="..//Commons/cm_4data.html">cm_4data</a> 
     262 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
    262263</div> 
    263264           
  • trunk/SRC/Documentation/idldoc_html_output/Computation/grad.html

    r338 r402  
    7272<div id="secondary_navbar"> 
    7373 
    74 <a href="div.html">&lt;&lt;prev file</a> | <a href="norm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="grad.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="div.html">&lt;&lt;prev file</a> | <a href="msf.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="grad.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
     
    196196 
    197197          <h3>Examples</h3><div class="preformat"> 
    198  IDL> @tst_initorca2 
    199  IDL> plt, grad({arr:gphit,g:'T'}, 'x') 
    200  IDL> plt, grad({arr:gphit,g:'T'}, 'y') 
     198 
     199   IDL> @tst_initorca2 
     200   IDL> plt, grad({arr:gphit,g:'T'}, 'x') 
     201   IDL> plt, grad({arr:gphit,g:'T'}, 'y') 
    201202</div> 
    202203          <h3>Version history</h3> 
    203204           
    204205          <h4>Version</h4><div class="preformat"> 
    205  $Id: grad.pro 327 2007-12-13 16:22:35Z pinsard $ 
     206 $Id: grad.pro 371 2008-08-07 09:32:02Z pinsard $ 
    206207</div> 
    207208          <h4>History</h4><div class="preformat"> 
     
    228229           
    229230          <h4>Uses routines</h4><div class="preformat"> 
    230  cm_4cal 
    231  cm_4data 
    232  cm_4mesh 
     231 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
     232 <a href="..//Commons/cm_4data.html">cm_4data</a> 
     233 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
    233234</div> 
    234235           
  • trunk/SRC/Documentation/idldoc_html_output/Computation/norm.html

    r338 r402  
    7272<div id="secondary_navbar"> 
    7373 
    74 <a href="grad.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="norm.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
     74<a href="msf.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="norm.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a> 
    7575 
    7676</div> 
     
    115115 
    116116          <h3>Return value</h3><div class="preformat"> 
    117  A 2D (xy), 3D (xyz or yt), 4D (xyzt) Array 
     117 a 2D (xy), 3D (xyz or yt), 4D (xyzt) array 
    118118</div> 
    119119 
     
    153153          <div class="comments"> 
    154154 Matrix representing the meridional coordinates (at V/U point) of a field of vectors 
    155  A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by 
     155 A 2D (xy), 3D (xyz or yt), 4D (xyzt) array or a structure readable by 
    156156 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array. 
    157157 Note that the dimension of the array must suit the domain dimension. 
     
    199199 
    200200          <h3>Examples</h3><div class="preformat"> 
     201 
    201202 To calculate the average of the norm of streams on all the domain 
    202203 between 0 and 50: 
    203       IDL> domdef, 0, 50 
    204       IDL> res = norm(un, vn, dir = 'xyz') 
     204   IDL> domdef, 0, 50 
     205   IDL> res = norm(un, vn, dir = 'xyz') 
    205206</div> 
    206207          <h3>Version history</h3> 
    207208           
    208209          <h4>Version</h4><div class="preformat"> 
    209  $Id: norm.pro 327 2007-12-13 16:22:35Z pinsard $ 
     210 $Id: norm.pro 371 2008-08-07 09:32:02Z pinsard $ 
    210211</div> 
    211212          <h4>History</h4><div class="preformat"> 
     
    239240           
    240241          <h4>Uses routines</h4><div class="preformat"> 
    241  cm_4mesh 
    242  cm_4data 
    243  cm_4cal 
     242 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> 
     243 <a href="..//Commons/cm_4data.html">cm_4data</a> 
     244 <a href="..//Commons/cm_4cal.html">cm_4cal</a> 
    244245</div> 
    245246           
Note: See TracChangeset for help on using the changeset viewer.