source: trunk/SRC/Documentation/idldoc_assistant_output/Computation/div.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 4.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>div.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="curl.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="grad.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Computation/</font></h1>
58    <h2>div.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 compute the horizontal divergence of a vectors field
65
66
67   
68
69     
70      <a name="#_div"></a>
71
72      <h2>div  <font size="-1" color="#006633">
73 Calculation
74</font></h2>
75
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>
77
78   
79
80
81    <h3>Return value</h3> RES
82 the divergence of the input data (with the same size)
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_div_keyword_uu"></a>
90    <h4>uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91     
92     
93     
94     
95     
96     
97     
98     
99    </h4>
100
101   
102 Matrix representing the zonal coordinates (U point) of a field of vectors
103 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
104 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
105 note that the dimension of the array must suit the domain dimension.
106
107   
108
109    <a name="#_div_keyword_vv"></a>
110    <h4>vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111     
112     
113     
114     
115     
116     
117     
118     
119    </h4>
120
121   
122 Matrix representing the meridional coordinates (V point) of a field of vectors
123 A 2D (xy), 3D (xyz or yt) or a structure readable by litchamp and containing
124 a 2D (xy), 3D (xyz or yt) array (4d case is not coded yet).
125 note that the dimension of the array must suit the domain dimension.
126
127   
128   
129
130   
131    <h3>Keywords</h3>
132
133   
134    <a name="#_div_keyword_DIREC"></a>
135    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
142     
143     
144    </h4>
145
146   
147 Use if you want to call moyenne or grossemoyenne after the div computation
148 (stupid ?) with a mean done in the DIREC direction
149
150   
151   
152
153    <h3>Examples</h3><pre>
154 IDL> @tst_initorca2
155 IDL> plt, div(dist(jpi,jpj), dist(jpi,jpj))
156
157    </pre><h3>Version history</h3>
158   
159    <h4>Version</h4>
160 $Id: div.pro 231 2007-03-19 17:15:51Z pinsard $
161
162    <h4>History</h4>
163 Guillaume Roullet (grlod@ipsl.jussieu.fr): creation; spring 1998
164 Sebastien Masson (smasson@lodyc.jussieu.fr)
165 adaptation to work with a reduce domain; 12/1/2000
166
167   
168
169    <h3>Known issues</h3>
170   
171   
172    <h4>Todo items</h4>
173 code the 4d case
174    <h4>Restrictions</h4>
175
176 - Works only for Arakawa C-grid.
177 - UU must be on U grid, VV must be on V grid
178 - 4d case is not coded yet
179 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
180 - U and V arrays are cut in the same geographic domain. Because of the shift between
181   T, U, V and F grids, it is possible that these two arrays do not have the same
182   size and refer to different indexes. In this case, arrays are re-cut on
183   common indexes. To avoid these re-cuts, use the keyword /memeindice in
184 <a href=".//../../ToBeReviewed/GRILLE/domdef.html">domdef</a>
185 - When computing the divergence, we update, vargrid, varname, varunits and the
186   grid position parameters (firstxt, lastxt, nxt, firstyt, lastyt, nyt).
187 - points that cannot be computed (domain boundaries, coastline) are set to NaN
188
189
190    <h3>Other attributes</h3>
191   
192   
193    <h4>Uses routines</h4>
194 cm_4cal, cm_4data, cm_4mmesh
195
196   
197   
198   
199
200    <font size="-3"><p>&nbsp;</p></font>
201    <hr size="1" color="#CCCCCC"/>
202     
203
204   
205
206    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
207
208  </body>
209</html>
Note: See TracBrowser for help on using the repository browser.