source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/CALCULS/hdyn.html @ 402

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

update documentation
File size: 6.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>hdyn.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="grossemoyenne.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="level2depth.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/CALCULS/</font></h1>
58    <h2>hdyn.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Calculate the height by rapport to a reference state for a depth reference.
65 See keywords for different possibilities. By default, the state reference
66 is rho=1020 and the depth reference is gdepw[ka] with ka the first W level
67 directly above 1000 m.
68
69
70   
71
72     
73      <a name="#_hdyn"></a>
74
75      <h2>hdyn  <font size="-1" color="#006633">
76 Calculation
77</font></h2>
78
79      <p><font face="Courier"><i>result = </i>hdyn(<i><a href="#_hdyn_keyword_tabsn">tabsn</a>, <a href="#_hdyn_keyword_tabtn">tabtn</a></i>, <a href="#_hdyn_keyword_TREF">TREF</a>=<i>TREF</i>, <a href="#_hdyn_keyword_SREF">SREF</a>=<i>SREF</i>, <a href="#_hdyn_keyword_PROFREF">PROFREF</a>=<i>PROFREF</i>, <a href="#_hdyn_keyword_LEVEL">LEVEL</a>=<i>LEVEL</i>, <a href="#_hdyn_keyword_GILL">GILL</a>=<i>GILL</i>, <a href="#_hdyn_keyword_SURFACE_LEVEL">SURFACE_LEVEL</a>=<i>SURFACE_LEVEL</i>)</font></p>
80
81   
82
83
84    <h3>Return value</h3>
85 An array of the same size of sn and tn representing the dynamic height calculated
86 from a reference depth nd by rapport to a reference state.
87
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_hdyn_keyword_tabsn"></a>
94    <h4>tabsn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95      <font size="-1" color="#006633">in</font>
96     
97     
98      <font size="-1" color="#006633">required</font>
99     
100     
101     
102     
103    </h4>
104
105   
106 array representing the salinity
107
108   
109
110    <a name="#_hdyn_keyword_tabtn"></a>
111    <h4>tabtn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112      <font size="-1" color="#006633">in</font>
113     
114     
115      <font size="-1" color="#006633">required</font>
116     
117     
118     
119     
120    </h4>
121
122   
123 array representing the temperature. Has the same size than SN.
124
125   
126   
127
128   
129    <h3>Keywords</h3>
130
131   
132    <a name="#_hdyn_keyword_TREF"></a>
133    <h4>TREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
134     
135     
136     
137     
138     
139     
140     
141     
142    </h4>
143
144   
145 Give a value to this keyword to change the reference temperature used in the
146 calculation when GILL is activated.
147
148   
149    <a name="#_hdyn_keyword_SREF"></a>
150    <h4>SREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
151     
152     
153     
154     
155     
156     
157     
158     
159    </h4>
160
161   
162 Give a value to this keyword to change the reference salinity used in the
163 calculation when GILL is activated.
164
165   
166    <a name="#_hdyn_keyword_PROFREF"></a>
167    <h4>PROFREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168     
169     
170     
171     
172     
173     
174     
175     
176    </h4>
177
178   
179 Give a depth to this keyword which will be considered as the reference depth
180 (in this case, LEVEL has not any effect). the calculation will be effectuated
181 until this depth effecting an interpolation between the last W level above
182 PROFREF and PROFREF.
183
184   
185    <a name="#_hdyn_keyword_LEVEL"></a>
186    <h4>LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187     
188     
189     
190     
191     
192     
193     
194     
195    </h4>
196
197   
198 It is the same reference level to take. This level is defined like
199 that gdepw[level] is the reference depth
200
201   
202    <a name="#_hdyn_keyword_GILL"></a>
203    <h4>GILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204     
205     
206     
207     
208     
209     
210     
211     
212    </h4>
213
214   
215 We activate this key if we want to calculate the dynamic height
216 like in the GILL page 215, which means by rapport to a reference state which
217 vary in depth and which is determined by a reference temperature tref at 0°C
218 and a reference salinity sref at 35 psu.
219
220   
221    <a name="#_hdyn_keyword_SURFACE_LEVEL"></a>
222    <h4>SURFACE_LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223     
224     
225     
226     
227     
228     
229      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
230     
231    </h4>
232
233   
234 It is the level where we wan to calculate the dynamic height.
235
236   
237   
238
239   
240    </pre><h3>Version history</h3>
241   
242    <h4>Version</h4>
243 $Id: hdyn.pro 370 2008-08-07 07:59:15Z pinsard $
244
245    <h4>History</h4>
246 Sebastien Masson (smasson@lodyc.jussieu.fr)
247
248   
249
250    <h3>Known issues</h3>
251   
252   
253   
254    <h4>Restrictions</h4>
255 Points for which we can not calculate the dynamic height (whose the batymetry
256 is less deep than the reference depth) are put at the value !values.f_nan
257
258
259 approximation: The pressure in decibars is equal to the depth in meters
260 (the pressure increase of 1 bar every 10 m)
261
262
263    <h3>Other attributes</h3>
264   
265   
266    <h4>Uses routines</h4>
267 <a href="../..//Obsolete/common.html">common</a>
268
269   
270   
271   
272
273    <font size="-3"><p>&nbsp;</p></font>
274    <hr size="1" color="#CCCCCC"/>
275     
276
277   
278
279    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
280
281  </body>
282</html>
Note: See TracBrowser for help on using the repository browser.