source: trunk/SRC/Documentation/idldoc_assistant_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: 5.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>norm.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="msf.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=""><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>norm.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 calculate the norm of vectors field located on Arakawa C-grid
65
66
67   
68
69     
70      <a name="#_norm"></a>
71
72      <h2>norm  <font size="-1" color="#006633">
73 Calculation
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>norm(<i><a href="#_norm_keyword_uu">uu</a>, <a href="#_norm_keyword_vv">vv</a></i>, <a href="#_norm_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_norm_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 a 2D (xy), 3D (xyz or yt), 4D (xyzt) array
83
84
85   
86    <h3>Parameters</h3>
87   
88
89    <a name="#_norm_keyword_uu"></a>
90    <h4>uu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
91      <font size="-1" color="#006633">in</font>
92     
93     
94      <font size="-1" color="#006633">required</font>
95     
96     
97     
98     
99    </h4>
100
101   
102 Matrix representing the zonal coordinates (at U/V point) of a field of vectors
103 A 2D (xy), 3D (xyz or yt), 4D (xyzt) or a structure readable by
104 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
105 Note that the dimension of the array must suit the domain dimension.
106
107   
108
109    <a name="#_norm_keyword_vv"></a>
110    <h4>vv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111      <font size="-1" color="#006633">in</font>
112     
113     
114      <font size="-1" color="#006633">required</font>
115     
116     
117     
118     
119    </h4>
120
121   
122 Matrix representing the meridional coordinates (at V/U point) of a field of vectors
123 A 2D (xy), 3D (xyz or yt), 4D (xyzt) array or a structure readable by
124 <a href="..//ToBeReviewed/LECTURE/litchamp.html">litchamp</a> and containing a 2D (xy), 3D (xyz or yt), 4D (xyzt) array.
125 Note that the dimension of the array must suit the domain dimension.
126
127   
128   
129
130   
131    <h3>Keywords</h3>
132
133   
134    <a name="#_norm_keyword_DIREC"></a>
135    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
136     
137     
138     
139     
140     
141     
142     
143     
144    </h4>
145
146   
147 't' 'x' 'y' 'z' 'xys' 'xz' 'yz' 'xyz' 'xt' 'yt' 'zt' 'xyt'
148       'xzt' 'yzt' 'xyzt' Direction on which do averages
149
150   
151    <a name="#_norm_keyword__EXTRA"></a>
152    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153     
154     
155     
156     
157     
158     
159     
160     
161    </h4>
162
163   
164 Used to declare that this routine accepts inherited keywords
165
166   
167   
168
169    <h3>Examples</h3><pre>
170
171 To calculate the average of the norm of streams on all the domain
172 between 0 and 50:
173   IDL> domdef, 0, 50
174   IDL> res = norm(un, vn, dir = 'xyz')
175
176    </pre><h3>Version history</h3>
177   
178    <h4>Version</h4>
179 $Id: norm.pro 371 2008-08-07 09:32:02Z pinsard $
180
181    <h4>History</h4>
182 Sebastien Masson (smasson@lodyc.jussieu.fr)
183                       9/6/1999
184   
185
186    <h3>Known issues</h3>
187   
188   
189   
190    <h4>Restrictions</h4>
191 The norm is calculated on points T. To do this calculation, we average
192 field U and V on points T before calculate the norm. At the edge of
193 coast and of domain, we can not calculate fields U and V at points T,
194 that is why these points are at value !values.f_nan.
195
196 When we calculate on a reduce geographic domain, field U and V have not
197 necessarily the same number of point. In this case, we recut U and V to
198 keep only common points. We profit of this to redo a <a href="..//ToBeReviewed/GRILLE/domdef.html">domdef</a> which redefine
199 a geographic domain on which fields U and V are extracted on same points
200
201 To know what type of array we work with, we  test its size and dates
202 gave by time[0] and time[jpt-1] to know if thee is a temporal dimension.
203 Before to start norm, make sure that time and jpt are defined how
204 they have to!
205
206
207    <h3>Other attributes</h3>
208   
209   
210    <h4>Uses routines</h4>
211 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
212 <a href="..//Commons/cm_4data.html">cm_4data</a>
213 <a href="..//Commons/cm_4cal.html">cm_4cal</a>
214
215   
216   
217   
218
219    <font size="-3"><p>&nbsp;</p></font>
220    <hr size="1" color="#CCCCCC"/>
221     
222
223   
224
225    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
226
227  </body>
228</html>
Note: See TracBrowser for help on using the repository browser.