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

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 10.5 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="restoreboxparam.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"> read NetCDF grid file created by ROMS
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_ncdf_meshroms">
104
105          <h2><a class="top" href="#container">top</a>ncdf_meshroms <span class="categories"> 
106 Grid
107</span></h2>
108       
109          <p class="header">
110            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>
111       
112          <div class="comments">
113</div>
114
115         
116
117         
118            <h3>Parameters</h3>
119       
120           
121            <h4 id="_ncdf_meshroms_param_filename">filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
122              <span class="attr">in</span>
123             
124              <span class="attr">optional</span>
125             
126             
127              <span class="attr">type:</span> <span class="value">scalar string</span>
128              <span class="attr">default:</span> <span class="value">'roms_grd.nc'</span>
129             
130            </h4>
131       
132          <div class="comments">
133    Name of the meshmask file to read. If this name does not contain any "/"
134    and if iodirectory keyword is not specify, then the common variable
135    iodir will be use to define the mesh file path.
136</div>
137           
138
139         
140
141         
142
143            <h3>Keywords</h3>
144           
145            <h4 id="_ncdf_meshroms_keyword_NRHO">NRHO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
146             
147             
148             
149             
150             
151              <span class="attr">type:</span> <span class="value">scalar</span>
152              <span class="attr">default:</span> <span class="value">1</span>
153             
154            </h4>
155       
156            <div class="comments">
157    Specify the number of rho level that contain the data we want to explore.
158    This is mainly useful when using xxx to get access to the depper levers and vertical sections.
159</div>
160           
161            <h4 id="_ncdf_meshroms_keyword_GLAMBOUNDARY">GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167              <span class="attr">type:</span> <span class="value">2 elements vector</span>
168              <span class="attr">default:</span> <span class="value">those defined in the file</span>
169             
170            </h4>
171       
172            <div class="comments">
173    Longitude boundaries that should be used to visualize the data.
174      lon2 > lon1
175      lon2 - lon1 le 360
176    By default, the common (cm_4mesh) variable key_shift will be automatically
177    defined according to GLAMBOUNDARY.
178</div>
179           
180            <h4 id="_ncdf_meshroms_keyword_ONEARTH">ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
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>
188             
189            </h4>
190       
191            <div class="comments">
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
197    ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY
198</div>
199           
200            <h4 id="_ncdf_meshroms_keyword_GETDIMENSIONS">GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
201             
202             
203             
204             
205             
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>
208             
209            </h4>
210       
211            <div class="comments">
212    Activate this keywords if you only want to know the dimension
213    of the domain stored in the mesh file. This dimensions will be
214    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
215</div>
216           
217            <h4 id="_ncdf_meshroms_keyword_PERIODIC">PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218             
219             
220             
221             
222             
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>
225             
226            </h4>
227       
228            <div class="comments">
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
231    PERIODIC = 0 forces SHIFT = 0
232</div>
233           
234            <h4 id="_ncdf_meshroms_keyword_SHIFT">SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
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>
242             
243            </h4>
244       
245            <div class="comments">
246    Force the manual definition of the zonal shift that must be apply to the data.
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.
249</div>
250           
251            <h4 id="_ncdf_meshroms_keyword_STRIDE">STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
252             
253             
254             
255             
256             
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>
259             
260            </h4>
261       
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
265</div>
266           
267            <h4 id="_ncdf_meshroms_keyword_STRCALLING">STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268             
269             
270             
271             
272             
273              <span class="attr">type:</span> <span class="value">scalar string</span>
274             
275             
276            </h4>
277       
278            <div class="comments">
279    the calling command used to call computegrid (this is used by xxx.pro)
280</div>
281           
282            <h4 id="_ncdf_meshroms_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
283             
284             
285             
286             
287             
288             
289             
290             
291            </h4>
292       
293            <div class="comments"> used to pass isafile keywords
294</div>
295           
296         
297
298          <h3>Examples</h3><div class="preformat">
299 IDL> ncdf_meshroms [,' filename']
300</div>
301          <h3>Version history</h3>
302         
303          <h4>Version</h4><div class="preformat"> $Id: ncdf_meshroms.pro 173 2006-09-11 07:53:02Z smasson $
304</div>
305          <h4>History</h4><div class="preformat"> Sebastien Masson (smasson@lodyc.jussieu.fr) September 2006
306</div>
307         
308         
309          <h3>Known issues</h3>
310         
311         
312         
313          <h4>Restrictions</h4><div class="preformat">
314
315  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
316  be defined before calling ncdf_meshread. if some of those value
317  are equal to -1 they will be automatically defined
318
319  In the original ROMS grid, if F grid has (jpi,jpj) points then T
320  grid will have (jpi+1,jpj+1) points, U grid will have (jpi,jpj+1)
321  points and V grid will have (jpi+1,jpj) points.
322  By default C-grid used in this package needs the same number of
323  points for T,U,V and F grid, with a T point at the bottom left
324  corner of the grid. We therefore ignore the last column of T and
325  V points and the last line of T and U points.
326
327  Scale factors are compuited using the distance between the points
328  (which is not the exact definition for irregulare grid).
329</div>
330       
331          <h3>Other attributes</h3>
332         
333         
334          <h4>Uses routines</h4><div class="preformat"> cm_4mesh cm_4data cm_4cal
335</div>
336         
337         
338         
339       
340          <h3>Statistics</h3>
341          <table class="statistics">
342            <tr><td>McCabe cyclic</td><td>          72</td></tr>
343            <tr><td>McCabe essential</td><td>           1</td></tr>
344            <tr><td>McCabe modular design</td><td>           1</td></tr>
345          </table>
346         
347       
348        </div>
349       
350      </div>
351
352     
353
354      <div id="tagline">Produced by IDLdoc 2.0.</div>
355
356    </div>
357
358  </body>
359</html>
Note: See TracBrowser for help on using the repository browser.