| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>domdef.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="decoupeterre.html"><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="f2v.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ToBeReviewed/GRILLE/</font></h1> |
|---|
| 58 | <h2>domdef.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | Allows to extract a sub-domain of study by providing parameters |
|---|
| 65 | needed for drawings (see outputs) |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | |
|---|
| 71 | <a name="#_domdef"></a> |
|---|
| 72 | |
|---|
| 73 | <h2>domdef <font size="-1" color="#006633"> |
|---|
| 74 | </font></h2> |
|---|
| 75 | |
|---|
| 76 | <p><font face="Courier">domdef<i>[, <a href="#_domdef_keyword_x1">x1</a>][, <a href="#_domdef_keyword_x2">x2</a>][, <a href="#_domdef_keyword_y1">y1</a>][, <a href="#_domdef_keyword_y2">y2</a>][, <a href="#_domdef_keyword_z1">z1</a>][, <a href="#_domdef_keyword_z2">z2</a>]</i>, <a href="#_domdef_keyword_FINDALWAYS">FINDALWAYS</a>=<i>FINDALWAYS</i>, <a href="#_domdef_keyword_GRIDTYPE">GRIDTYPE</a>=<i>string or vector</i>, <a href="#_domdef_keyword_MEMEINDICES">MEMEINDICES</a>=<i>MEMEINDICES</i>, <a href="#_domdef_keyword_XINDEX">XINDEX</a>=<i>XINDEX</i>, <a href="#_domdef_keyword_YINDEX">YINDEX</a>=<i>YINDEX</i>, <a href="#_domdef_keyword_ZINDEX">ZINDEX</a>=<i>ZINDEX</i>, <a href="#_domdef_keyword_ENDPOINTS">ENDPOINTS</a>=<i>vector</i>, <a href="#_domdef_keyword_TYPE">TYPE</a>=<i>TYPE</i>, <a href="#_domdef_keyword_INDEX">INDEX</a>=<i>INDEX</i>, <a href="#_domdef_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p> |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | |
|---|
| 84 | <h3>Parameters</h3> |
|---|
| 85 | |
|---|
| 86 | |
|---|
| 87 | <a name="#_domdef_keyword_x1"></a> |
|---|
| 88 | <h4>x1 |
|---|
| 89 | <font size="-1" color="#006633">in</font> |
|---|
| 90 | |
|---|
| 91 | <font size="-1" color="#006633">optional</font> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | </h4> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | Define the minimum longitude. (All levels are selected) |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <a name="#_domdef_keyword_x2"></a> |
|---|
| 105 | <h4>x2 |
|---|
| 106 | <font size="-1" color="#006633">in</font> |
|---|
| 107 | |
|---|
| 108 | <font size="-1" color="#006633">optional</font> |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | </h4> |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | Define the maximum longitude. (All levels are selected) |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | <a name="#_domdef_keyword_y1"></a> |
|---|
| 122 | <h4>y1 |
|---|
| 123 | <font size="-1" color="#006633">in</font> |
|---|
| 124 | |
|---|
| 125 | <font size="-1" color="#006633">optional</font> |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | </h4> |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | Define the minimum latitude. (All levels are selected) |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | <a name="#_domdef_keyword_y2"></a> |
|---|
| 139 | <h4>y2 |
|---|
| 140 | <font size="-1" color="#006633">in</font> |
|---|
| 141 | |
|---|
| 142 | <font size="-1" color="#006633">optional</font> |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | </h4> |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | Define the maximum latitude. (All levels are selected) |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | <a name="#_domdef_keyword_z1"></a> |
|---|
| 156 | <h4>z1 |
|---|
| 157 | <font size="-1" color="#006633">in</font> |
|---|
| 158 | |
|---|
| 159 | <font size="-1" color="#006633">optional</font> |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | </h4> |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | For a 3d domain whose the horizontal part cover all glam |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | |
|---|
| 172 | <a name="#_domdef_keyword_z2"></a> |
|---|
| 173 | <h4>z2 |
|---|
| 174 | <font size="-1" color="#006633">in</font> |
|---|
| 175 | |
|---|
| 176 | <font size="-1" color="#006633">optional</font> |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | </h4> |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | For a 3d domain whose the horizontal part cover all gphi |
|---|
| 186 | |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | <h3>Keywords</h3> |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | <a name="#_domdef_keyword_FINDALWAYS"></a> |
|---|
| 195 | <h4>FINDALWAYS |
|---|
| 196 | |
|---|
| 197 | |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | |
|---|
| 204 | </h4> |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | Force to redefine a box even when none point is find in the box. |
|---|
| 208 | In this case, we select all the grid. |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | <a name="#_domdef_keyword_GRIDTYPE"></a> |
|---|
| 212 | <h4>GRIDTYPE |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string or vector</i></font> |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | </h4> |
|---|
| 222 | |
|---|
| 223 | |
|---|
| 224 | It is a string or a vector of strings containing the grids's name |
|---|
| 225 | (Only determined by 'T','U','V','W','F') for which the calculation |
|---|
| 226 | must be done. |
|---|
| 227 | For example: 'T' or ['T','U'] |
|---|
| 228 | |
|---|
| 229 | |
|---|
| 230 | <a name="#_domdef_keyword_MEMEINDICES"></a> |
|---|
| 231 | <h4>MEMEINDICES |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | </h4> |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | It is possible that points t,u,v and F correspond to a same geographic |
|---|
| 244 | box which do not concern the same array indexes. This is sometimes a |
|---|
| 245 | problem (or at least serious complications) in programs where several |
|---|
| 246 | type of grid intervene (see norme, curl...). Activate MEMEINDICE to |
|---|
| 247 | force domdef to take same indexes -those of the grid T- for all other |
|---|
| 248 | grids. |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | <a name="#_domdef_keyword_XINDEX"></a> |
|---|
| 252 | <h4>XINDEX |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | </h4> |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | We activate it if we want that all elements passed in input of domdef |
|---|
| 265 | and concerning the X dimension refer to indexes of glam arrays rather |
|---|
| 266 | than to values of these arrays. |
|---|
| 267 | |
|---|
| 268 | |
|---|
| 269 | <a name="#_domdef_keyword_YINDEX"></a> |
|---|
| 270 | <h4>YINDEX |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | </h4> |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | We activate it if we want that all elements passed in input of domdef |
|---|
| 283 | and concerning the X dimension refer to indexes of gphi arrays rather |
|---|
| 284 | than to values of these arrays. |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | <a name="#_domdef_keyword_ZINDEX"></a> |
|---|
| 288 | <h4>ZINDEX |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | |
|---|
| 293 | |
|---|
| 294 | |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | </h4> |
|---|
| 298 | |
|---|
| 299 | |
|---|
| 300 | We activate it if we want that all elements passed in input of domdef |
|---|
| 301 | and concerning the X dimension refer to indexes of gdep arrays rather |
|---|
| 302 | than to values of these arrays. |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | <a name="#_domdef_keyword_ENDPOINTS"></a> |
|---|
| 306 | <h4>ENDPOINTS |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>vector</i></font> |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | </h4> |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | A four elements vector [x1,y1,x2,y2] used to specify |
|---|
| 319 | that domdef must define the box used to make a plot (pltz, pltt, |
|---|
| 320 | plt1d) done strictly along the line (that can have any direction) |
|---|
| 321 | starting at (x1, y1) ending at (x2, y2). When defining endpoints, |
|---|
| 322 | you must also define TYPE which define the type of plots |
|---|
| 323 | ('pltz', 'xt', 'yt', 'zt', 'x', 'y', 'z', 't') will used |
|---|
| 324 | ENDPOINTS keywords |
|---|
| 325 | |
|---|
| 326 | |
|---|
| 327 | <a name="#_domdef_keyword_TYPE"></a> |
|---|
| 328 | <h4>TYPE |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | </h4> |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | |
|---|
| 341 | <a name="#_domdef_keyword_INDEX"></a> |
|---|
| 342 | <h4>INDEX |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | </h4> |
|---|
| 352 | |
|---|
| 353 | |
|---|
| 354 | We activate it if we want that all elements passed in input of domdef |
|---|
| 355 | refer to indexes of glam, gphi and gdep arrays rather than to values |
|---|
| 356 | of these arrays. |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | <a name="#_domdef_keyword__EXTRA"></a> |
|---|
| 360 | <h4>_EXTRA |
|---|
| 361 | |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | |
|---|
| 369 | </h4> |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | </pre><h3>Version history</h3> |
|---|
| 377 | |
|---|
| 378 | <h4>Version</h4> |
|---|
| 379 | $Id: domdef.pro 240 2007-03-28 12:17:24Z pinsard $ |
|---|
| 380 | |
|---|
| 381 | <h4>History</h4> |
|---|
| 382 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
|---|
| 383 | 8/2/98 |
|---|
| 384 | rewrite everything, debug and spee-up Sebastien Masson April 2005 |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | |
|---|
| 388 | <h3>Known issues</h3> |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | <h4>Todo items</h4> |
|---|
| 392 | seb: output pas clair/ pas d'input required? |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | <h3>Other attributes</h3> |
|---|
| 396 | |
|---|
| 397 | |
|---|
| 398 | <h4>Uses routines</h4> |
|---|
| 399 | common.pro |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | <font size="-3"><p> </p></font> |
|---|
| 406 | <hr size="1" color="#CCCCCC"/> |
|---|
| 407 | |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 412 | |
|---|
| 413 | </body> |
|---|
| 414 | </html> |
|---|
