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

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

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