| 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 (IDLdoc API 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 (IDLdoc API documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td >Source</td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | <td >Etc</td> |
|---|
| 65 | |
|---|
| 66 | <td id="flexible">Developer documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | << prev file | <a href="clickincell.html">next file >></a> <a href="angle.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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?format=raw">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"></div> |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | <div id="routine_summary"> |
|---|
| 99 | <h2>Routine summary</h2> |
|---|
| 100 | |
|---|
| 101 | <dl> |
|---|
| 102 | |
|---|
| 103 | <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> |
|---|
| 104 | <dd> NAME:angle.</dd> |
|---|
| 105 | |
|---|
| 106 | <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> |
|---|
| 107 | <dd></dd> |
|---|
| 108 | |
|---|
| 109 | </dl> |
|---|
| 110 | </div> |
|---|
| 111 | |
|---|
| 112 | |
|---|
| 113 | <div id="routine_details"> |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | <div class="routine_details" id="_fsnspp"> |
|---|
| 117 | |
|---|
| 118 | <h2><a class="top" href="#container">top</a>fsnspp </h2> |
|---|
| 119 | |
|---|
| 120 | <p class="header"> |
|---|
| 121 | <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> |
|---|
| 122 | |
|---|
| 123 | <div class="comments"> |
|---|
| 124 | NAME:angle.pro (fom angle.F,v 2.2 in OPA8.2) |
|---|
| 125 | |
|---|
| 126 | PURPOSE:Compute angles between grid lines and direction of the North |
|---|
| 127 | |
|---|
| 128 | CALLING SEQUENCE: |
|---|
| 129 | angle, fileocemesh, gcosu, gsinu, gcosv, gsinv, gcost, gsint |
|---|
| 130 | |
|---|
| 131 | INPUTS: |
|---|
| 132 | fileocemesh a netcdf file that contains (at least): |
|---|
| 133 | glamu, gphiu: longitudes and latitudes at U-points |
|---|
| 134 | glamv, gphiv: longitudes and latitudes at V-points |
|---|
| 135 | glamf, gphif: longitudes and latitudes at F-points |
|---|
| 136 | |
|---|
| 137 | KEYWORD PARAMETERS: |
|---|
| 138 | |
|---|
| 139 | IODIRECTORY: the directory path where is located fileocemesh |
|---|
| 140 | |
|---|
| 141 | /DOUBLE: use double precision (default is float) |
|---|
| 142 | |
|---|
| 143 | OUTPUTS: |
|---|
| 144 | gsinu,gcosu : sinus and cosinus of the angle |
|---|
| 145 | gsinv,gcosv between north-south direction |
|---|
| 146 | gsint,gcost and the j-direction of the mesh |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | RESTRICTIONS: to compute the lateral boundary conditions, we assume |
|---|
| 150 | that: |
|---|
| 151 | (1) the first line is similar to the second line |
|---|
| 152 | => gcosu[*, 0] = gcosu[*, 1] |
|---|
| 153 | => gsinu[*, 0] = gsinu[*, 1] |
|---|
| 154 | (2) the grid follows OPA x periodicity rule, first column is |
|---|
| 155 | equal to the next to last column |
|---|
| 156 | => gcosv[0, *] = gcosv[jpj-2, *] |
|---|
| 157 | => gsinv[0, *] = gsinv[jpj-2, *] |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | MODIFICATION HISTORY: |
|---|
| 161 | -------------- |
|---|
| 162 | Original : 96-07 (O. Marti) |
|---|
| 163 | 98-06 (G. Madec) |
|---|
| 164 | Feb 2005: IDL adaptation S. Masson </div> |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | <h3>Parameters</h3> |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | <h4 id="_fsnspp_param_plam">plam |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | </h4> |
|---|
| 182 | |
|---|
| 183 | <div class="comments"></div> |
|---|
| 184 | |
|---|
| 185 | <h4 id="_fsnspp_param_pphi">pphi |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | </h4> |
|---|
| 195 | |
|---|
| 196 | <div class="comments"></div> |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | <h3>Keywords</h3> |
|---|
| 204 | |
|---|
| 205 | <h4 id="_fsnspp_keyword_DOUBLE">DOUBLE |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | </h4> |
|---|
| 215 | |
|---|
| 216 | <div class="comments"></div> |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | </div> |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | <div class="routine_details" id="_angle"> |
|---|
| 247 | |
|---|
| 248 | <h2><a class="top" href="#container">top</a>angle </h2> |
|---|
| 249 | |
|---|
| 250 | <p class="header"> |
|---|
| 251 | 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> |
|---|
| 252 | |
|---|
| 253 | <div class="comments"></div> |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | <h3>Parameters</h3> |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | <h4 id="_angle_param_fileocemesh">fileocemesh |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | </h4> |
|---|
| 271 | |
|---|
| 272 | <div class="comments"></div> |
|---|
| 273 | |
|---|
| 274 | <h4 id="_angle_param_gcosu">gcosu |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | </h4> |
|---|
| 284 | |
|---|
| 285 | <div class="comments"></div> |
|---|
| 286 | |
|---|
| 287 | <h4 id="_angle_param_gsinu">gsinu |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | </h4> |
|---|
| 297 | |
|---|
| 298 | <div class="comments"></div> |
|---|
| 299 | |
|---|
| 300 | <h4 id="_angle_param_gcosv">gcosv |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | </h4> |
|---|
| 310 | |
|---|
| 311 | <div class="comments"></div> |
|---|
| 312 | |
|---|
| 313 | <h4 id="_angle_param_gsinv">gsinv |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | |
|---|
| 322 | </h4> |
|---|
| 323 | |
|---|
| 324 | <div class="comments"></div> |
|---|
| 325 | |
|---|
| 326 | <h4 id="_angle_param_gcost">gcost |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | </h4> |
|---|
| 336 | |
|---|
| 337 | <div class="comments"></div> |
|---|
| 338 | |
|---|
| 339 | <h4 id="_angle_param_gsint">gsint |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | </h4> |
|---|
| 349 | |
|---|
| 350 | <div class="comments"></div> |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | <h3>Keywords</h3> |
|---|
| 358 | |
|---|
| 359 | <h4 id="_angle_keyword_IODIRECTORY">IODIRECTORY |
|---|
| 360 | |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | </h4> |
|---|
| 369 | |
|---|
| 370 | <div class="comments"></div> |
|---|
| 371 | |
|---|
| 372 | <h4 id="_angle_keyword_DOUBLE">DOUBLE |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | </h4> |
|---|
| 382 | |
|---|
| 383 | <div class="comments"></div> |
|---|
| 384 | |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | |
|---|
| 396 | |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | </div> |
|---|
| 411 | |
|---|
| 412 | </div> |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | |
|---|
| 416 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 417 | |
|---|
| 418 | </div> |
|---|
| 419 | |
|---|
| 420 | </body> |
|---|
| 421 | </html> |
|---|
