source: trunk/SRC/Documentation/idldoc_html_output/Grid/ncdf_meshroms.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 10.8 KB
Line 
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>ncdf_meshroms.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="ncdf_meshroms.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="../../../Grid//ncdf_meshroms.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="ncdf_meshread.html">&lt;&lt;prev file</a> | <a href="numbisland.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="ncdf_meshroms.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;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">Grid/</a></h1>
82      <h2 class="pro_file">ncdf_meshroms.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 read NetCDF grid file created by ROMS
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_ncdf_meshroms">
105
106          <h2><a class="top" href="#container">top</a>ncdf_meshroms <span class="categories">
107 Grid
108</span></h2>
109       
110          <p class="header">
111            ncdf_meshroms<span class="result">[, <a href="#_ncdf_meshroms_param_filename">filename</a>]</span>, <a href="#_ncdf_meshroms_keyword_NRHO">NRHO</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshroms_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<span class="result">2 elements vector</span>, <a href="#_ncdf_meshroms_keyword_ONEARTH">ONEARTH</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshroms_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshroms_keyword_PERIODIC">PERIODIC</a>=<span class="result">scalar: 0 or 1</span>, <a href="#_ncdf_meshroms_keyword_SHIFT">SHIFT</a>=<span class="result">scalar</span>, <a href="#_ncdf_meshroms_keyword_STRIDE">STRIDE</a>=<span class="result">3 elements vector</span>, <a href="#_ncdf_meshroms_keyword_STRCALLING">STRCALLING</a>=<span class="result">scalar string</span>, <a href="#_ncdf_meshroms_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_ncdf_meshroms_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125              <span class="attr">optional</span>
126             
127             
128              <span class="attr">type:</span> <span class="value">scalar string</span>
129              <span class="attr">default:</span> <span class="value">'roms_grd.nc'</span>
130             
131            </h4>
132       
133          <div class="comments">
134    Name of the meshmask file to read. If this name does not contain any "/"
135    and if iodirectory keyword is not specify, then the common variable
136    iodir will be used to define the mesh file path.
137</div>
138           
139
140         
141
142         
143
144            <h3>Keywords</h3>
145           
146            <h4 id="_ncdf_meshroms_keyword_NRHO">NRHO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147             
148             
149             
150             
151             
152              <span class="attr">type:</span> <span class="value">scalar</span>
153              <span class="attr">default:</span> <span class="value">1</span>
154             
155            </h4>
156       
157            <div class="comments">
158    Specify the number of rho level that contain the data we want to explore.
159    This is mainly useful when using <a href="..//ToBeReviewed/WIDGET/xxx.html">xxx</a> to get access to the deeper levers and vertical sections.
160</div>
161           
162            <h4 id="_ncdf_meshroms_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168              <span class="attr">type:</span> <span class="value">2 elements vector</span>
169              <span class="attr">default:</span> <span class="value">those defined in the file</span>
170             
171            </h4>
172       
173            <div class="comments">
174    Longitude boundaries that should be used to visualize the data.
175      lon2 > lon1
176      lon2 - lon1 le 360
177    By default, the common (cm_4mesh) variable key_shift will be automatically
178    defined according to GLAMBOUNDARY.
179</div>
180           
181            <h4 id="_ncdf_meshroms_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
188              <span class="attr">default:</span> <span class="value">1</span>
189             
190            </h4>
191       
192            <div class="comments">
193    Force the manual definition of data localization on the earth or not
194       0) if the data are not on the earth
195       1) if the data are on earth (in that case we can for example use
196          the labels 'longitude', 'latitude' in plots).
197    The resulting value will be stored in the common (cm_4mesh) variable key_onearth
198    ONEARTH=0 forces PERIODIC=0, SHIFT=0 and is cancelling GLAMBOUNDARY
199</div>
200           
201            <h4 id="_ncdf_meshroms_keyword_GETDIMENSIONS">GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
202             
203             
204             
205             
206             
207              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
208              <span class="attr">default:</span> <span class="value">0</span>
209             
210            </h4>
211       
212            <div class="comments">
213    Activate this keywords if you only want to know the dimension
214    of the domain stored in the mesh file. This dimension will be
215    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
216</div>
217           
218            <h4 id="_ncdf_meshroms_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220             
221             
222             
223             
224              <span class="attr">type:</span> <span class="value">scalar: 0 or 1</span>
225              <span class="attr">default:</span> <span class="value">computed by using the first line of glamt</span>
226             
227            </h4>
228       
229            <div class="comments">
230    Force the manual definition of the grid zonal periodicity.
231    The resulting value will be stored in the common (cm_4mesh) variable key_periodic
232    PERIODIC=0 forces SHIFT=0
233</div>
234           
235            <h4 id="_ncdf_meshroms_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
236             
237             
238             
239             
240             
241              <span class="attr">type:</span> <span class="value">scalar</span>
242              <span class="attr">default:</span> <span class="value">computed according to glamboundary</span>
243             
244            </h4>
245       
246            <div class="comments">
247    Force the manual definition of the zonal shift that must be apply to the data.
248    The resulting value will be stored in the common (cm_4mesh) variable key_shift
249    Note that if key_periodic=0 then in any case key_shift=0.
250</div>
251           
252            <h4 id="_ncdf_meshroms_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
253             
254             
255             
256             
257             
258              <span class="attr">type:</span> <span class="value">3 elements vector</span>
259              <span class="attr">default:</span> <span class="value">[1, 1, 1]</span>
260             
261            </h4>
262       
263            <div class="comments">
264    Specify the stride in x, y and z direction. The resulting
265    value will be stored in the common (cm_4mesh) variable key_stride
266</div>
267           
268            <h4 id="_ncdf_meshroms_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
269             
270             
271             
272             
273             
274              <span class="attr">type:</span> <span class="value">scalar string</span>
275             
276             
277            </h4>
278       
279            <div class="comments">
280    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>)
281</div>
282           
283            <h4 id="_ncdf_meshroms_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
284             
285             
286             
287             
288             
289             
290             
291             
292            </h4>
293       
294            <div class="comments">
295 Used to pass keywords to <a href="..//Utilities/isafile.html">isafile</a>
296</div>
297           
298         
299
300          <h3>Examples</h3><div class="preformat">
301
302   IDL> ncdf_meshroms [,' filename']
303</div>
304          <h3>Version history</h3>
305         
306          <h4>Version</h4><div class="preformat">
307 $Id: ncdf_meshroms.pro 371 2008-08-07 09:32:02Z pinsard $
308</div>
309          <h4>History</h4><div class="preformat">
310 Sebastien Masson (smasson@lodyc.jussieu.fr) September 2006
311</div>
312         
313         
314          <h3>Known issues</h3>
315         
316         
317         
318          <h4>Restrictions</h4><div class="preformat">
319 ixminmesh, ixmaxmesh, iyminmesh, iymaxmesh, izminmesh, izmaxmesh must
320 be defined before calling <a href="..//Grid/ncdf_meshread.html">ncdf_meshread</a>. If some of those values
321 are equal to -1 they will be automatically defined
322
323 In the original ROMS grid, if F grid has (jpi,jpj) points then T
324 grid will have (jpi+1,jpj+1) points, U grid will have (jpi,jpj+1)
325 points and V grid will have (jpi+1,jpj) points.
326 By default C-grid used in this package needs the same number of
327 points for T,U,V and F grid, with a T point at the bottom left
328 corner of the grid. We therefore ignore the last column of T and
329 V points and the last line of T and U points.
330
331 Scale factors are computed using the distance between the points
332 (which is not the exact definition for irregular grid).
333</div>
334       
335          <h3>Other attributes</h3>
336         
337         
338          <h4>Uses routines</h4><div class="preformat">
339 <a href="..//Commons/cm_4mesh.html">cm_4mesh</a>
340 <a href="..//Commons/cm_4data.html">cm_4data</a>
341 <a href="..//Commons/cm_4cal.html">cm_4cal</a>
342</div>
343         
344         
345         
346       
347          <h3>Statistics</h3>
348          <table class="statistics">
349            <tr><td>McCabe cyclic</td><td>          72</td></tr>
350            <tr><td>McCabe essential</td><td>           1</td></tr>
351            <tr><td>McCabe modular design</td><td>           1</td></tr>
352          </table>
353         
354       
355        </div>
356       
357      </div>
358
359     
360
361      <div id="tagline">Produced by IDLdoc 2.0.</div>
362
363    </div>
364
365  </body>
366</html>
Note: See TracBrowser for help on using the repository browser.