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

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.3 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 located on Arakawa C-grid.
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>, <a href="#_div_keyword_MILLION">MILLION</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_div_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</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) located at T
118point (see restrictions).
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_div_param_uu">uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 Matrix representing the zonal coordinates (at U point) of a field of vectors
138 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
139 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
140 note that the dimension of the array must suit the domain dimension.
141</div>
142           
143            <h4 id="_div_param_vv">vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144             
145             
146             
147             
148             
149             
150             
151             
152            </h4>
153       
154          <div class="comments">
155 Matrix representing the meridional coordinates (at V point) of a field of vectors
156 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
157 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
158 note that the dimension of the array must suit the domain dimension.
159</div>
160           
161
162         
163
164         
165
166            <h3>Keywords</h3>
167           
168            <h4 id="_div_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
169             
170             
171             
172             
173             
174              <span class="attr">type:</span> <span class="value">scalar string</span>
175             
176             
177            </h4>
178       
179            <div class="comments">
180 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or
181 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation
182 (stupid ?) with a mean done in the DIREC direction
183</div>
184           
185            <h4 id="_div_keyword_MILLION">MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
192              <span class="attr">default:</span> <span class="value">0</span>
193             
194            </h4>
195       
196            <div class="comments">
197 Activate to multiply returned array by 1.e6
198 </div>
199           
200            <h4 id="_div_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
206             
207             
208             
209            </h4>
210       
211            <div class="comments">
212 Used to declare that this routine accepts inherited keywords
213</div>
214           
215         
216
217          <h3>Examples</h3><div class="preformat">
218
219   IDL> @tst_initorca2
220   IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj))
221</div>
222          <h3>Version history</h3>
223         
224          <h4>Version</h4><div class="preformat">
225 $Id: div.pro 378 2008-08-12 12:35:46Z pinsard $
226</div>
227          <h4>History</h4><div class="preformat">
228 Guillaume Roullet (grlod@ipsl.jussieu.fr): creation; spring 1998
229 Sebastien Masson (smasson@lodyc.jussieu.fr)
230 adaptation to work with a reduce domain; 12/1/2000
231</div>
232         
233         
234          <h3>Known issues</h3>
235         
236         
237          <h4>Todo items</h4><div class="preformat">
238 code the 4D case
239</div>
240          <h4>Restrictions</h4><div class="preformat">
241
242 - Works only for Arakawa C-grid.
243 - UU must be on U grid, VV must be on V grid
244 - 4D case is not coded yet
245 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
246 - U and V arrays are cut in the same geographic domain. Because of the shift between
247   T, U, V and F grids, it is possible that these two arrays do not have the same
248   size and refer to different indexes. In this case, arrays are re-cut on
249   common indexes. To avoid these re-cuts, use the keyword /memeindice in
250 <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a>
251 - When computing the divergence, we update, vargrid, varname, varunits and the
252   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt).
253 - points that cannot be computed (domain boundaries, coastline) are set to NaN
254</div>
255       
256          <h3>Other attributes</h3>
257         
258         
259          <h4>Uses routines</h4><div class="preformat">
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>
263</div>
264         
265         
266         
267       
268          <h3>Statistics</h3>
269          <table class="statistics">
270            <tr><td>McCabe cyclic</td><td>          55</td></tr>
271            <tr><td>McCabe essential</td><td>           1</td></tr>
272            <tr><td>McCabe modular design</td><td>           1</td></tr>
273          </table>
274         
275       
276        </div>
277       
278      </div>
279
280     
281
282      <div id="tagline">Produced by IDLdoc 2.0.</div>
283
284    </div>
285
286  </body>
287</html>
Note: See TracBrowser for help on using the repository browser.