source: trunk/SRC/Documentation/idldoc_html_output/Computation/div.html @ 249

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation
File size: 6.2 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>div.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="div.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Computation//div.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="curl.html">&lt;&lt;prev file</a> | <a href="grad.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="div.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>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Computation/</a></h1>
82      <h2 class="pro_file">div.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 compute the horizontal divergence of a vectors field
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_div">
105
106          <h2><a class="top" href="#container">top</a>div <span class="categories">
107 Calculation
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>div(<span class="result"><a href="#_div_param_uu">uu</a>, <a href="#_div_param_vv">vv</a></span>, <a href="#_div_keyword_DIREC">DIREC</a>=<span class="result">scalar string</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 the divergence of the input data (with the same size)
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_div_param_uu">uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125             
126             
127             
128             
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 Matrix representing the zonal coordinates (U point) of a field of vectors
137 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.
140</div>
141           
142            <h4 id="_div_param_vv">vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments">
154 Matrix representing the meridional coordinates (V point) of a field of vectors
155 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.
158</div>
159           
160
161         
162
163         
164
165            <h3>Keywords</h3>
166           
167            <h4 id="_div_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173              <span class="attr">type:</span> <span class="value">scalar string</span>
174             
175             
176            </h4>
177       
178            <div class="comments">
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
181 (stupid ?) with a mean done in the DIREC direction
182</div>
183           
184         
185
186          <h3>Examples</h3><div class="preformat">
187 IDL> @tst_initorca2
188 IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj))
189</div>
190          <h3>Version history</h3>
191         
192          <h4>Version</h4><div class="preformat">
193 $Id: div.pro 242 2007-04-06 08:35:17Z pinsard $
194</div>
195          <h4>History</h4><div class="preformat">
196 Guillaume Roullet (grlod@ipsl.jussieu.fr): creation; spring 1998
197 Sebastien Masson (smasson@lodyc.jussieu.fr)
198 adaptation to work with a reduce domain; 12/1/2000
199</div>
200         
201         
202          <h3>Known issues</h3>
203         
204         
205          <h4>Todo items</h4><div class="preformat">
206 code the 4D case
207</div>
208          <h4>Restrictions</h4><div class="preformat">
209
210 - Works only for Arakawa C-grid.
211 - UU must be on U grid, VV must be on V grid
212 - 4D case is not coded yet
213 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
214 - U and V arrays are cut in the same geographic domain. Because of the shift between
215   T, U, V and F grids, it is possible that these two arrays do not have the same
216   size and refer to different indexes. In this case, arrays are re-cut on
217   common indexes. To avoid these re-cuts, use the keyword /memeindice in
218 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
219 - When computing the divergence, we update, vargrid, varname, varunits and the
220   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt).
221 - points that cannot be computed (domain boundaries, coastline) are set to NaN
222</div>
223       
224          <h3>Other attributes</h3>
225         
226         
227          <h4>Uses routines</h4><div class="preformat">
228 cm_4cal
229 cm_4data
230 cm_4mmesh
231</div>
232         
233         
234         
235       
236          <h3>Statistics</h3>
237          <table class="statistics">
238            <tr><td>McCabe cyclic</td><td>          49</td></tr>
239            <tr><td>McCabe essential</td><td>           1</td></tr>
240            <tr><td>McCabe modular design</td><td>           1</td></tr>
241          </table>
242         
243       
244        </div>
245       
246      </div>
247
248     
249
250      <div id="tagline">Produced by IDLdoc 2.0.</div>
251
252    </div>
253
254  </body>
255</html>
Note: See TracBrowser for help on using the repository browser.