source: trunk/SRC/Documentation/idldoc_html_output/Computation/grad.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: 5.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> | next file &gt;&gt;&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
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>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat"> RES {type=2D, 3D or 4D array}
117 the gradient of the input data (with the same size)
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_grad_param_field">field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125             
126             
127             
128             
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 The field for which we want to compute the gradient.  A 2D (xy),
137 3D (xyz or yt) or 4D (xyzt) array or a structure readable by litchamp
138 and containing a 2D (xy), 3D (xyz or yt) or 4D (xyzt) array.
139 note that the dimension of the array must suit the domain dimension.
140</div>
141           
142            <h4 id="_grad_param_direc">direc&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148              <span class="attr">type:</span> <span class="value">scalar string</span>
149             
150             
151            </h4>
152       
153          <div class="comments">
154 the gradient direction: 'x', 'y', 'z'
155</div>
156           
157
158         
159
160         
161
162          <h3>Examples</h3><div class="preformat">
163 IDL> @tst_initorca2
164 IDL> plt, grad({arr:gphit,g:'T'}, 'x')
165 IDL> plt, grad({arr:gphit,g:'T'}, 'y')
166</div>
167          <h3>Version history</h3>
168         
169          <h4>Version</h4><div class="preformat">
170 $Id: grad.pro 232 2007-03-20 16:59:36Z pinsard $
171</div>
172          <h4>History</h4><div class="preformat">
173 Sebastien Masson (smasson@lodyc.jussieu.fr)
174</div>
175         
176         
177          <h3>Known issues</h3>
178         
179         
180         
181          <h4>Restrictions</h4><div class="preformat">
182 - Works only for Arakawa C-grid.
183 - When computing the gradient, the result is not on the same grid point
184   than the input data. In consequence, we update, vargrid and the grid position
185   parameters (firstx[tuvf], lastx[tuvf], nx[tuvf], firsty[tuvf], lasty[tuvf],
186   ny[tuvf], firstz[tw], lastz[tw], nz[tw]).
187 - points that cannot be computed (domain boundaries, coastline) are set to NaN
188 - the common variable jpt is used to differ xyz (jpt=1) and xyt (jpt=1) cases.
189</div>
190       
191          <h3>Other attributes</h3>
192         
193         
194          <h4>Uses routines</h4><div class="preformat">
195 cm_4cal, cm_4data, cm_4mmesh
196</div>
197         
198         
199         
200       
201          <h3>Statistics</h3>
202          <table class="statistics">
203            <tr><td>McCabe cyclic</td><td>          67</td></tr>
204            <tr><td>McCabe essential</td><td>           1</td></tr>
205            <tr><td>McCabe modular design</td><td>           1</td></tr>
206          </table>
207         
208       
209        </div>
210       
211      </div>
212
213     
214
215      <div id="tagline">Produced by IDLdoc 2.0.</div>
216
217    </div>
218
219  </body>
220</html>
Note: See TracBrowser for help on using the repository browser.