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>fitintobox.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="fitintobox.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?format=raw" title="Overview of library">Overview</a></td> |
---|
36 | |
---|
37 | |
---|
38 | |
---|
39 | <td >Directory</td> |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
52 | |
---|
53 | |
---|
54 | <td id="selected">File</td> |
---|
55 | |
---|
56 | |
---|
57 | <td >Source</td> |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | <td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td> |
---|
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 | |
---|
74 | << prev file | <a href="get_extra.html">next file >></a> <a href="fitintobox.html" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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?format=raw">ToBeReviewed/UTILITAIRE/</a></h1> |
---|
82 | <h2 class="pro_file">fitintobox.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"></div> |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | <div id="routine_summary"> |
---|
99 | <h2>Routine summary</h2> |
---|
100 | |
---|
101 | <dl> |
---|
102 | |
---|
103 | <dt><p><a href="#_err_mess"><span class="result">result = </span>err_mess(<span class="result">sz, jpi, nx, jpj, ny, jpk, nz, jpt</span>)</a></p><dt> |
---|
104 | <dd> NAME:fitintobox PURPOSE: check that the input array has size and dimensions compatible with the domain that was defined with the previous call of domdef.</dd> |
---|
105 | |
---|
106 | <dt><p><a href="#_fitintobox"><span class="result">result = </span>fitintobox(<span class="result">field, nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz</span>, WDEPTH=<span class="result">WDEPTH</span>)</a></p><dt> |
---|
107 | <dd></dd> |
---|
108 | |
---|
109 | </dl> |
---|
110 | </div> |
---|
111 | |
---|
112 | |
---|
113 | <div id="routine_details"> |
---|
114 | |
---|
115 | |
---|
116 | <div class="routine_details" id="_err_mess"> |
---|
117 | |
---|
118 | <h2><a class="top" href="#container">top</a>err_mess </h2> |
---|
119 | |
---|
120 | <p class="header"> |
---|
121 | <span class="result">result = </span>err_mess(<span class="result"><a href="#_err_mess_param_sz">sz</a>, <a href="#_err_mess_param_jpi">jpi</a>, <a href="#_err_mess_param_nx">nx</a>, <a href="#_err_mess_param_jpj">jpj</a>, <a href="#_err_mess_param_ny">ny</a>, <a href="#_err_mess_param_jpk">jpk</a>, <a href="#_err_mess_param_nz">nz</a>, <a href="#_err_mess_param_jpt">jpt</a></span>)</p> |
---|
122 | |
---|
123 | <div class="comments"> |
---|
124 | NAME:fitintobox |
---|
125 | |
---|
126 | PURPOSE: check that the input array has size and dimensions |
---|
127 | compatible with the domain that was defined with the previous call |
---|
128 | of domdef. |
---|
129 | |
---|
130 | CATEGORY: domain compatibility |
---|
131 | |
---|
132 | CALLING SEQUENCE: |
---|
133 | res = fitintobox(field[, nx, ny, nz, firstx, firsty, firstz |
---|
134 | , lastx, lasty, lastz]) |
---|
135 | |
---|
136 | INPUTS: |
---|
137 | field: an array or a structure that can be read by the function |
---|
138 | litchamp.pro |
---|
139 | |
---|
140 | nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz: |
---|
141 | optional parameters. If not given they will be define with a |
---|
142 | call to the procedure grille.pro |
---|
143 | |
---|
144 | KEYWORD PARAMETERS: none |
---|
145 | |
---|
146 | OUTPUTS: an array with dimensions matching the domain |
---|
147 | or -1 if there is an error... |
---|
148 | |
---|
149 | COMMON BLOCKS: cm_4mesh and cm_4cal |
---|
150 | |
---|
151 | SIDE EFFECTS: |
---|
152 | |
---|
153 | RESTRICTIONS: |
---|
154 | |
---|
155 | EXAMPLE: |
---|
156 | |
---|
157 | IDL> help, fitintobox(findgen(jpi,jpj)) |
---|
158 | <Expression> FLOAT = Array[41, 3] |
---|
159 | IDL> help, fitintobox(findgen(jpi,jpj,78)) |
---|
160 | Error: |
---|
161 | the array dimensions [180,148,78] are incompatible |
---|
162 | with the the domain dimensions |
---|
163 | [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1] |
---|
164 | <Expression> INT = -1 |
---|
165 | </div> |
---|
166 | |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | <h3>Parameters</h3> |
---|
171 | |
---|
172 | |
---|
173 | <h4 id="_err_mess_param_sz">sz |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | |
---|
181 | |
---|
182 | </h4> |
---|
183 | |
---|
184 | <div class="comments"></div> |
---|
185 | |
---|
186 | <h4 id="_err_mess_param_jpi">jpi |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | |
---|
195 | </h4> |
---|
196 | |
---|
197 | <div class="comments"></div> |
---|
198 | |
---|
199 | <h4 id="_err_mess_param_nx">nx |
---|
200 | |
---|
201 | |
---|
202 | |
---|
203 | |
---|
204 | |
---|
205 | |
---|
206 | |
---|
207 | |
---|
208 | </h4> |
---|
209 | |
---|
210 | <div class="comments"></div> |
---|
211 | |
---|
212 | <h4 id="_err_mess_param_jpj">jpj |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | |
---|
220 | |
---|
221 | </h4> |
---|
222 | |
---|
223 | <div class="comments"></div> |
---|
224 | |
---|
225 | <h4 id="_err_mess_param_ny">ny |
---|
226 | |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | |
---|
234 | </h4> |
---|
235 | |
---|
236 | <div class="comments"></div> |
---|
237 | |
---|
238 | <h4 id="_err_mess_param_jpk">jpk |
---|
239 | |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | </h4> |
---|
248 | |
---|
249 | <div class="comments"></div> |
---|
250 | |
---|
251 | <h4 id="_err_mess_param_nz">nz |
---|
252 | |
---|
253 | |
---|
254 | |
---|
255 | |
---|
256 | |
---|
257 | |
---|
258 | |
---|
259 | |
---|
260 | </h4> |
---|
261 | |
---|
262 | <div class="comments"></div> |
---|
263 | |
---|
264 | <h4 id="_err_mess_param_jpt">jpt |
---|
265 | |
---|
266 | |
---|
267 | |
---|
268 | |
---|
269 | |
---|
270 | |
---|
271 | |
---|
272 | |
---|
273 | </h4> |
---|
274 | |
---|
275 | <div class="comments"></div> |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | |
---|
290 | |
---|
291 | |
---|
292 | |
---|
293 | |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | |
---|
302 | |
---|
303 | |
---|
304 | |
---|
305 | </div> |
---|
306 | |
---|
307 | |
---|
308 | <div class="routine_details" id="_fitintobox"> |
---|
309 | |
---|
310 | <h2><a class="top" href="#container">top</a>fitintobox </h2> |
---|
311 | |
---|
312 | <p class="header"> |
---|
313 | <span class="result">result = </span>fitintobox(<span class="result"><a href="#_fitintobox_param_field">field</a>, <a href="#_fitintobox_param_nx">nx</a>, <a href="#_fitintobox_param_ny">ny</a>, <a href="#_fitintobox_param_nz">nz</a>, <a href="#_fitintobox_param_firstx">firstx</a>, <a href="#_fitintobox_param_firsty">firsty</a>, <a href="#_fitintobox_param_firstz">firstz</a>, <a href="#_fitintobox_param_lastx">lastx</a>, <a href="#_fitintobox_param_lasty">lasty</a>, <a href="#_fitintobox_param_lastz">lastz</a></span>, <a href="#_fitintobox_keyword_WDEPTH">WDEPTH</a>=<span class="result">WDEPTH</span>)</p> |
---|
314 | |
---|
315 | <div class="comments"></div> |
---|
316 | |
---|
317 | |
---|
318 | |
---|
319 | |
---|
320 | <h3>Parameters</h3> |
---|
321 | |
---|
322 | |
---|
323 | <h4 id="_fitintobox_param_field">field |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | |
---|
328 | |
---|
329 | |
---|
330 | |
---|
331 | |
---|
332 | </h4> |
---|
333 | |
---|
334 | <div class="comments"></div> |
---|
335 | |
---|
336 | <h4 id="_fitintobox_param_nx">nx |
---|
337 | |
---|
338 | |
---|
339 | |
---|
340 | |
---|
341 | |
---|
342 | |
---|
343 | |
---|
344 | |
---|
345 | </h4> |
---|
346 | |
---|
347 | <div class="comments"></div> |
---|
348 | |
---|
349 | <h4 id="_fitintobox_param_ny">ny |
---|
350 | |
---|
351 | |
---|
352 | |
---|
353 | |
---|
354 | |
---|
355 | |
---|
356 | |
---|
357 | |
---|
358 | </h4> |
---|
359 | |
---|
360 | <div class="comments"></div> |
---|
361 | |
---|
362 | <h4 id="_fitintobox_param_nz">nz |
---|
363 | |
---|
364 | |
---|
365 | |
---|
366 | |
---|
367 | |
---|
368 | |
---|
369 | |
---|
370 | |
---|
371 | </h4> |
---|
372 | |
---|
373 | <div class="comments"></div> |
---|
374 | |
---|
375 | <h4 id="_fitintobox_param_firstx">firstx |
---|
376 | |
---|
377 | |
---|
378 | |
---|
379 | |
---|
380 | |
---|
381 | |
---|
382 | |
---|
383 | |
---|
384 | </h4> |
---|
385 | |
---|
386 | <div class="comments"></div> |
---|
387 | |
---|
388 | <h4 id="_fitintobox_param_firsty">firsty |
---|
389 | |
---|
390 | |
---|
391 | |
---|
392 | |
---|
393 | |
---|
394 | |
---|
395 | |
---|
396 | |
---|
397 | </h4> |
---|
398 | |
---|
399 | <div class="comments"></div> |
---|
400 | |
---|
401 | <h4 id="_fitintobox_param_firstz">firstz |
---|
402 | |
---|
403 | |
---|
404 | |
---|
405 | |
---|
406 | |
---|
407 | |
---|
408 | |
---|
409 | |
---|
410 | </h4> |
---|
411 | |
---|
412 | <div class="comments"></div> |
---|
413 | |
---|
414 | <h4 id="_fitintobox_param_lastx">lastx |
---|
415 | |
---|
416 | |
---|
417 | |
---|
418 | |
---|
419 | |
---|
420 | |
---|
421 | |
---|
422 | |
---|
423 | </h4> |
---|
424 | |
---|
425 | <div class="comments"></div> |
---|
426 | |
---|
427 | <h4 id="_fitintobox_param_lasty">lasty |
---|
428 | |
---|
429 | |
---|
430 | |
---|
431 | |
---|
432 | |
---|
433 | |
---|
434 | |
---|
435 | |
---|
436 | </h4> |
---|
437 | |
---|
438 | <div class="comments"></div> |
---|
439 | |
---|
440 | <h4 id="_fitintobox_param_lastz">lastz |
---|
441 | |
---|
442 | |
---|
443 | |
---|
444 | |
---|
445 | |
---|
446 | |
---|
447 | |
---|
448 | |
---|
449 | </h4> |
---|
450 | |
---|
451 | <div class="comments"></div> |
---|
452 | |
---|
453 | |
---|
454 | |
---|
455 | |
---|
456 | |
---|
457 | |
---|
458 | <h3>Keywords</h3> |
---|
459 | |
---|
460 | <h4 id="_fitintobox_keyword_WDEPTH">WDEPTH |
---|
461 | |
---|
462 | |
---|
463 | |
---|
464 | |
---|
465 | |
---|
466 | |
---|
467 | |
---|
468 | |
---|
469 | </h4> |
---|
470 | |
---|
471 | <div class="comments"></div> |
---|
472 | |
---|
473 | |
---|
474 | |
---|
475 | |
---|
476 | |
---|
477 | |
---|
478 | |
---|
479 | |
---|
480 | |
---|
481 | |
---|
482 | |
---|
483 | |
---|
484 | |
---|
485 | |
---|
486 | |
---|
487 | |
---|
488 | |
---|
489 | |
---|
490 | |
---|
491 | |
---|
492 | |
---|
493 | |
---|
494 | |
---|
495 | |
---|
496 | |
---|
497 | |
---|
498 | </div> |
---|
499 | |
---|
500 | </div> |
---|
501 | |
---|
502 | |
---|
503 | |
---|
504 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
505 | |
---|
506 | </div> |
---|
507 | |
---|
508 | </body> |
---|
509 | </html> |
---|