| 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>domdef.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="domdef.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="../../../../ToBeReviewed/GRILLE//domdef.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 documentation</td> |
|---|
| 67 | </tr> |
|---|
| 68 | </table> |
|---|
| 69 | |
|---|
| 70 | </div> |
|---|
| 71 | |
|---|
| 72 | <div id="secondary_navbar"> |
|---|
| 73 | |
|---|
| 74 | <a href="decoupeterre.html"><<prev file</a> | <a href="f2v.html">next file >></a> <a href="domdef.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | routine 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">ToBeReviewed/GRILLE/</a></h1> |
|---|
| 82 | <h2 class="pro_file">domdef.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Allows to extract a sub-domain of study by providing parameters |
|---|
| 91 | needed for drawings (see outputs) |
|---|
| 92 | </div> |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | <div id="routine_details"> |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | <div class="routine_details" id="_domdef"> |
|---|
| 106 | |
|---|
| 107 | <h2><a class="top" href="#container">top</a>domdef <span class="categories"> |
|---|
| 108 | Grid |
|---|
| 109 | </span></h2> |
|---|
| 110 | |
|---|
| 111 | <p class="header"> |
|---|
| 112 | domdef<span class="result">[, <a href="#_domdef_param_x1">x1</a>][, <a href="#_domdef_param_x2">x2</a>][, <a href="#_domdef_param_y1">y1</a>][, <a href="#_domdef_param_y2">y2</a>][, <a href="#_domdef_param_z1">z1</a>][, <a href="#_domdef_param_z2">z2</a>]</span>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<span class="result">FINDALWAYS</span>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<span class="result">string or vector</span>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<span class="result">MEMEINDICES</span>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<span class="result">XINDEX</span>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<span class="result">YINDEX</span>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<span class="result">ZINDEX</span>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<span class="result">vector</span>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<span class="result">TYPE</span>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<span class="result">INDEX</span>, <a href="#_domdef_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
|---|
| 113 | |
|---|
| 114 | <div class="comments"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | <h3>Parameters</h3> |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | <h4 id="_domdef_param_x1">x1 |
|---|
| 124 | <span class="attr">in</span> |
|---|
| 125 | |
|---|
| 126 | <span class="attr">optional</span> |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | </h4> |
|---|
| 133 | |
|---|
| 134 | <div class="comments"> |
|---|
| 135 | Define the minimum longitude. (All levels are selected) |
|---|
| 136 | </div> |
|---|
| 137 | |
|---|
| 138 | <h4 id="_domdef_param_x2">x2 |
|---|
| 139 | <span class="attr">in</span> |
|---|
| 140 | |
|---|
| 141 | <span class="attr">optional</span> |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | </h4> |
|---|
| 148 | |
|---|
| 149 | <div class="comments"> |
|---|
| 150 | Define the maximum longitude. (All levels are selected) |
|---|
| 151 | </div> |
|---|
| 152 | |
|---|
| 153 | <h4 id="_domdef_param_y1">y1 |
|---|
| 154 | <span class="attr">in</span> |
|---|
| 155 | |
|---|
| 156 | <span class="attr">optional</span> |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | </h4> |
|---|
| 163 | |
|---|
| 164 | <div class="comments"> |
|---|
| 165 | Define the minimum latitude. (All levels are selected) |
|---|
| 166 | </div> |
|---|
| 167 | |
|---|
| 168 | <h4 id="_domdef_param_y2">y2 |
|---|
| 169 | <span class="attr">in</span> |
|---|
| 170 | |
|---|
| 171 | <span class="attr">optional</span> |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | </h4> |
|---|
| 178 | |
|---|
| 179 | <div class="comments"> |
|---|
| 180 | Define the maximum latitude. (All levels are selected) |
|---|
| 181 | </div> |
|---|
| 182 | |
|---|
| 183 | <h4 id="_domdef_param_z1">z1 |
|---|
| 184 | <span class="attr">in</span> |
|---|
| 185 | |
|---|
| 186 | <span class="attr">optional</span> |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | </h4> |
|---|
| 193 | |
|---|
| 194 | <div class="comments"> |
|---|
| 195 | For a 3d domain whose the horizontal part cover all glam |
|---|
| 196 | </div> |
|---|
| 197 | |
|---|
| 198 | <h4 id="_domdef_param_z2">z2 |
|---|
| 199 | <span class="attr">in</span> |
|---|
| 200 | |
|---|
| 201 | <span class="attr">optional</span> |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | </h4> |
|---|
| 208 | |
|---|
| 209 | <div class="comments"> |
|---|
| 210 | For a 3d domain whose the horizontal part cover all gphi |
|---|
| 211 | </div> |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | <h3>Keywords</h3> |
|---|
| 219 | |
|---|
| 220 | <h4 id="_domdef_keyword_FINDALWAYS">FINDALWAYS |
|---|
| 221 | |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | </h4> |
|---|
| 230 | |
|---|
| 231 | <div class="comments"> |
|---|
| 232 | Force to redefine a box even when none point is find in the box. |
|---|
| 233 | In this case, we select all the grid. |
|---|
| 234 | </div> |
|---|
| 235 | |
|---|
| 236 | <h4 id="_domdef_keyword_GRIDTYPE">GRIDTYPE |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | |
|---|
| 241 | |
|---|
| 242 | <span class="attr">type:</span> <span class="value">string or vector</span> |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | </h4> |
|---|
| 246 | |
|---|
| 247 | <div class="comments"> |
|---|
| 248 | It is a string or a vector of strings containing the grids's name |
|---|
| 249 | (Only determined by 'T','U','V','W','F') for which the calculation |
|---|
| 250 | must be done. |
|---|
| 251 | For example: 'T' or ['T','U'] |
|---|
| 252 | </div> |
|---|
| 253 | |
|---|
| 254 | <h4 id="_domdef_keyword_MEMEINDICES">MEMEINDICES |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | </h4> |
|---|
| 264 | |
|---|
| 265 | <div class="comments"> |
|---|
| 266 | It is possible that points T, U, V and F correspond to a same geographic |
|---|
| 267 | box which do not concern the same array indexes. This is sometimes a |
|---|
| 268 | problem (or at least serious complications) in programs where several |
|---|
| 269 | type of grid intervene (see <a href="../..//Obsolete/norme.html">norme</a>, <a href="../..//Computation/curl.html">curl</a>...). |
|---|
| 270 | Activate MEMEINDICES to force <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> to take same indexes - those |
|---|
| 271 | of the grid T- for all other grids. |
|---|
| 272 | </div> |
|---|
| 273 | |
|---|
| 274 | <h4 id="_domdef_keyword_XINDEX">XINDEX |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | </h4> |
|---|
| 284 | |
|---|
| 285 | <div class="comments"> |
|---|
| 286 | We activate it if we want that all elements passed in input of |
|---|
| 287 | <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> |
|---|
| 288 | and concerning the X dimension refer to indexes of glam arrays rather |
|---|
| 289 | than to values of these arrays. |
|---|
| 290 | </div> |
|---|
| 291 | |
|---|
| 292 | <h4 id="_domdef_keyword_YINDEX">YINDEX |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | |
|---|
| 301 | </h4> |
|---|
| 302 | |
|---|
| 303 | <div class="comments"> |
|---|
| 304 | We activate it if we want that all elements passed in input of |
|---|
| 305 | <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> |
|---|
| 306 | and concerning the X dimension refer to indexes of gphi arrays rather |
|---|
| 307 | than to values of these arrays. |
|---|
| 308 | </div> |
|---|
| 309 | |
|---|
| 310 | <h4 id="_domdef_keyword_ZINDEX">ZINDEX |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | |
|---|
| 319 | </h4> |
|---|
| 320 | |
|---|
| 321 | <div class="comments"> |
|---|
| 322 | We activate it if we want that all elements passed in input of |
|---|
| 323 | <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> |
|---|
| 324 | and concerning the X dimension refer to indexes of gdep arrays rather |
|---|
| 325 | than to values of these arrays. |
|---|
| 326 | </div> |
|---|
| 327 | |
|---|
| 328 | <h4 id="_domdef_keyword_ENDPOINTS">ENDPOINTS |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | <span class="attr">type:</span> <span class="value">vector</span> |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | </h4> |
|---|
| 338 | |
|---|
| 339 | <div class="comments"> |
|---|
| 340 | A four elements vector [x1,y1,x2,y2] used to specify |
|---|
| 341 | that <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> must define the box used to make a plot |
|---|
| 342 | (<a href="../..//ToBeReviewed/PLOTS/DESSINE/pltz.html">pltz</a>, <a href="../..//ToBeReviewed/PLOTS/DESSINE/pltt.html">pltt</a>, <a href="../..//ToBeReviewed/PLOTS/DESSINE/plt1d.html">plt1d</a>) done strictly along the line (that can have any direction) |
|---|
| 343 | starting at (x1, y1) ending at (x2, y2). When defining endpoints, |
|---|
| 344 | you must also define TYPE which define the type of plots |
|---|
| 345 | ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used |
|---|
| 346 | ENDPOINTS keywords |
|---|
| 347 | </div> |
|---|
| 348 | |
|---|
| 349 | <h4 id="_domdef_keyword_TYPE">TYPE |
|---|
| 350 | |
|---|
| 351 | |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | </h4> |
|---|
| 359 | |
|---|
| 360 | <div class="comments"> |
|---|
| 361 | </div> |
|---|
| 362 | |
|---|
| 363 | <h4 id="_domdef_keyword_INDEX">INDEX |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | </h4> |
|---|
| 373 | |
|---|
| 374 | <div class="comments"> |
|---|
| 375 | We activate it if we want that all elements passed in input of |
|---|
| 376 | <a href="../..//ToBeReviewed/GRILLE/domdef.html">domdef</a> refer to indexes of glam, gphi and gdep arrays rather |
|---|
| 377 | than to values of these arrays. |
|---|
| 378 | </div> |
|---|
| 379 | |
|---|
| 380 | <h4 id="_domdef_keyword__EXTRA">_EXTRA |
|---|
| 381 | |
|---|
| 382 | |
|---|
| 383 | |
|---|
| 384 | |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | </h4> |
|---|
| 390 | |
|---|
| 391 | <div class="comments"></div> |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | |
|---|
| 396 | <h3>Version history</h3> |
|---|
| 397 | |
|---|
| 398 | <h4>Version</h4><div class="preformat"> |
|---|
| 399 | $Id: domdef.pro 393 2009-02-20 15:39:43Z smasson $ |
|---|
| 400 | </div> |
|---|
| 401 | <h4>History</h4><div class="preformat"> |
|---|
| 402 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 403 | 8/2/98 |
|---|
| 404 | rewrite everything, debug and speed-up Sebastien Masson April 2005 |
|---|
| 405 | </div> |
|---|
| 406 | |
|---|
| 407 | |
|---|
| 408 | <h3>Known issues</h3> |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | <h4>Todo items</h4><div class="preformat"> |
|---|
| 412 | seb: output pas clair/ pas d'input required?</div> |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | <h3>Other attributes</h3> |
|---|
| 416 | |
|---|
| 417 | |
|---|
| 418 | <h4>Uses routines</h4><div class="preformat"> |
|---|
| 419 | <a href="../..//Obsolete/common.html">common</a> |
|---|
| 420 | </div> |
|---|
| 421 | |
|---|
| 422 | |
|---|
| 423 | |
|---|
| 424 | |
|---|
| 425 | <h3>Statistics</h3> |
|---|
| 426 | <table class="statistics"> |
|---|
| 427 | <tr><td>McCabe cyclic</td><td> 206</td></tr> |
|---|
| 428 | <tr><td>McCabe essential</td><td> 2</td></tr> |
|---|
| 429 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 430 | </table> |
|---|
| 431 | |
|---|
| 432 | |
|---|
| 433 | </div> |
|---|
| 434 | |
|---|
| 435 | </div> |
|---|
| 436 | |
|---|
| 437 | |
|---|
| 438 | |
|---|
| 439 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 440 | |
|---|
| 441 | </div> |
|---|
| 442 | |
|---|
| 443 | </body> |
|---|
| 444 | </html> |
|---|
