source: trunk/SRC/Documentation/idldoc_assistant_output/Interpolation/angle.html @ 200

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

update idldoc documentation

File size: 7.7 KB
Line 
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
66 Compute angles between grid lines and direction of the North
67(fom angle.F,v 2.2 in OPA8.2)
68
69
70   
71    <h2>Routine summary</h2>
72
73    <dl>
74     
75      <dt><a href="#_fsnspp"><i>result = </i>fsnspp(<i>plam, pphi</i>, DOUBLE=<i>DOUBLE</i>)</a><dt>
76      <dd><font size="-1"></font></dd>
77     
78      <dt><a href="#_angle">angle<i>, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint</i>, IODIRECTORY=<i>IODIRECTORY</i>, DOUBLE=<i>DOUBLE</i></a><dt>
79      <dd><font size="-1"></font></dd>
80     
81    </dl>
82
83    <p>&nbsp;</p>
84   
85
86     
87      <a name="#_fsnspp"></a>
88
89      <h2>fsnspp  <font size="-1" color="#006633"> 
90 Interpolation
91</font></h2>
92
93      <p><font face="Courier"><i>result = </i>fsnspp(<i><a href="#_fsnspp_keyword_plam">plam</a>, <a href="#_fsnspp_keyword_pphi">pphi</a></i>, <a href="#_fsnspp_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i>)</font></p>
94
95   
96
97    <h3>Return value</h3>
98       gsinu,gcosu : sinus and cosinus of the angle
99       gsinv,gcosv   between north-south direction
100       gsint,gcost   and the j-direction of the mesh
101
102
103   
104    <h3>Parameters</h3>
105   
106
107    <a name="#_fsnspp_keyword_plam"></a>
108    <h4>plam&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
120
121   
122
123    <a name="#_fsnspp_keyword_pphi"></a>
124    <h4>pphi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
125      <font size="-1" color="#006633">in</font>
126     
127     
128      <font size="-1" color="#006633">required</font>
129     
130     
131     
132     
133    </h4>
134
135   
136
137   
138   
139
140   
141    <h3>Keywords</h3>
142
143   
144    <a name="#_fsnspp_keyword_DOUBLE"></a>
145    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146     
147     
148     
149     
150     
151     
152      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
153     
154    </h4>
155
156   
157 use double precision (default is float)
158
159   
160   
161
162   
163    <h3>Version history</h3>
164   
165    <h4>Version</h4> $Id: angle.pro 157 2006-08-21 09:01:50Z navarro $
166
167    <h4>History</h4>
168       Original :  96-07 (O. Marti)
169                   98-06 (G. Madec)
170       Feb 2005: IDL adaptation S. Masson
171
172   
173
174    <h3>Known issues</h3>
175   
176   
177   
178    <h4>Restrictions</h4>
179 to compute the lateral boundary conditions, we assume that:
180     (1) the first line is similar to the second line
181       =>    gcosu[*, 0] = gcosu[*, 1]
182       =>    gsinu[*, 0] = gsinu[*, 1]
183     (2) the grid follows OPA x periodicity rule, first column is
184     equal to the next to last column
185       =>    gcosv[0, *] = gcosv[jpj-2, *]
186       =>    gsinv[0, *] = gsinv[jpj-2, *]
187
188
189
190   
191   
192   
193   
194   
195   
196   
197
198    <font size="-3"><p>&nbsp;</p></font>
199    <hr size="1" color="#CCCCCC"/>
200     
201      <a name="#_angle"></a>
202
203      <h2>angle  </h2>
204
205      <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></i>, <a href="#_angle_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_angle_keyword_DOUBLE">DOUBLE</a>=<i>DOUBLE</i></font></p>
206
207   
208
209   
210
211   
212    <h3>Parameters</h3>
213   
214
215    <a name="#_angle_keyword_fileocemesh"></a>
216    <h4>fileocemesh&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217      <font size="-1" color="#006633">in</font>
218     
219     
220      <font size="-1" color="#006633">required</font>
221     
222     
223     
224     
225    </h4>
226
227     a netcdf file that contains (at least):
228        glamu, gphiu: longitudes and latitudes at U-points
229        glamv, gphiv: longitudes and latitudes at V-points
230        glamf, gphif: longitudes and latitudes at F-points
231
232   
233
234    <a name="#_angle_keyword_gcosu"></a>
235    <h4>gcosu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236      <font size="-1" color="#006633">in</font>
237     
238     
239      <font size="-1" color="#006633">required</font>
240     
241     
242     
243     
244    </h4>
245
246   
247   
248
249    <a name="#_angle_keyword_gsinu"></a>
250    <h4>gsinu&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251      <font size="-1" color="#006633">in</font>
252     
253     
254      <font size="-1" color="#006633">required</font>
255     
256     
257     
258     
259    </h4>
260
261   
262   
263
264    <a name="#_angle_keyword_gcosv"></a>
265    <h4>gcosv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
266      <font size="-1" color="#006633">in</font>
267     
268     
269      <font size="-1" color="#006633">required</font>
270     
271     
272     
273     
274    </h4>
275
276   
277   
278
279    <a name="#_angle_keyword_gsinv"></a>
280    <h4>gsinv&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
281      <font size="-1" color="#006633">in</font>
282     
283     
284      <font size="-1" color="#006633">required</font>
285     
286     
287     
288     
289    </h4>
290
291   
292   
293
294    <a name="#_angle_keyword_gcost"></a>
295    <h4>gcost&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
296      <font size="-1" color="#006633">in</font>
297     
298     
299      <font size="-1" color="#006633">required</font>
300     
301     
302     
303     
304    </h4>
305
306   
307   
308
309    <a name="#_angle_keyword_gsint"></a>
310    <h4>gsint&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
311      <font size="-1" color="#006633">in</font>
312     
313     
314      <font size="-1" color="#006633">required</font>
315     
316     
317     
318     
319    </h4>
320
321   
322   
323   
324
325   
326    <h3>Keywords</h3>
327
328   
329    <a name="#_angle_keyword_IODIRECTORY"></a>
330    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
331     
332     
333     
334     
335     
336     
337     
338     
339    </h4>
340
341     the directory path where is located fileocemesh
342   
343    <a name="#_angle_keyword_DOUBLE"></a>
344    <h4>DOUBLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
345     
346     
347     
348     
349     
350     
351      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
352     
353    </h4>
354
355     use double precision (default is float)
356   
357   
358
359   
360   
361   
362   
363   
364   
365
366   
367   
368   
369   
370   
371
372   
373   
374   
375   
376   
377   
378   
379
380    <font size="-3"><p>&nbsp;</p></font>
381    <hr size="1" color="#CCCCCC"/>
382     
383
384   
385
386    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
387
388  </body>
389</html>
Note: See TracBrowser for help on using the repository browser.