source: trunk/SRC/Utilities/fitintobox.pro @ 277

Last change on this file since 277 was 254, checked in by pinsard, 17 years ago

improvements/corrections of some *.pro headers
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.8 KB
Line 
1;+
2;
3; @file_comments
4; Check that the input array has size and dimensions
5; compatible with the domain that was defined with the previous call
6; of <pro>domdef</pro>.
7;
8; @categories
9; Compatibility
10;
11; @param sz {in}{required}
12;
13; @param nx {in}{required}
14;
15; @param ny {in}{required}
16;
17; @param nz {in}{required}
18;
19; @param jpi {in}{required}
20;
21; @param jpj {in}{required}
22;
23; @param jpk {in}{required}
24;
25; @param jpt {in}{required}
26;
27; @returns
28; -1
29;
30; @history
31; Sebastien Masson (smasson\@lodyc.jussieu.fr)
32;          10 juin 2000.
33;          June 2005: S. Masson rewrite all.
34;
35; @version
36; $Id$
37;
38; @hidden
39;
40;-
41;
42FUNCTION err_mess, sz, jpi, nx, jpj, ny, jpk, nz, jpt
43;
44  compile_opt idl2, strictarrsubs
45;
46  IF n_elements(sz EQ 1) THEN $
47    RETURN, report(['Error: ' $
48                  , 'the vector size (' + tostr(sz) + ') is incompatible' $
49                  , 'with the domain dimensions ' $
50                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $
51                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $
52                  + ', ' + strtrim(jpj, 1) + '/' + strtrim(ny, 1) $
53                  + ', ' + strtrim(jpk, 1) + '/' + strtrim(nz, 1) $
54                  + ', ' + strtrim(jpt, 1) + ']'], /simple)
55  RETURN, report(['Error: ' $
56                  , 'the array dimensions ' + tostr(sz) + ' are incompatible' $
57                  , 'with the domain dimensions ' $
58                  , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $
59                  + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $
60                  + ', ' + strtrim(jpj, 1) + '/' + strtrim(ny, 1) $
61                  + ', ' + strtrim(jpk, 1) + '/' + strtrim(nz, 1) $
62                  + ', ' + strtrim(jpt, 1) + ']'], /simple)
63END
64;
65;+
66;
67; @categories
68; Compatibility
69;
70; @param field {in}{required}{type=array or struct}
71; an array or a structure that can be read by the function
72; <pro>litchamp</pro>
73;
74; @param nx {in}{optional}{default=define by <pro>grille</pro>}
75;
76; @param ny {in}{optional}{default=define by <pro>grille</pro>}
77;
78; @param nz {in}{optional}{default=define by <pro>grille</pro>}
79;
80; @param firstx {in}{optional}{default=define by <pro>grille</pro>}
81;
82; @param firsty {in}{optional}{default=define by <pro>grille</pro>}
83;
84; @param firstz {in}{optional}{default=define by <pro>grille</pro>}
85;
86; @param lastx {in}{optional}{default=define by <pro>grille</pro>}
87;
88; @param lasty {in}{optional}{default=define by <pro>grille</pro>}
89;
90; @param lastz {in}{optional}{default=define by <pro>grille</pro>}
91;
92; @keyword WDEPTH
93; To specify that we are at W level
94;
95; @returns
96; an array with dimensions matching the domain
97; or -1 if there is an error...
98;
99; @uses
100; cm_4mesh
101; cm_4cal
102;
103; @examples
104; IDL> help, fitintobox(findgen(jpi,jpj))
105; <Expression>    FLOAT     = Array[41, 3]
106; IDL> help, fitintobox(findgen(jpi,jpj,78))
107; Error:
108; the array dimensions [180,148,78] are incompatible
109; with the domain dimensions
110; [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
111; <Expression>    INT       =       -1
112;
113; @history
114; Sebastien Masson (smasson\@lodyc.jussieu.fr)
115;          10 juin 2000.
116;          June 2005: S. Masson rewrite all.
117;
118; @version
119; $Id$
120;
121;-
122;
123FUNCTION fitintobox, field, nx, ny, nz, firstx, firsty $
124                     , firstz, lastx, lasty, lastz, WDEPTH = wdepth
125;
126  compile_opt idl2, strictarrsubs
127;
128@cm_4mesh
129@cm_4cal
130  IF NOT keyword_set(key_forgetold) THEN BEGIN
131@updatenew
132  ENDIF
133;---------------------
134  arr = litchamp(field)
135  IF n_params() EQ 1 THEN grille, -1, -1, -1, -1, nx, ny, nz $
136    , firstx, firsty, firstz, lastx, lasty, lastz, WDEPTH = wdepth
137;--------------------------------------------------------------
138;--------------------------------------------------------------
139; case according the number of dimensions of the array
140;--------------------------------------------------------------
141;--------------------------------------------------------------
142  sz = size(arr)
143  case sz[0] of
144;--------------------------------------------------------------
145    0:BEGIN                     ; scalar
146;--------------------------------------------------------------
147      return, report('Error: scalar value = ' + strtrim(arr, 1), /simple)
148    END
149;--------------------------------------------------------------
150    1:BEGIN                     ; 1D arrays
151;--------------------------------------------------------------
152      CASE 1 OF
153; x arrays
154        sz[1] EQ jpi                                                   :arr = (temporary(arr))[firstx:lastx                               ]
155        sz[1] EQ  nx                                                   :
156; y arrays
157        sz[1] EQ jpj                                                   :arr = (temporary(arr))[              firsty:lasty                 ]
158        sz[1] EQ  ny                                                   :
159; z arrays
160        sz[1] EQ jpk                                                   :arr = (temporary(arr))[                            firstz:lastz   ]
161        sz[1] EQ  nz                                                   :
162; t arrays
163        sz[1] EQ jpt                                                   :
164        ELSE:return, err_mess(sz[1], jpi, nx, jpj, ny, jpk, nz, jpt)
165      ENDCASE
166    END
167;--------------------------------------------------------------
168    2:BEGIN                     ; 2D arrays
169;--------------------------------------------------------------
170      CASE 1 OF
171; xy arrays
172        sz[1] EQ jpi AND sz[2] EQ jpj                                  :arr = (temporary(arr))[firstx:lastx, firsty:lasty                 ]
173        sz[1] EQ jpi AND sz[2] EQ  ny                                  :arr = (temporary(arr))[firstx:lastx,            *                 ]
174        sz[1] EQ  nx AND sz[2] EQ jpj                                  :arr = (temporary(arr))[           *, firsty:lasty                 ]
175        sz[1] EQ  nx AND sz[2] EQ  ny                                  :arr = (temporary(arr))[           *,            *                 ]
176; x(y)z arrays
177        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firstz:lastz   ]
178        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ  nz                 :arr = (temporary(arr))[firstx:lastx,            *   ]
179        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ jpk                 :arr = (temporary(arr))[           *, firstz:lastz   ]
180        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ  nz                 :
181; (x)yz arrays
182        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk                 :arr = (temporary(arr))[              firsty:lasty, firstz:lastz   ]
183        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ  nz                 :arr = (temporary(arr))[              firsty:lasty,            *   ]
184        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ jpk                 :arr = (temporary(arr))[                         *, firstz:lastz   ]
185        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ  nz                 :
186; xt arrays
187        sz[1] EQ jpi                                   AND sz[2] EQ jpt:arr = (temporary(arr))[firstx:lastx                            , *]
188        sz[1] EQ  nx                                   AND sz[2] EQ jpt:
189; yt arrays
190                         sz[1] EQ jpj                  AND sz[2] EQ jpt:arr = (temporary(arr))[              firsty:lasty              , *]
191                         sz[1] EQ  ny                  AND sz[2] EQ jpt:
192; zt arrays
193                                          sz[1] EQ jpk AND sz[2] EQ jpt:arr = (temporary(arr))[                            firstz:lastz, *]
194                                          sz[1] EQ  nz AND sz[2] EQ jpt:
195        ELSE:return, err_mess(sz[1:2], jpi, nx, jpj, ny, jpk, nz, jpt)
196      ENDCASE
197    END
198;--------------------------------------------------------------
199    3:BEGIN                     ; 3D arrays
200;--------------------------------------------------------------
201      CASE 1 OF
202; xyz arrays
203        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz   ]
204        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ jpk                 :arr = (temporary(arr))[firstx:lastx,            *, firstz:lastz   ]
205        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ jpk                 :arr = (temporary(arr))[           *, firsty:lasty, firstz:lastz   ]
206        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ jpk                 :arr = (temporary(arr))[           *,            *, firstz:lastz   ]
207        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz                 :arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *   ]
208        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ  nz                 :arr = (temporary(arr))[firstx:lastx,            *,            *   ]
209        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ  nz                 :arr = (temporary(arr))[           *, firsty:lasty,            *   ]
210        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ  nz                 :
211; xyt arrays
212        sz[1] EQ jpi AND sz[2] EQ jpj                  AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,               *]
213        sz[1] EQ jpi AND sz[2] EQ  ny                  AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *,               *]
214        sz[1] EQ  nx AND sz[2] EQ jpj                  AND sz[3] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty,               *]
215        sz[1] EQ  nx AND sz[2] EQ  ny                  AND sz[3] EQ jpt:
216; (x)yzt arrays
217        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[              firsty:lasty, firstz:lastz, *]
218        nx EQ 1      AND sz[1] EQ jpj AND sz[2] EQ  nz AND sz[3] EQ jpt:arr = (temporary(arr))[              firsty:lasty,            *, *]
219        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[                         *, firstz:lastz, *]
220        nx EQ 1      AND sz[1] EQ  ny AND sz[2] EQ  nz AND sz[3] EQ jpt:
221; x(y)zt arrays
222        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,               firstz:lastz, *]
223        sz[1] EQ jpi AND ny EQ 1      AND sz[2] EQ  nz AND sz[3] EQ jpt:arr = (temporary(arr))[firstx:lastx,                          *, *]
224        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ jpk AND sz[3] EQ jpt:arr = (temporary(arr))[           *,               firstz:lastz, *]
225        sz[1] EQ  nx AND ny EQ 1      AND sz[2] EQ  nz AND sz[3] EQ jpt:
226        ELSE:return, err_mess(sz[1:3], jpi, nx, jpj, ny, jpk, nz, jpt)
227      ENDCASE
228    END
229;--------------------------------------------------------------
230    4:BEGIN                     ; 4D arrays
231;--------------------------------------------------------------
232      CASE 1 OF
233; xyzt arrays
234        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty, firstz:lastz, *]
235        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *, firstz:lastz, *]
236        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty, firstz:lastz, *]
237        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ jpk AND sz[4] EQ jpt:arr = (temporary(arr))[           *,            *, firstz:lastz, *]
238        sz[1] EQ jpi AND sz[2] EQ jpj AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx, firsty:lasty,            *, *]
239        sz[1] EQ jpi AND sz[2] EQ  ny AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[firstx:lastx,            *,            *, *]
240        sz[1] EQ  nx AND sz[2] EQ jpj AND sz[3] EQ  nz AND sz[4] EQ jpt:arr = (temporary(arr))[           *, firsty:lasty,            *, *]
241        sz[1] EQ  nx AND sz[2] EQ  ny AND sz[3] EQ  nz AND sz[4] EQ jpt:
242        ELSE:return, err_mess(sz[1:4], jpi, nx, jpj, ny, jpk, nz, jpt)
243      ENDCASE
244    END
245    ELSE:return, report('Error: fitintobox is managing arrays with a maximum of 4 dimensions', /simple)
246  ENDCASE
247
248  return, arr
249end
Note: See TracBrowser for help on using the repository browser.