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