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

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

update documentation
File size: 4.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>grad.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="div.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="norm.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>grad.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 compute the gradient of a variable located on Arakawa C-grid.
65
66
67   
68
69     
70      <a name="#_grad"></a>
71
72      <h2>grad  <font size="-1" color="#006633">
73 Calculation
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>grad(<i><a href="#_grad_keyword_field">field</a>, <a href="#_grad_keyword_direc">direc</a></i>, <a href="#_grad_keyword_MILLION">MILLION</a>=<i>scalar: 0 or 1</i>, <a href="#_grad_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 the gradient of the input data with the same size 2D, 3D or 4D
83 array, located on the appropriate grid (see restrictions)
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_grad_keyword_field"></a>
91    <h4>field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92     
93     
94     
95     
96     
97     
98     
99     
100    </h4>
101
102   
103 The field for which we want to compute the gradient. A 2D (xy),
104 3D (xyz or yt) or 4D (xyzt) array or a structure readable by
105 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
106 Note that the dimension of the array must suit the domain dimension.
107
108   
109
110    <a name="#_grad_keyword_direc"></a>
111    <h4>direc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
118     
119     
120    </h4>
121
122   
123 the gradient direction: 'x', 'y', 'z'
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_grad_keyword_MILLION"></a>
133    <h4>MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
140      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
141     
142    </h4>
143
144   
145 Activate to multiply returned array by 1.e6
146 
147   
148    <a name="#_grad_keyword__EXTRA"></a>
149    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150     
151     
152     
153     
154     
155     
156     
157     
158    </h4>
159
160   
161 Used to declare that this routine accepts inherited keywords
162
163   
164   
165
166    <h3>Examples</h3><pre>
167 IDL> @tst_initorca2
168 IDL> plt, grad({arr:gphit,g:'T'}, 'x')
169 IDL> plt, grad({arr:gphit,g:'T'}, 'y')
170
171    </pre><h3>Version history</h3>
172   
173    <h4>Version</h4>
174 $Id: grad.pro 327 2007-12-13 16:22:35Z pinsard $
175
176    <h4>History</h4>
177 Sebastien Masson (smasson@lodyc.jussieu.fr)
178
179   
180
181    <h3>Known issues</h3>
182   
183   
184   
185    <h4>Restrictions</h4>
186 - Works only for Arakawa C-grid.
187 - When computing the gradient, the result is not on the same grid point
188   than the input data. In consequence, we update, vargrid and the grid position
189   parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf],
190   ny[tuvf], firstz[tw], lastz[tw], nz[tw]).
191 - points that cannot be computed (domain boundaries, coastline) are set to NaN
192 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
193
194
195    <h3>Other attributes</h3>
196   
197   
198    <h4>Uses routines</h4>
199 cm_4cal
200 cm_4data
201 cm_4mesh
202
203   
204   
205   
206
207    <font size="-3"><p>&nbsp;</p></font>
208    <hr size="1" color="#CCCCCC"/>
209     
210
211   
212
213    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
214
215  </body>
216</html>
Note: See TracBrowser for help on using the repository browser.