source: trunk/SRC/Documentation/idldoc_html_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: 6.0 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>grad.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="grad.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//grad.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="div.html">&lt;&lt;prev file</a> | <a href="norm.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="grad.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">grad.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 compute the gradient of a variable 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="_grad">
105
106          <h2><a class="top" href="#container">top</a>grad <span class="categories">
107 Calculation
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>grad(<span class="result"><a href="#_grad_param_field">field</a>, <a href="#_grad_param_direc">direc</a></span>, <a href="#_grad_keyword_MILLION">MILLION</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_grad_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 gradient of the input data with the same size 2D, 3D or 4D
118 array, located on the appropriate grid (see restrictions)
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_grad_param_field">field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126             
127             
128             
129             
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 The field for which we want to compute the gradient. A 2D (xy),
138 3D (xyz or yt) or 4D (xyzt) array or a structure readable by
139 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
140 Note that the dimension of the array must suit the domain dimension.
141</div>
142           
143            <h4 id="_grad_param_direc">direc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144             
145             
146             
147             
148             
149              <span class="attr">type:</span> <span class="value">scalar string</span>
150             
151             
152            </h4>
153       
154          <div class="comments">
155 the gradient direction: 'x', 'y', 'z'
156</div>
157           
158
159         
160
161         
162
163            <h3>Keywords</h3>
164           
165            <h4 id="_grad_keyword_MILLION">MILLION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
172              <span class="attr">default:</span> <span class="value">0</span>
173             
174            </h4>
175       
176            <div class="comments">
177 Activate to multiply returned array by 1.e6
178 </div>
179           
180            <h4 id="_grad_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186             
187             
188             
189            </h4>
190       
191            <div class="comments">
192 Used to declare that this routine accepts inherited keywords
193</div>
194           
195         
196
197          <h3>Examples</h3><div class="preformat">
198 IDL> @tst_initorca2
199 IDL> plt, grad({arr:gphit,g:'T'}, 'x')
200 IDL> plt, grad({arr:gphit,g:'T'}, 'y')
201</div>
202          <h3>Version history</h3>
203         
204          <h4>Version</h4><div class="preformat">
205 $Id: grad.pro 327 2007-12-13 16:22:35Z pinsard $
206</div>
207          <h4>History</h4><div class="preformat">
208 Sebastien Masson (smasson@lodyc.jussieu.fr)
209</div>
210         
211         
212          <h3>Known issues</h3>
213         
214         
215         
216          <h4>Restrictions</h4><div class="preformat">
217 - Works only for Arakawa C-grid.
218 - When computing the gradient, the result is not on the same grid point
219   than the input data. In consequence, we update, vargrid and the grid position
220   parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf],
221   ny[tuvf], firstz[tw], lastz[tw], nz[tw]).
222 - points that cannot be computed (domain boundaries, coastline) are set to NaN
223 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
224</div>
225       
226          <h3>Other attributes</h3>
227         
228         
229          <h4>Uses routines</h4><div class="preformat">
230 cm_4cal
231 cm_4data
232 cm_4mesh
233</div>
234         
235         
236         
237       
238          <h3>Statistics</h3>
239          <table class="statistics">
240            <tr><td>McCabe cyclic</td><td>          70</td></tr>
241            <tr><td>McCabe essential</td><td>           1</td></tr>
242            <tr><td>McCabe modular design</td><td>           1</td></tr>
243          </table>
244         
245       
246        </div>
247       
248      </div>
249
250     
251
252      <div id="tagline">Produced by IDLdoc 2.0.</div>
253
254    </div>
255
256  </body>
257</html>
Note: See TracBrowser for help on using the repository browser.