source: trunk/SRC/Documentation/idldoc_html_output/Interpolation/angle.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 8.8 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>angle.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="angle.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="../../../Interpolation//angle.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&lt;&lt; prev file | <a href="clickincell.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="angle.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">Interpolation/</a></h1>
82      <h2 class="pro_file">angle.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 north stereographic polar projection
91
92
93 Compute angles between grid lines and direction of the North pole
94(fom angle.F,v 2.2 in OPA8.2)
95</div>
96
97     
98
99     
100
101     
102
103     
104
105      <div id="routine_details">
106       
107
108        <div class="routine_details" id="_angle">
109
110          <h2><a class="top" href="#container">top</a>angle <span class="categories">
111 Interpolation
112</span></h2>
113       
114          <p class="header">
115            angle<span class="result">, <a href="#_angle_param_fileocemesh">fileocemesh</a>, <a href="#_angle_param_gcosu">gcosu</a>, <a href="#_angle_param_gsinu">gsinu</a>, <a href="#_angle_param_gcosv">gcosv</a>, <a href="#_angle_param_gsinv">gsinv</a>, <a href="#_angle_param_gcost">gcost</a>, <a href="#_angle_param_gsint">gsint</a>, <a href="#_angle_param_gcosf">gcosf</a>, <a href="#_angle_param_gsinf">gsinf</a></span>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">scalar string</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">1 or 0</span></p>
116       
117          <div class="comments">
118</div>
119
120         
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129             
130              <span class="attr">required</span>
131             
132              <span class="attr">type:</span> <span class="value">scalar string</span>
133             
134             
135            </h4>
136       
137          <div class="comments">
138 a netcdf file that contains (at least) the following variables:
139        glamt, gphit: longitudes and latitudes at T-points
140        glamu, gphiu: longitudes and latitudes at U-points
141        glamv, gphiv: longitudes and latitudes at V-points
142        glamf, gphif: longitudes and latitudes at F-points
143</div>
144           
145            <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146             
147              <span class="attr">out</span>
148             
149             
150             
151              <span class="attr">type:</span> <span class="value">2d array</span>
152             
153             
154            </h4>
155       
156          <div class="comments">
157 cosinus of the angle between grid lines at U points and direction of the North pole
158</div>
159           
160            <h4 id="_angle_param_gsinu">gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161             
162              <span class="attr">out</span>
163             
164             
165             
166              <span class="attr">type:</span> <span class="value">2d array</span>
167             
168             
169            </h4>
170       
171          <div class="comments">
172 sinus of the angle between grid lines at U points and direction of the North pole
173</div>
174           
175            <h4 id="_angle_param_gcosv">gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177              <span class="attr">out</span>
178             
179             
180             
181              <span class="attr">type:</span> <span class="value">2d array</span>
182             
183             
184            </h4>
185       
186          <div class="comments">
187 cosinus of the angle between grid lines at V points and direction of the North pole
188</div>
189           
190            <h4 id="_angle_param_gsinv">gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191             
192              <span class="attr">out</span>
193             
194             
195             
196              <span class="attr">type:</span> <span class="value">2d array</span>
197             
198             
199            </h4>
200       
201          <div class="comments">
202 sinus of the angle between grid lines at V points and direction of the North pole
203</div>
204           
205            <h4 id="_angle_param_gcost">gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207              <span class="attr">out</span>
208             
209             
210             
211              <span class="attr">type:</span> <span class="value">2d array</span>
212             
213             
214            </h4>
215       
216          <div class="comments">
217 cosinus of the angle between grid lines at T points and direction of the North pole
218</div>
219           
220            <h4 id="_angle_param_gsint">gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222              <span class="attr">out</span>
223             
224             
225             
226              <span class="attr">type:</span> <span class="value">2d array</span>
227             
228             
229            </h4>
230       
231          <div class="comments">
232 sinus of the angle between grid lines at T points and direction of the North pole
233</div>
234           
235            <h4 id="_angle_param_gcosf">gcosf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237              <span class="attr">out</span>
238             
239             
240             
241              <span class="attr">type:</span> <span class="value">2d array</span>
242             
243             
244            </h4>
245       
246          <div class="comments">
247 cosinus of the angle between grid lines at F points and direction of the North pole
248</div>
249           
250            <h4 id="_angle_param_gsinf">gsinf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252              <span class="attr">out</span>
253             
254             
255             
256              <span class="attr">type:</span> <span class="value">2d array</span>
257             
258             
259            </h4>
260       
261          <div class="comments">
262 sinus of the angle between grid lines at F points and direction of the North pole
263</div>
264           
265
266         
267
268         
269
270            <h3>Keywords</h3>
271           
272            <h4 id="_angle_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
273             
274             
275             
276             
277             
278              <span class="attr">type:</span> <span class="value">scalar string</span>
279              <span class="attr">default:</span> <span class="value">''</span>
280             
281            </h4>
282       
283            <div class="comments">
284 the directory path where is located fileocemesh
285</div>
286           
287            <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
288             
289             
290             
291             
292             
293              <span class="attr">type:</span> <span class="value">1 or 0</span>
294              <span class="attr">default:</span> <span class="value">0</span>
295             
296            </h4>
297       
298            <div class="comments">
299 put 1 to use double precision (default is float)
300</div>
301           
302         
303
304         
305          <h3>Version history</h3>
306         
307          <h4>Version</h4><div class="preformat">
308 $Id: angle.pro 327 2007-12-13 16:22:35Z pinsard $
309</div>
310          <h4>History</h4><div class="preformat">
311       Original :  96-07 (O. Marti)
312                   98-06 (G. Madec)
313       Feb 2005: IDL adaptation S. Masson
314       May 2007: F points + call to <a href="..//Interpolation/lbcorca.html">lbcorca</a>
315</div>
316         
317         
318          <h3>Known issues</h3>
319         
320         
321         
322          <h4>Restrictions</h4><div class="preformat">
323 to compute the lateral boundary conditions, we assume that:
324     (1) the first line is similar to the second line
325       =>    gcosu[*, 0] = gcosu[*, 1]
326       =>    gsinu[*, 0] = gsinu[*, 1]
327     (2) the grid follows OPA x and north pole periodicity rule (see <a href="..//Interpolation/lbcorca.html">lbcorca</a>)
328</div>
329       
330         
331         
332         
333         
334         
335         
336         
337       
338          <h3>Statistics</h3>
339          <table class="statistics">
340            <tr><td>McCabe cyclic</td><td>           9</td></tr>
341            <tr><td>McCabe essential</td><td>           1</td></tr>
342            <tr><td>McCabe modular design</td><td>           1</td></tr>
343          </table>
344         
345       
346        </div>
347       
348      </div>
349
350     
351
352      <div id="tagline">Produced by IDLdoc 2.0.</div>
353
354    </div>
355
356  </body>
357</html>
Note: See TracBrowser for help on using the repository browser.