source: trunk/SRC/Documentation/idldoc_html_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: 7.5 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>hdyn.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="hdyn.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="../../../../ToBeReviewed/CALCULS//hdyn.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="grossemoyenne.html">&lt;&lt;prev file</a> | <a href="level2depth.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="hdyn.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">ToBeReviewed/CALCULS/</a></h1>
82      <h2 class="pro_file">hdyn.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Calculate the height by rapport to a reference state for a depth reference.
91 See keywords for different possibilities. By default, the state reference
92 is rho=1020 and the depth reference is gdepw[ka] with ka the first W level
93 directly above 1000 m.
94</div>
95
96     
97
98     
99
100     
101
102     
103
104      <div id="routine_details">
105       
106
107        <div class="routine_details" id="_hdyn">
108
109          <h2><a class="top" href="#container">top</a>hdyn <span class="categories">
110 Calculation
111</span></h2>
112       
113          <p class="header">
114            <span class="result">result = </span>hdyn(<span class="result"><a href="#_hdyn_param_tabsn">tabsn</a>, <a href="#_hdyn_param_tabtn">tabtn</a></span>, <a href="#_hdyn_keyword_TREF">TREF</a>=<span class="result">TREF</span>, <a href="#_hdyn_keyword_SREF">SREF</a>=<span class="result">SREF</span>, <a href="#_hdyn_keyword_PROFREF">PROFREF</a>=<span class="result">PROFREF</span>, <a href="#_hdyn_keyword_LEVEL">LEVEL</a>=<span class="result">LEVEL</span>, <a href="#_hdyn_keyword_GILL">GILL</a>=<span class="result">GILL</span>, <a href="#_hdyn_keyword_SURFACE_LEVEL">SURFACE_LEVEL</a>=<span class="result">SURFACE_LEVEL</span>)</p>
115       
116          <div class="comments">
117</div>
118
119          <h3>Return value</h3><div class="preformat">
120 An array of the same size of sn and tn representing the dynamic height calculated
121 from a reference depth nd by rapport to a reference state.
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_hdyn_param_tabsn">tabsn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments">
140 array representing the salinity
141</div>
142           
143            <h4 id="_hdyn_param_tabtn">tabtn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
144              <span class="attr">in</span>
145             
146             
147              <span class="attr">required</span>
148             
149             
150             
151             
152            </h4>
153       
154          <div class="comments">
155 array representing the temperature. Has the same size than SN.
156</div>
157           
158
159         
160
161         
162
163            <h3>Keywords</h3>
164           
165            <h4 id="_hdyn_keyword_TREF">TREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176            <div class="comments">
177 Give a value to this keyword to change the reference temperature used in the
178 calculation when GILL is activated.
179</div>
180           
181            <h4 id="_hdyn_keyword_SREF">SREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments">
193 Give a value to this keyword to change the reference salinity used in the
194 calculation when GILL is activated.
195</div>
196           
197            <h4 id="_hdyn_keyword_PROFREF">PROFREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
208            <div class="comments">
209 Give a depth to this keyword which will be considered as the reference depth
210 (in this case, LEVEL has not any effect). the calculation will be effectuated
211 until this depth effecting an interpolation between the last W level above
212 PROFREF and PROFREF.
213</div>
214           
215            <h4 id="_hdyn_keyword_LEVEL">LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216             
217             
218             
219             
220             
221             
222             
223             
224            </h4>
225       
226            <div class="comments">
227 It is the same reference level to take. This level is defined like
228 that gdepw[level] is the reference depth
229</div>
230           
231            <h4 id="_hdyn_keyword_GILL">GILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233             
234             
235             
236             
237             
238             
239             
240            </h4>
241       
242            <div class="comments">
243 We activate this key if we want to calculate the dynamic height
244 like in the GILL page 215, which means by rapport to a reference state which
245 vary in depth and which is determined by a reference temperature tref at 0°C
246 and a reference salinity sref at 35 psu.
247</div>
248           
249            <h4 id="_hdyn_keyword_SURFACE_LEVEL">SURFACE_LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
250             
251             
252             
253             
254             
255             
256              <span class="attr">default:</span> <span class="value">0</span>
257             
258            </h4>
259       
260            <div class="comments">
261 It is the level where we wan to calculate the dynamic height.
262</div>
263           
264         
265
266         
267          <h3>Version history</h3>
268         
269          <h4>Version</h4><div class="preformat">
270 $Id: hdyn.pro 370 2008-08-07 07:59:15Z pinsard $
271</div>
272          <h4>History</h4><div class="preformat">
273 Sebastien Masson (smasson@lodyc.jussieu.fr)
274</div>
275         
276         
277          <h3>Known issues</h3>
278         
279         
280         
281          <h4>Restrictions</h4><div class="preformat">
282 Points for which we can not calculate the dynamic height (whose the batymetry
283 is less deep than the reference depth) are put at the value !values.f_nan
284
285
286 approximation: The pressure in decibars is equal to the depth in meters
287 (the pressure increase of 1 bar every 10 m)
288</div>
289       
290          <h3>Other attributes</h3>
291         
292         
293          <h4>Uses routines</h4><div class="preformat">
294 <a href="../..//Obsolete/common.html">common</a>
295</div>
296         
297         
298         
299       
300          <h3>Statistics</h3>
301          <table class="statistics">
302            <tr><td>McCabe cyclic</td><td>          28</td></tr>
303            <tr><td>McCabe essential</td><td>           1</td></tr>
304            <tr><td>McCabe modular design</td><td>           1</td></tr>
305          </table>
306         
307       
308        </div>
309       
310      </div>
311
312     
313
314      <div id="tagline">Produced by IDLdoc 2.0.</div>
315
316    </div>
317
318  </body>
319</html>
Note: See TracBrowser for help on using the repository browser.