source: trunk/SRC/Documentation/idldoc_assistant_output/Computation/curl.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.8 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>curl.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=""><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="div.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>curl.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Calculate the vertical component of the curl of a vectors field
65 located on Arakawa C-grid.
66
67
68   
69
70     
71      <a name="#_curl"></a>
72
73      <h2>curl  <font size="-1" color="#006633">
74 Calculation
75</font></h2>
76
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>
78
79   
80
81
82    <h3>Return value</h3>
83 the vertical component of the curl of the input data (with the same
84 size) located at F point (see restrictions)
85
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_curl_keyword_uu"></a>
92    <h4>uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93     
94     
95     
96     
97     
98     
99     
100     
101    </h4>
102
103   
104 Matrix representing the zonal coordinates (at U point) of a field of vectors
105 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
106 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
107 Note that the dimension of the array must suit the domain dimension.
108
109   
110
111    <a name="#_curl_keyword_vv"></a>
112    <h4>vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
113     
114     
115     
116     
117     
118     
119     
120     
121    </h4>
122
123   
124 Matrix representing the meridional coordinates (at V point) of a field of vectors
125 A 2D (xy), 3D (xyz or yt) or a structure readable by <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing
126 a 2D (xy), 3D (xyz or yt) array (4D case is not coded yet).
127 Note that the dimension of the array must suit the domain dimension.
128
129   
130   
131
132   
133    <h3>Keywords</h3>
134
135   
136    <a name="#_curl_keyword_DIREC"></a>
137    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
138     
139     
140     
141     
142     
143      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
144     
145     
146    </h4>
147
148   
149 Use if you want to call <a href="..//ToBeReviewed/CALCULS/moyenne.html">moyenne</a> or
150 <a href="..//ToBeReviewed/CALCULS/grossemoyenne.html">grossemoyenne</a> after the div computation
151 with a mean done in the DIREC direction
152
153   
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   
186   
187
188    <h3>Examples</h3><pre>
189    </pre><h3>Version history</h3>
190   
191    <h4>Version</h4>
192 $Id: curl.pro 327 2007-12-13 16:22:35Z pinsard $
193
194    <h4>History</h4>
195 Guillaume Roullet (grlod@ipsl.jussieu.fr)
196 Sebastien Masson (smasson@lodyc.jussieu.fr)
197 adaptation to work with a reduce domain
198 21/5/1999: missing values at !values.f_nan
199
200   
201
202    <h3>Known issues</h3>
203   
204   
205    <h4>Todo items</h4>
206 code the 4D case
207
208    <h4>Restrictions</h4>
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 (firstxf, lastxf, nxf, firstyf, lastyf, nyf).
221 - points that cannot be computed (domain boundaries, coastline) are set to NaN
222
223
224    <h3>Other attributes</h3>
225   
226   
227    <h4>Uses routines</h4>
228 cm_4cal
229 cm_4data
230 cm_4mesh
231
232   
233   
234   
235
236    <font size="-3"><p>&nbsp;</p></font>
237    <hr size="1" color="#CCCCCC"/>
238     
239
240   
241
242    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
243
244  </body>
245</html>
Note: See TracBrowser for help on using the repository browser.