source: trunk/SRC/Documentation/idldoc_assistant_output/Grid/ncdf_meshroms.html @ 187

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

introducing hyperlinks in idldoc outputs (2/2)
File size: 9.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>ncdf_meshroms.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="ncdf_meshread.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="restoreboxparam.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Grid/</font></h1>
58    <h2>ncdf_meshroms.pro</h2>
59
60    <dl>
61    </dl>
62
63     read NetCDF grid file created by ROMS
64
65
66   
67
68     
69      <a name="#_ncdf_meshroms"></a>
70
71      <h2>ncdf_meshroms  <font size="-1" color="#006633"> 
72 Grid
73</font></h2>
74
75      <p><font face="Courier">ncdf_meshroms<i>[, <a href="#_ncdf_meshroms_keyword_filename">filename</a>]</i>, <a href="#_ncdf_meshroms_keyword_NRHO">NRHO</a>=<i>scalar</i>, <a href="#_ncdf_meshroms_keyword_GLAMBOUNDARY">GLAMBOUNDARY</a>=<i>2 elements vector</i>, <a href="#_ncdf_meshroms_keyword_ONEARTH">ONEARTH</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshroms_keyword_GETDIMENSIONS">GETDIMENSIONS</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshroms_keyword_PERIODIC">PERIODIC</a>=<i>scalar: 0 or 1</i>, <a href="#_ncdf_meshroms_keyword_SHIFT">SHIFT</a>=<i>scalar</i>, <a href="#_ncdf_meshroms_keyword_STRIDE">STRIDE</a>=<i>3 elements vector</i>, <a href="#_ncdf_meshroms_keyword_STRCALLING">STRCALLING</a>=<i>scalar string</i>, <a href="#_ncdf_meshroms_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
76
77   
78
79
80   
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_ncdf_meshroms_keyword_filename"></a>
87    <h4>filename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90      <font size="-1" color="#006633">optional</font>
91     
92     
93      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
94      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>'roms_grd.nc'</i></font>
95     
96    </h4>
97
98   
99    Name of the meshmask file to read. If this name does not contain any "/"
100    and if iodirectory keyword is not specify, then the common variable
101    iodir will be use to define the mesh file path.
102
103   
104   
105
106   
107    <h3>Keywords</h3>
108
109   
110    <a name="#_ncdf_meshroms_keyword_NRHO"></a>
111    <h4>NRHO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
112     
113     
114     
115     
116     
117      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
118      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
119     
120    </h4>
121
122   
123    Specify the number of rho level that contain the data we want to explore.
124    This is mainly useful when using xxx to get access to the depper levers and vertical sections.
125
126   
127    <a name="#_ncdf_meshroms_keyword_GLAMBOUNDARY"></a>
128    <h4>GLAMBOUNDARY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129     
130     
131     
132     
133     
134      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>2 elements vector</i></font>
135      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>those defined in the file</i></font>
136     
137    </h4>
138
139   
140    Longitude boundaries that should be used to visualize the data.
141      lon2 > lon1
142      lon2 - lon1 le 360
143    By default, the common (cm_4mesh) variable key_shift will be automatically
144    defined according to GLAMBOUNDARY.
145
146   
147    <a name="#_ncdf_meshroms_keyword_ONEARTH"></a>
148    <h4>ONEARTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
155      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>1</i></font>
156     
157    </h4>
158
159   
160    Force the manual definition of data localization on the earth or not
161       0) if the data are not on the earth
162       1) if the data are on earth (in that case we can for example use
163          the labels 'longitude', 'latitude' in plots).
164    The resulting value will be stored in the common (cm_4mesh) variable key_onearth
165    ONEARTH = 0 forces PERIODIC = 0, SHIFT = 0 and is cancelling GLAMBOUNDARY
166
167   
168    <a name="#_ncdf_meshroms_keyword_GETDIMENSIONS"></a>
169    <h4>GETDIMENSIONS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170     
171     
172     
173     
174     
175      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
176      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>0</i></font>
177     
178    </h4>
179
180   
181    Activate this keywords if you only want to know the dimension
182    of the domain stored in the mesh file. This dimensions will be
183    defined in jpiglo, jpjglo, jpkglo (cm_4mesh common variables)
184
185   
186    <a name="#_ncdf_meshroms_keyword_PERIODIC"></a>
187    <h4>PERIODIC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
188     
189     
190     
191     
192     
193      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar: 0 or 1</i></font>
194      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed by using the first line of glamt</i></font>
195     
196    </h4>
197
198   
199    Force the manual definition of the grid zonal periodicity.
200    The resulting value will be stored in the common (cm_4mesh) variable key_periodic
201    PERIODIC = 0 forces SHIFT = 0
202
203   
204    <a name="#_ncdf_meshroms_keyword_SHIFT"></a>
205    <h4>SHIFT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206     
207     
208     
209     
210     
211      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar</i></font>
212      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>computed according to glamboundary</i></font>
213     
214    </h4>
215
216   
217    Force the manual definition of the zonal shift that must be apply to the data.
218    The resulting value will be stored in the common (cm_4mesh) variable key_shift
219    Note that if key_periodic=0 then in any case key_shift = 0.
220
221   
222    <a name="#_ncdf_meshroms_keyword_STRIDE"></a>
223    <h4>STRIDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
224     
225     
226     
227     
228     
229      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>3 elements vector</i></font>
230      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>[1, 1, 1]</i></font>
231     
232    </h4>
233
234   
235    Specify the stride in x, y and z direction. The resulting
236    value will be stored in the common (cm_4mesh) variable key_stride
237
238   
239    <a name="#_ncdf_meshroms_keyword_STRCALLING"></a>
240    <h4>STRCALLING&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
241     
242     
243     
244     
245     
246      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
247     
248     
249    </h4>
250
251   
252    the calling command used to call computegrid (this is used by xxx.pro)
253
254   
255    <a name="#_ncdf_meshroms_keyword__EXTRA"></a>
256    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
257     
258     
259     
260     
261     
262     
263     
264     
265    </h4>
266
267     used to pass isafile keywords
268
269   
270   
271
272    <h3>Examples</h3>
273 IDL> ncdf_meshroms [,' filename']
274
275    <h3>Version history</h3>
276   
277    <h4>Version</h4> $Id: ncdf_meshroms.pro 173 2006-09-11 07:53:02Z smasson $
278
279    <h4>History</h4> Sebastien Masson (smasson@lodyc.jussieu.fr) September 2006
280
281   
282
283    <h3>Known issues</h3>
284   
285   
286   
287    <h4>Restrictions</h4>
288
289  ixminmesh,ixmaxmesh,iyminmesh,iymaxmesh,izminmesh,izmaxmesh must
290  be defined before calling ncdf_meshread. if some of those value
291  are equal to -1 they will be automatically defined
292
293  In the original ROMS grid, if F grid has (jpi,jpj) points then T
294  grid will have (jpi+1,jpj+1) points, U grid will have (jpi,jpj+1)
295  points and V grid will have (jpi+1,jpj) points.
296  By default C-grid used in this package needs the same number of
297  points for T,U,V and F grid, with a T point at the bottom left
298  corner of the grid. We therefore ignore the last column of T and
299  V points and the last line of T and U points.
300
301  Scale factors are compuited using the distance between the points
302  (which is not the exact definition for irregulare grid).
303
304
305    <h3>Other attributes</h3>
306   
307   
308    <h4>Uses routines</h4> cm_4mesh cm_4data cm_4cal
309
310   
311   
312   
313
314    <font size="-3"><p>&nbsp;</p></font>
315    <hr size="1" color="#CCCCCC"/>
316     
317
318   
319
320    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
321
322  </body>
323</html>
Note: See TracBrowser for help on using the repository browser.