source: trunk/SRC/Documentation/idldoc_html_output/Computation/norm.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 6.7 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>norm.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="norm.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//norm.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="msf.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="norm.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">norm.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 calculate the norm of vectors field 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="_norm">
105
106          <h2><a class="top" href="#container">top</a>norm <span class="categories">
107 Calculation
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>norm(<span class="result"><a href="#_norm_param_uu">uu</a>, <a href="#_norm_param_vv">vv</a></span>, <a href="#_norm_keyword_DIREC">DIREC</a>=<span class="result">DIREC</span>, <a href="#_norm_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 a 2D (xy), 3D (xyz or yt), 4D (xyzt) array
118</div>
119
120         
121            <h3>Parameters</h3>
122       
123           
124            <h4 id="_norm_param_uu">uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125              <span class="attr">in</span>
126             
127             
128              <span class="attr">required</span>
129             
130             
131             
132             
133            </h4>
134       
135          <div class="comments">
136 Matrix representing the zonal coordinates (at U/V point) of a field of vectors
137 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
138 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
139 Note that the dimension of the array must suit the domain dimension.
140</div>
141           
142            <h4 id="_norm_param_vv">vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143              <span class="attr">in</span>
144             
145             
146              <span class="attr">required</span>
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments">
154 Matrix representing the meridional coordinates (at V/U point) of a field of vectors
155 A 2D (xy), 3D (xyz or yt), 4D (xyzt) array or a structure readable by
156 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
157 Note that the dimension of the array must suit the domain dimension.
158</div>
159           
160
161         
162
163         
164
165            <h3>Keywords</h3>
166           
167            <h4 id="_norm_keyword_DIREC">DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168             
169             
170             
171             
172             
173             
174             
175             
176            </h4>
177       
178            <div class="comments">
179 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
180       'xzt' 'yzt' 'xyzt' Direction on which do averages
181</div>
182           
183            <h4 id="_norm_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
184             
185             
186             
187             
188             
189             
190             
191             
192            </h4>
193       
194            <div class="comments">
195 Used to declare that this routine accepts inherited keywords
196</div>
197           
198         
199
200          <h3>Examples</h3><div class="preformat">
201
202 To calculate the average of the norm of streams on all the domain
203 between 0 and 50:
204   IDL> domdef, 0, 50
205   IDL> res = norm(un, vn, dir = 'xyz')
206</div>
207          <h3>Version history</h3>
208         
209          <h4>Version</h4><div class="preformat">
210 $Id: norm.pro 371 2008-08-07 09:32:02Z pinsard $
211</div>
212          <h4>History</h4><div class="preformat">
213 Sebastien Masson (smasson@lodyc.jussieu.fr)
214                       9/6/1999</div>
215         
216         
217          <h3>Known issues</h3>
218         
219         
220         
221          <h4>Restrictions</h4><div class="preformat">
222 The norm is calculated on points T. To do this calculation, we average
223 field U and V on points T before calculate the norm. At the edge of
224 coast and of domain, we can not calculate fields U and V at points T,
225 that is why these points are at value !values.f_nan.
226
227 When we calculate on a reduce geographic domain, field U and V have not
228 necessarily the same number of point. In this case, we recut U and V to
229 keep only common points. We profit of this to redo a <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> which redefine
230 a geographic domain on which fields U and V are extracted on same points
231
232 To know what type of array we work with, we  test its size and dates
233 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
234 Before to start norm, make sure that time and jpt are defined how
235 they have to!
236</div>
237       
238          <h3>Other attributes</h3>
239         
240         
241          <h4>Uses routines</h4><div class="preformat">
242 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
243 <a href="..//Commons/cm_4data.html">cm_4data</a>
244 <a href="..//Commons/cm_4cal.html">cm_4cal</a>
245</div>
246         
247         
248         
249       
250          <h3>Statistics</h3>
251          <table class="statistics">
252            <tr><td>McCabe cyclic</td><td>         121</td></tr>
253            <tr><td>McCabe essential</td><td>           1</td></tr>
254            <tr><td>McCabe modular design</td><td>           1</td></tr>
255          </table>
256         
257       
258        </div>
259       
260      </div>
261
262     
263
264      <div id="tagline">Produced by IDLdoc 2.0.</div>
265
266    </div>
267
268  </body>
269</html>
Note: See TracBrowser for help on using the repository browser.