source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/CALCULS/hdyn.html @ 107

Last change on this file since 107 was 107, checked in by smasson, 18 years ago

bugfix in ead/write_oasis
File size: 7.1 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_hdyn">
103
104          <h2><a class="top" href="#container">top</a>hdyn </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:hdyn
111
112 PURPOSE:calcule la hauteur dynamique par rapport a un etat de
113 reference pour une profondeur de reference. Cf les mots cles pour
114 les differentes possibilites.
115 Par defaut l''etat de reference est
116 rho=1020 et la profondeur de reference est gdepw[ka] avec ka le
117 premier niveau W directement au dessus de 1000 m.
118
119 CATEGORY: calculs de post-traitement
120
121 CALLING SEQUENCE:res=hdyn(sn,tn)
122
123 INPUTS:sn et tn sont des tableaux de meme taille representant la
124 salinite et la temperature.
125
126 KEYWORD PARAMETERS:
127
128        GILL: activer cette cle si on veut faire le calcul de la
129        hauteur dynamique comme ds le GILL page 215 cad par rapport a
130        un etat de reference qui varie en profondeur et qui est
131        determine par une temperature de reference tref a 0 degre et
132        une salinite de reference sref a 35psu
133
134        LEVEL: C''est le niveau de reference a prendre. Ce niveau est
135        definit tel que gdepw[level] est la profondeur de reference
136
137        SREF: donner une valeur a ce mot cle pour changer la salinite
138        de reference utiliser ds le calcul lorsque GILL est active.
139   
140        TREF: donner une valeur a ce mot cle pour changer la temperature
141        de reference utiliser ds le calcul lorsque GILL est active.
142
143        PROFREF: donner a ce mot cle une profondeur qui sera prise comme
144        la profondeur de reference (ds ce cas LEVEL n'' a aucun
145        effet). le calcul sera alors effectue jusqu''a cette
146        profondeur en effectuant une interpolation entre le dernier
147        niveau W au dessus de PROFREF et PROFREF.
148
149        SURFACE_LEVEL: C''est le niveau auquel on veut calculer la
150        hauteur dynamique. Par defaut c''est le niveau 0.
151
152 OUTPUTS:un tableau de la meme taille que sn et tn representant la
153 hauteur dynamique calculee a partir d''une profondeur de reference
154 et par rapport a un etat de reference.
155
156 COMMON BLOCKS:
157        common.pro
158
159 SIDE EFFECTS:
160 les points pour lesquels on nje peut calcule la hauteur dynamique
161 (dont la batymetrie est moins profonde que la profondeur de
162 reference) sont mis a la valeur !values.f_nan
163
164 RESTRICTIONS:approximation: la pression en decibars est egale a la
165 profondeur en metres (la pression augmente de 1bar tous les 10m)
166
167 EXAMPLE:
168</div>
169
170         
171
172         
173            <h3>Parameters</h3>
174       
175           
176            <h4 id="_hdyn_param_tabsn">tabsn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177             
178             
179             
180             
181             
182             
183             
184             
185            </h4>
186       
187          <div class="comments"></div>
188           
189            <h4 id="_hdyn_param_tabtn">tabtn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
190             
191             
192             
193             
194             
195             
196             
197             
198            </h4>
199       
200          <div class="comments"></div>
201           
202
203         
204
205         
206
207            <h3>Keywords</h3>
208           
209            <h4 id="_hdyn_keyword_TREF">TREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
210             
211             
212             
213             
214             
215             
216             
217             
218            </h4>
219       
220            <div class="comments"></div>
221           
222            <h4 id="_hdyn_keyword_SREF">SREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
223             
224             
225             
226             
227             
228             
229             
230             
231            </h4>
232       
233            <div class="comments"></div>
234           
235            <h4 id="_hdyn_keyword_PROFREF">PROFREF&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241             
242             
243             
244            </h4>
245       
246            <div class="comments"></div>
247           
248            <h4 id="_hdyn_keyword_LEVEL">LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250             
251             
252             
253             
254             
255             
256             
257            </h4>
258       
259            <div class="comments"></div>
260           
261            <h4 id="_hdyn_keyword_GILL">GILL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262             
263             
264             
265             
266             
267             
268             
269             
270            </h4>
271       
272            <div class="comments"></div>
273           
274            <h4 id="_hdyn_keyword_SURFACE_LEVEL">SURFACE_LEVEL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
275             
276             
277             
278             
279             
280             
281             
282             
283            </h4>
284       
285            <div class="comments"></div>
286           
287         
288
289         
290         
291         
292         
293         
294         
295         
296         
297         
298         
299         
300         
301       
302         
303         
304         
305         
306         
307         
308         
309       
310         
311       
312        </div>
313       
314      </div>
315
316     
317
318      <div id="tagline">Produced by IDLdoc 2.0.</div>
319
320    </div>
321
322  </body>
323</html>
Note: See TracBrowser for help on using the repository browser.