source: trunk/SRC/Documentation/idldoc_assistant_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: 7.9 KB
RevLine 
[163]1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>angle.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href=""><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="clickincell.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Interpolation/</font></h1>
58    <h2>angle.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 north stereographic polar projection
65
[242]66
[203]67 Compute angles between grid lines and direction of the North pole
[163]68(fom angle.F,v 2.2 in OPA8.2)
69
70
71   
72
73     
[203]74      <a name="#_angle"></a>
[163]75
[234]76      <h2>angle  <font size="-1" color="#006633">
[163]77 Interpolation
78</font></h2>
79
[249]80      <p><font face="Courier">angle<i>, <a href="#_angle_keyword_fileocemesh">fileocemesh</a>, <a href="#_angle_keyword_gcosu">gcosu</a>, <a href="#_angle_keyword_gsinu">gsinu</a>, <a href="#_angle_keyword_gcosv">gcosv</a>, <a href="#_angle_keyword_gsinv">gsinv</a>, <a href="#_angle_keyword_gcost">gcost</a>, <a href="#_angle_keyword_gsint">gsint</a>, <a href="#_angle_keyword_gcosf">gcosf</a>, <a href="#_angle_keyword_gsinf">gsinf</a></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>scalar string</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>1 or 0</i></font></p>
[163]81
82   
83
[242]84
[163]85   
86
87   
88    <h3>Parameters</h3>
89   
90
91    <a name="#_angle_keyword_fileocemesh"></a>
92    <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
93      <font size="-1" color="#006633">in</font>
94     
95     
96      <font size="-1" color="#006633">required</font>
97     
[203]98      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
[163]99     
100     
101    </h4>
102
[203]103   
104 a netcdf file that contains (at least) the following variables:
[249]105        glamt, gphit: longitudes and latitudes at T-points
[163]106        glamu, gphiu: longitudes and latitudes at U-points
107        glamv, gphiv: longitudes and latitudes at V-points
108        glamf, gphif: longitudes and latitudes at F-points
109
110   
111
112    <a name="#_angle_keyword_gcosu"></a>
113    <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
114     
[203]115      <font size="-1" color="#006633">out</font>
[163]116     
117     
118     
[203]119      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]120     
121     
122    </h4>
123
124   
[203]125 cosinus of the angle between grid lines at U points and direction of the North pole
126
[163]127   
128
129    <a name="#_angle_keyword_gsinu"></a>
130    <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
[203]132      <font size="-1" color="#006633">out</font>
[163]133     
134     
135     
[203]136      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]137     
138     
139    </h4>
140
141   
[203]142 sinus of the angle between grid lines at U points and direction of the North pole
143
[163]144   
145
146    <a name="#_angle_keyword_gcosv"></a>
147    <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
[203]149      <font size="-1" color="#006633">out</font>
[163]150     
151     
152     
[203]153      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]154     
155     
156    </h4>
157
158   
[203]159 cosinus of the angle between grid lines at V points and direction of the North pole
160
[163]161   
162
163    <a name="#_angle_keyword_gsinv"></a>
164    <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165     
[203]166      <font size="-1" color="#006633">out</font>
[163]167     
168     
169     
[203]170      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]171     
172     
173    </h4>
174
175   
[203]176 sinus of the angle between grid lines at V points and direction of the North pole
177
[163]178   
179
180    <a name="#_angle_keyword_gcost"></a>
181    <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182     
[203]183      <font size="-1" color="#006633">out</font>
[163]184     
185     
186     
[203]187      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]188     
189     
190    </h4>
191
192   
[203]193 cosinus of the angle between grid lines at T points and direction of the North pole
194
[163]195   
196
197    <a name="#_angle_keyword_gsint"></a>
198    <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199     
[203]200      <font size="-1" color="#006633">out</font>
[163]201     
202     
203     
[203]204      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
[163]205     
206     
207    </h4>
208
209   
[203]210 sinus of the angle between grid lines at T points and direction of the North pole
211
[163]212   
[249]213
214    <a name="#_angle_keyword_gcosf"></a>
215    <h4>gcosf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
216     
217      <font size="-1" color="#006633">out</font>
218     
219     
220     
221      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
222     
223     
224    </h4>
225
[163]226   
[249]227 cosinus of the angle between grid lines at F points and direction of the North pole
[163]228
229   
[249]230
231    <a name="#_angle_keyword_gsinf"></a>
232    <h4>gsinf&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
233     
234      <font size="-1" color="#006633">out</font>
235     
236     
237     
238      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2d array</i></font>
239     
240     
241    </h4>
242
243   
244 sinus of the angle between grid lines at F points and direction of the North pole
245
246   
247   
248
249   
[163]250    <h3>Keywords</h3>
251
252   
253    <a name="#_angle_keyword_IODIRECTORY"></a>
254    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
255     
256     
257     
258     
259     
[203]260      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
261      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>''</i></font>
[163]262     
263    </h4>
264
265   
[203]266 the directory path where is located fileocemesh
267
268   
[163]269    <a name="#_angle_keyword_DOUBLE"></a>
270    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
271     
272     
273     
274     
275     
[249]276      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>1 or 0</i></font>
[163]277      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
278     
279    </h4>
280
281   
[203]282 put 1 to use double precision (default is float)
[163]283
284   
285   
[203]286
[163]287   
[234]288    </pre><h3>Version history</h3>
[163]289   
[234]290    <h4>Version</h4>
[338]291 $Id: angle.pro 327 2007-12-13 16:22:35Z pinsard $
[242]292
[203]293    <h4>History</h4>
294       Original :  96-07 (O. Marti)
295                   98-06 (G. Madec)
296       Feb 2005: IDL adaptation S. Masson
[290]297       May 2007: F points + call to <a href="..//Interpolation/lbcorca.html">lbcorca</a>
[203]298
[163]299   
300
[203]301    <h3>Known issues</h3>
[163]302   
303   
304   
[203]305    <h4>Restrictions</h4>
306 to compute the lateral boundary conditions, we assume that:
307     (1) the first line is similar to the second line
308       =>    gcosu[*, 0] = gcosu[*, 1]
309       =>    gsinu[*, 0] = gsinu[*, 1]
[290]310     (2) the grid follows OPA x and north pole periodicity rule (see <a href="..//Interpolation/lbcorca.html">lbcorca</a>)
[163]311
[203]312
[163]313   
314   
315   
316   
317   
318   
319   
320
321    <font size="-3"><p>&nbsp;</p></font>
322    <hr size="1" color="#CCCCCC"/>
323     
324
325   
326
[187]327    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]328
329  </body>
[249]330</html>
Note: See TracBrowser for help on using the repository browser.