[89] | 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> |
---|
[104] | 9 | <title>ncdf_meshread.pro (SAXO Documentation)</title> |
---|
[89] | 10 | |
---|
| 11 | |
---|
[191] | 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" /> |
---|
[89] | 14 | |
---|
| 15 | |
---|
| 16 | <script type="text/javascript"> |
---|
| 17 | function setTitle() { |
---|
[104] | 18 | parent.document.title="ncdf_meshread.pro (SAXO Documentation)"; |
---|
[89] | 19 | } |
---|
| 20 | </script> |
---|
| 21 | </head> |
---|
| 22 | |
---|
| 23 | <body onload="setTitle();"> |
---|
| 24 | |
---|
| 25 | <div id="navbar_title"> |
---|
[104] | 26 | <h1>SAXO Documentation</h1> |
---|
[89] | 27 | </div> |
---|
| 28 | |
---|
| 29 | |
---|
| 30 | <div id="main_navbar"> |
---|
| 31 | |
---|
| 32 | <table cellspacing="0"> |
---|
| 33 | <tr> |
---|
| 34 | |
---|
[189] | 35 | <td><a href="./../overview.html" title="Overview of library">Overview</a></td> |
---|
[89] | 36 | |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | <td >Directory</td> |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | |
---|
[189] | 43 | <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
---|
[89] | 44 | |
---|
| 45 | |
---|
| 46 | |
---|
[189] | 47 | <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
---|
[89] | 48 | |
---|
| 49 | |
---|
| 50 | |
---|
[189] | 51 | <td><a href="./../search-page.html" title="Search library">Search</a></td> |
---|
[89] | 52 | |
---|
| 53 | |
---|
| 54 | <td id="selected">File</td> |
---|
| 55 | |
---|
| 56 | |
---|
[189] | 57 | <td><a href="../../../Grid//ncdf_meshread.pro" title="Source code of a file">Source</a></td> |
---|
[89] | 58 | |
---|
| 59 | |
---|
| 60 | |
---|
[189] | 61 | <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td> |
---|
[89] | 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 | |
---|
[189] | 74 | <a href="n80gaussian.html"><<prev file</a> | <a href="ncdf_meshroms.html">next file >></a> <a href="ncdf_meshread.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> |
---|
[89] | 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | <div id="container"> |
---|
| 80 | |
---|
[189] | 81 | <h1 class="directory"><a href="directory-overview.html">Grid/</a></h1> |
---|
[89] | 82 | <h2 class="pro_file">ncdf_meshread.pro</h2> |
---|
| 83 | |
---|
| 84 | <div id="file_attr"> |
---|
| 85 | <dl> |
---|
| 86 | </dl> |
---|
| 87 | </div> |
---|
| 88 | |
---|
[234] | 89 | <div id="file_comments"> |
---|
| 90 | read NetCDF meshmask file created by OPA |
---|
[103] | 91 | </div> |
---|
[89] | 92 | |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | |
---|
| 100 | |
---|
| 101 | <div id="routine_details"> |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | <div class="routine_details" id="_ncdf_meshread"> |
---|
| 105 | |
---|
[234] | 106 | <h2><a class="top" href="#container">top</a>ncdf_meshread <span class="categories"> |
---|
[157] | 107 | Grid |
---|
[103] | 108 | </span></h2> |
---|
[89] | 109 | |
---|
| 110 | <p class="header"> |
---|
[177] | 111 | ncdf_meshread<span class="result">[, <a href="#_ncdf_meshread_param_filename">filename</a>]</span>, <a href="#_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_ncdf_meshread_keyword_CHECKDAT">CHECKDAT</a>=<span class="result">CHECKDAT</span>, <a href="#_ncdf_meshread_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshread_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshread_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_ncdf_meshread_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_ncdf_meshread_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p> |
---|
[89] | 112 | |
---|
| 113 | <div class="comments"> |
---|
| 114 | </div> |
---|
| 115 | |
---|
| 116 | |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | <h3>Parameters</h3> |
---|
| 120 | |
---|
| 121 | |
---|
| 122 | <h4 id="_ncdf_meshread_param_filename">filename |
---|
[103] | 123 | <span class="attr">in</span> |
---|
[89] | 124 | |
---|
[103] | 125 | <span class="attr">optional</span> |
---|
[89] | 126 | |
---|
| 127 | |
---|
[177] | 128 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
| 129 | <span class="attr">default:</span> <span class="value">'meshmask.nc'</span> |
---|
[89] | 130 | |
---|
| 131 | </h4> |
---|
| 132 | |
---|
[177] | 133 | <div class="comments"> |
---|
| 134 | Name of the meshmask file to read. If this name does not contain any "/" |
---|
[321] | 135 | and if iodirectory keyword is not specified, then the common variable |
---|
[290] | 136 | iodir will be used to define the mesh file path. |
---|
[103] | 137 | </div> |
---|
[89] | 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | |
---|
| 144 | <h3>Keywords</h3> |
---|
| 145 | |
---|
| 146 | <h4 id="_ncdf_meshread_keyword_GLAMBOUNDARY">GLAMBOUNDARY |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
[177] | 152 | <span class="attr">type:</span> <span class="value">2 elements vector</span> |
---|
| 153 | <span class="attr">default:</span> <span class="value">those defined in the file</span> |
---|
[89] | 154 | |
---|
| 155 | </h4> |
---|
| 156 | |
---|
[177] | 157 | <div class="comments"> |
---|
| 158 | Longitude boundaries that should be used to visualize the data. |
---|
[103] | 159 | lon2 > lon1 |
---|
| 160 | lon2 - lon1 le 360 |
---|
[177] | 161 | By default, the common (cm_4mesh) variable key_shift will be automatically |
---|
| 162 | defined according to GLAMBOUNDARY. |
---|
[103] | 163 | </div> |
---|
[89] | 164 | |
---|
| 165 | <h4 id="_ncdf_meshread_keyword_CHECKDAT">CHECKDAT |
---|
| 166 | |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | |
---|
| 174 | </h4> |
---|
| 175 | |
---|
[234] | 176 | <div class="comments"> |
---|
[290] | 177 | Suppressed. Use <a href="..//Grid/micromeshmask.html">micromeshmask</a> to create an appropriate meshmask. |
---|
[103] | 178 | </div> |
---|
[89] | 179 | |
---|
| 180 | <h4 id="_ncdf_meshread_keyword_ONEARTH">ONEARTH |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | |
---|
| 184 | |
---|
| 185 | |
---|
[177] | 186 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 187 | <span class="attr">default:</span> <span class="value">1</span> |
---|
[89] | 188 | |
---|
| 189 | </h4> |
---|
| 190 | |
---|
[163] | 191 | <div class="comments"> |
---|
[177] | 192 | Force the manual definition of data localization on the earth or not |
---|
| 193 | 0) if the data are not on the earth |
---|
| 194 | 1) if the data are on earth (in that case we can for example use |
---|
| 195 | the labels 'longitude', 'latitude' in plots). |
---|
| 196 | The resulting value will be stored in the common (cm_4mesh) variable key_onearth |
---|
[338] | 197 | ONEARTH=0 forces PERIODIC=0, SHIFT=0 and is cancelling GLAMBOUNDARY |
---|
[103] | 198 | </div> |
---|
[89] | 199 | |
---|
| 200 | <h4 id="_ncdf_meshread_keyword_GETDIMENSIONS">GETDIMENSIONS |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | |
---|
[177] | 206 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 207 | <span class="attr">default:</span> <span class="value">0</span> |
---|
[89] | 208 | |
---|
| 209 | </h4> |
---|
| 210 | |
---|
[118] | 211 | <div class="comments"> |
---|
[157] | 212 | Activate this keywords if you only want to know the dimension |
---|
[290] | 213 | of the domain stored in the mesh file. This dimension will be |
---|
[157] | 214 | defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables) |
---|
[118] | 215 | </div> |
---|
[89] | 216 | |
---|
| 217 | <h4 id="_ncdf_meshread_keyword_PERIODIC">PERIODIC |
---|
| 218 | |
---|
| 219 | |
---|
| 220 | |
---|
| 221 | |
---|
| 222 | |
---|
[177] | 223 | <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span> |
---|
| 224 | <span class="attr">default:</span> <span class="value">computed by using the first line of glamt</span> |
---|
[89] | 225 | |
---|
| 226 | </h4> |
---|
| 227 | |
---|
[163] | 228 | <div class="comments"> |
---|
[177] | 229 | Force the manual definition of the grid zonal periodicity. |
---|
| 230 | The resulting value will be stored in the common (cm_4mesh) variable key_periodic |
---|
[338] | 231 | PERIODIC=0 forces SHIFT=0 |
---|
[103] | 232 | </div> |
---|
[89] | 233 | |
---|
| 234 | <h4 id="_ncdf_meshread_keyword_SHIFT">SHIFT |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | |
---|
| 238 | |
---|
| 239 | |
---|
[177] | 240 | <span class="attr">type:</span> <span class="value">scalar</span> |
---|
| 241 | <span class="attr">default:</span> <span class="value">computed according to glamboundary</span> |
---|
[89] | 242 | |
---|
| 243 | </h4> |
---|
| 244 | |
---|
[163] | 245 | <div class="comments"> |
---|
[234] | 246 | Force the manual definition of the zonal shift that must be apply to the data. |
---|
[177] | 247 | The resulting value will be stored in the common (cm_4mesh) variable key_shift |
---|
| 248 | Note that if key_periodic=0 then in any case key_shift = 0. |
---|
[103] | 249 | </div> |
---|
[89] | 250 | |
---|
| 251 | <h4 id="_ncdf_meshread_keyword_STRIDE">STRIDE |
---|
| 252 | |
---|
| 253 | |
---|
| 254 | |
---|
| 255 | |
---|
| 256 | |
---|
[177] | 257 | <span class="attr">type:</span> <span class="value">3 elements vector</span> |
---|
| 258 | <span class="attr">default:</span> <span class="value">[1, 1, 1]</span> |
---|
[89] | 259 | |
---|
| 260 | </h4> |
---|
| 261 | |
---|
[177] | 262 | <div class="comments"> |
---|
| 263 | Specify the stride in x, y and z direction. The resulting |
---|
| 264 | value will be stored in the common (cm_4mesh) variable key_stride |
---|
[103] | 265 | </div> |
---|
[89] | 266 | |
---|
| 267 | <h4 id="_ncdf_meshread_keyword_STRCALLING">STRCALLING |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | |
---|
[177] | 273 | <span class="attr">type:</span> <span class="value">scalar string</span> |
---|
[89] | 274 | |
---|
| 275 | |
---|
| 276 | </h4> |
---|
| 277 | |
---|
[163] | 278 | <div class="comments"> |
---|
[290] | 279 | the calling command used to call <a href="..//Grid/computegrid.html">computegrid</a> (this is used by <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a>) |
---|
[103] | 280 | </div> |
---|
[89] | 281 | |
---|
| 282 | <h4 id="_ncdf_meshread_keyword__EXTRA">_EXTRA |
---|
| 283 | |
---|
| 284 | |
---|
| 285 | |
---|
| 286 | |
---|
| 287 | |
---|
| 288 | |
---|
| 289 | |
---|
| 290 | |
---|
| 291 | </h4> |
---|
| 292 | |
---|
[234] | 293 | <div class="comments"> |
---|
[242] | 294 | Used to pass keywords to <a href="..//Utilities/isafile.html">isafile</a> |
---|
[118] | 295 | </div> |
---|
[89] | 296 | |
---|
| 297 | |
---|
| 298 | |
---|
[138] | 299 | <h3>Examples</h3><div class="preformat"> |
---|
[402] | 300 | |
---|
| 301 | IDL> ncdf_meshread [,' filename'] |
---|
[121] | 302 | </div> |
---|
[103] | 303 | <h3>Version history</h3> |
---|
[89] | 304 | |
---|
[234] | 305 | <h4>Version</h4><div class="preformat"> |
---|
[402] | 306 | $Id: ncdf_meshread.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
[118] | 307 | </div> |
---|
[234] | 308 | <h4>History</h4><div class="preformat"> |
---|
| 309 | Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
[103] | 310 | 12/1999 |
---|
| 311 | July 2004, Sebastien Masson: Several modifications (micromeshmask, |
---|
| 312 | clean partial steps, clean use of key_stride, automatic definition |
---|
| 313 | of key_shift, ...) |
---|
| 314 | Oct. 2004, Sebastien Masson: add PERIODIC and SHIFT |
---|
[121] | 315 | Aug. 2005, Sebastien Masson: some cleaning + english |
---|
[118] | 316 | </div> |
---|
[89] | 317 | |
---|
| 318 | |
---|
[103] | 319 | <h3>Known issues</h3> |
---|
[89] | 320 | |
---|
| 321 | |
---|
| 322 | |
---|
[177] | 323 | <h4>Restrictions</h4><div class="preformat"> |
---|
[290] | 324 | ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh must |
---|
| 325 | be defined before calling ncdf_meshread. If some of those values |
---|
[234] | 326 | are equal to -1 they will be automatically defined |
---|
[103] | 327 | </div> |
---|
[89] | 328 | |
---|
[103] | 329 | <h3>Other attributes</h3> |
---|
[89] | 330 | |
---|
| 331 | |
---|
[234] | 332 | <h4>Uses routines</h4><div class="preformat"> |
---|
[402] | 333 | <a href="..//Commons/cm_4mesh.html">cm_4mesh</a> |
---|
| 334 | <a href="..//Commons/cm_4data.html">cm_4data</a> |
---|
| 335 | <a href="..//Commons/cm_4cal.html">cm_4cal</a> |
---|
[103] | 336 | </div> |
---|
[89] | 337 | |
---|
| 338 | |
---|
| 339 | |
---|
| 340 | |
---|
[163] | 341 | <h3>Statistics</h3> |
---|
| 342 | <table class="statistics"> |
---|
[363] | 343 | <tr><td>McCabe cyclic</td><td> 99</td></tr> |
---|
[163] | 344 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
| 345 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
| 346 | </table> |
---|
[89] | 347 | |
---|
| 348 | |
---|
| 349 | </div> |
---|
| 350 | |
---|
| 351 | </div> |
---|
| 352 | |
---|
| 353 | |
---|
| 354 | |
---|
| 355 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 356 | |
---|
| 357 | </div> |
---|
| 358 | |
---|
| 359 | </body> |
---|
[249] | 360 | </html> |
---|