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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output

File size: 9.3 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 | <a href="#routine_summary">routine</a>&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
93(fom angle.F,v 2.2 in OPA8.2)
94</div>
95
96     
97
98     
99
100     
101
102     
103      <div id="routine_summary">               
104        <h2>Routine summary</h2>
105       
106        <dl>
107         
108          <dt><p><a href="#_fsnspp"><span class="result">result = </span>fsnspp(<span class="result">plam, pphi</span>, DOUBLE=<span class="result">DOUBLE</span>)</a></p><dt>
109          <dd></dd>     
110         
111          <dt><p><a href="#_angle">angle<span class="result">, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</span>, IODIRECTORY=<span class="result">IODIRECTORY</span>, DOUBLE=<span class="result">DOUBLE</span></a></p><dt>
112          <dd></dd>     
113               
114        </dl>
115      </div>
116     
117
118      <div id="routine_details">
119       
120
121        <div class="routine_details" id="_fsnspp">
122
123          <h2><a class="top" href="#container">top</a>fsnspp <span class="categories"> 
124 Interpolation
125</span></h2>
126       
127          <p class="header">
128            <span class="result">result = </span>fsnspp(<span class="result"><a href="#_fsnspp_param_plam">plam</a>, <a href="#_fsnspp_param_pphi">pphi</a></span>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span>)</p>
129       
130          <div class="comments"></div>
131
132          <h3>Return value</h3><div class="preformat">
133       gsinu,gcosu : sinus and cosinus of the angle
134       gsinv,gcosv   between north-south direction
135       gsint,gcost   and the j-direction of the mesh
136</div>
137
138         
139            <h3>Parameters</h3>
140       
141           
142            <h4 id="_fsnspp_param_plam">plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143              <span class="attr">in</span>
144             
145             
146              <span class="attr">required</span>
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments">
154</div>
155           
156            <h4 id="_fsnspp_param_pphi">pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157              <span class="attr">in</span>
158             
159             
160              <span class="attr">required</span>
161             
162             
163             
164             
165            </h4>
166       
167          <div class="comments">
168</div>
169           
170
171         
172
173         
174
175            <h3>Keywords</h3>
176           
177            <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184              <span class="attr">default:</span> <span class="value">0</span>
185             
186            </h4>
187       
188            <div class="comments">
189 use double precision (default is float)
190</div>
191           
192         
193
194         
195          <h3>Version history</h3>
196         
197          <h4>Version</h4><div class="preformat"> $Id: angle.pro 157 2006-08-21 09:01:50Z navarro $
198</div>
199          <h4>History</h4><div class="preformat">
200       Original :  96-07 (O. Marti)
201                   98-06 (G. Madec)
202       Feb 2005: IDL adaptation S. Masson
203</div>
204         
205         
206          <h3>Known issues</h3>
207         
208         
209         
210          <h4>Restrictions</h4><div class="preformat">
211 to compute the lateral boundary conditions, we assume that:
212     (1) the first line is similar to the second line
213       =>    gcosu[*, 0] = gcosu[*, 1]
214       =>    gsinu[*, 0] = gsinu[*, 1]
215     (2) the grid follows OPA x periodicity rule, first column is
216     equal to the next to last column
217       =>    gcosv[0, *] = gcosv[jpj-2, *]
218       =>    gsinv[0, *] = gsinv[jpj-2, *]
219
220</div>
221       
222         
223         
224         
225         
226         
227         
228         
229       
230          <h3>Statistics</h3>
231          <table class="statistics">
232            <tr><td>McCabe cyclic</td><td>           2</td></tr>
233            <tr><td>McCabe essential</td><td>           1</td></tr>
234            <tr><td>McCabe modular design</td><td>           1</td></tr>
235          </table>
236         
237       
238        </div>
239       
240
241        <div class="routine_details" id="_angle">
242
243          <h2><a class="top" href="#container">top</a>angle </h2>
244       
245          <p class="header">
246            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">IODIRECTORY</span>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<span class="result">DOUBLE</span></p>
247       
248          <div class="comments"></div>
249
250         
251
252         
253            <h3>Parameters</h3>
254       
255           
256            <h4 id="_angle_param_fileocemesh">fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257              <span class="attr">in</span>
258             
259             
260              <span class="attr">required</span>
261             
262             
263             
264             
265            </h4>
266       
267          <div class="comments"> a netcdf file that contains (at least):
268        glamu, gphiu: longitudes and latitudes at U-points
269        glamv, gphiv: longitudes and latitudes at V-points
270        glamf, gphif: longitudes and latitudes at F-points
271</div>
272           
273            <h4 id="_angle_param_gcosu">gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
274              <span class="attr">in</span>
275             
276             
277              <span class="attr">required</span>
278             
279             
280             
281             
282            </h4>
283       
284          <div class="comments"></div>
285           
286            <h4 id="_angle_param_gsinu">gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
287              <span class="attr">in</span>
288             
289             
290              <span class="attr">required</span>
291             
292             
293             
294             
295            </h4>
296       
297          <div class="comments"></div>
298           
299            <h4 id="_angle_param_gcosv">gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
300              <span class="attr">in</span>
301             
302             
303              <span class="attr">required</span>
304             
305             
306             
307             
308            </h4>
309       
310          <div class="comments"></div>
311           
312            <h4 id="_angle_param_gsinv">gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
313              <span class="attr">in</span>
314             
315             
316              <span class="attr">required</span>
317             
318             
319             
320             
321            </h4>
322       
323          <div class="comments"></div>
324           
325            <h4 id="_angle_param_gcost">gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
326              <span class="attr">in</span>
327             
328             
329              <span class="attr">required</span>
330             
331             
332             
333             
334            </h4>
335       
336          <div class="comments"></div>
337           
338            <h4 id="_angle_param_gsint">gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
339              <span class="attr">in</span>
340             
341             
342              <span class="attr">required</span>
343             
344             
345             
346             
347            </h4>
348       
349          <div class="comments"></div>
350           
351
352         
353
354         
355
356            <h3>Keywords</h3>
357           
358            <h4 id="_angle_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
359             
360             
361             
362             
363             
364             
365             
366             
367            </h4>
368       
369            <div class="comments"> the directory path where is located fileocemesh</div>
370           
371            <h4 id="_angle_keyword_DOUBLE">DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
372             
373             
374             
375             
376             
377             
378              <span class="attr">default:</span> <span class="value">0</span>
379             
380            </h4>
381       
382            <div class="comments"> use double precision (default is float)</div>
383           
384         
385
386         
387         
388         
389         
390         
391         
392         
393         
394         
395         
396         
397         
398       
399         
400         
401         
402         
403         
404         
405         
406       
407          <h3>Statistics</h3>
408          <table class="statistics">
409            <tr><td>McCabe cyclic</td><td>           7</td></tr>
410            <tr><td>McCabe essential</td><td>           1</td></tr>
411            <tr><td>McCabe modular design</td><td>           1</td></tr>
412          </table>
413         
414       
415        </div>
416       
417      </div>
418
419     
420
421      <div id="tagline">Produced by IDLdoc 2.0.</div>
422
423    </div>
424
425  </body>
426</html>
Note: See TracBrowser for help on using the repository browser.