source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/div.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 3.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="determ3.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="floatlevel2depth.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>div.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 calculation of the divergence of a 2d 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>)</font></p>
77
78   
79
80
81    <h3>Return value</h3> RES
82 A 2d matrix
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 coordinates of a field of vectors
103
104   
105
106    <a name="#_div_keyword_vv"></a>
107    <h4>vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
108     
109     
110     
111     
112     
113     
114     
115     
116    </h4>
117
118     
119 Matrix representing coordinates of a field of vectors
120
121   
122   
123
124   
125
126   
127    <h3>Version history</h3>
128   
129    <h4>Version</h4>
130 $Id: div.pro 157 2006-08-21 09:01:50Z navarro $
131
132    <h4>History</h4>
133 Guillaume Roullet (grlod@ipsl.jussieu.fr)
134                      Creation : printemps 1998
135                      Sebastien Masson (smasson@lodyc.jussieu.fr)
136                      adaptation to work with a reduce domain
137                      12/1/2000;
138
139   
140
141    <h3>Known issues</h3>
142   
143   
144   
145    <h4>Restrictions</h4>
146 U and V matrices can be 2 or 4d.
147 Beware, to discern different configuration of U and V (xy, xyz, xyt, xyzt),
148 we look at the variable of the common
149        -time which contain the calendar in IDL julian days to which U and
150 V refered to, in the same way as the variable
151        -jpt which is the number of time's step to consider in time.
152 U and V arrays are cut in the same geographic domain. Because of the gap of
153 T, U, V and F grids, it is possible that these two arrays has not the same
154 size and refered to different indexes. In this case, arrays are re-cut on
155 common indexes and the domain is redefined to match with these common
156 indexes. To avoid these re-cuts, use the keyword /memeindice in domdef.pro
157
158
159 Points on the drawing edge are at !values.f_nan
160
161
162
163    <h3>Other attributes</h3>
164   
165   
166    <h4>Uses routines</h4>
167 common.pro
168
169   
170   
171   
172
173    <font size="-3"><p>&nbsp;</p></font>
174    <hr size="1" color="#CCCCCC"/>
175     
176
177   
178
179    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:50 2006.</font></p>
180
181  </body>
182</html>
Note: See TracBrowser for help on using the repository browser.