source: palm/trunk/SOURCE/init_masks.f90 @ 484

Last change on this file since 484 was 484, checked in by raasch, 12 years ago

typo in file headers removed

  • Property svn:keywords set to Id
File size: 28.6 KB
Line 
1 SUBROUTINE init_masks
2
3!------------------------------------------------------------------------------!
4! Current revisions:
5! -----------------
6!
7!
8! Former revisions:
9! -----------------
10! $Id: init_masks.f90 484 2010-02-05 07:36:54Z raasch $
11!
12! 410 2009-12-04 17:05:40Z letzel
13! Initial revision
14!
15!
16! Description:
17! ------------
18! Initialize masked data output
19!------------------------------------------------------------------------------!
20
21    USE arrays_3d
22    USE control_parameters
23    USE grid_variables
24    USE indices
25    USE netcdf_control
26    USE particle_attributes
27    USE pegrid
28
29    IMPLICIT NONE
30
31    CHARACTER (LEN=6)   ::  var
32    CHARACTER (LEN=7)   ::  unit
33    CHARACTER (LEN=10), DIMENSION(max_masks,100) ::  do_mask, do_mask_user
34
35    INTEGER :: i, ilen, ind(6), ind_array(1), j, k, n, sender
36    INTEGER, DIMENSION(:), ALLOCATABLE ::  tmp_array
37
38    LOGICAL ::  found
39!
40!-- Allocation and initialization
41    ALLOCATE( tmp_array( MAX(nx,ny,nz)+1 ) )
42
43    ALLOCATE( mask_i(max_masks,nxr-nxl+1), &
44              mask_j(max_masks,nyn-nys+1), &
45              mask_k(max_masks,nzt-nzb+1) )
46!
47!-- internal mask arrays ("mask,dimension,selection")
48    ALLOCATE( mask(max_masks,3,mask_xyz_dimension), &
49              mask_loop(max_masks,3,3) )
50!
51!-- Store netcdf file formats for masked data output in one shared array
52    nc_format_mask(:,0) = netcdf_format_mask
53    nc_format_mask(:,1) = netcdf_format_mask_av
54   
55    IF ( ANY( nc_format_mask == 3 ) .OR. ANY( nc_format_mask == 4 )) THEN
56       format_parallel_io = .TRUE.
57    ENDIF
58
59    IF ( ANY( nc_format_mask < 1 ) .OR. ANY( nc_format_mask > 4 ) )  THEN
60       WRITE( message_string, * )  'illegal value: netcdf_format_mask and ', &
61            'netcdf_format_mask_av must be either 1, 2, 3 or 4'
62       IF ( ANY( nc_format_mask == 3 ) .OR. ANY( nc_format_mask == 4 ) )  THEN
63          message_string = TRIM( message_string ) // '&NetCDF file formats '// &
64               '3 (NetCDF 4) and 4 (NetCDF 4 Classic model)'// &
65               '&are currently not supported (not yet tested).'
66       ENDIF
67       CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
68    ENDIF
69!
70!-- Store data output parameters for masked data output in few shared arrays
71    do_mask( 1,:) = data_output_mask_01; do_mask( 2,:) = data_output_mask_02
72    do_mask( 3,:) = data_output_mask_03; do_mask( 4,:) = data_output_mask_04
73    do_mask( 5,:) = data_output_mask_05; do_mask( 6,:) = data_output_mask_06
74    do_mask( 7,:) = data_output_mask_07; do_mask( 8,:) = data_output_mask_08
75    do_mask( 9,:) = data_output_mask_09; do_mask(10,:) = data_output_mask_10
76    do_mask(11,:) = data_output_mask_11; do_mask(12,:) = data_output_mask_12
77    do_mask(13,:) = data_output_mask_13; do_mask(14,:) = data_output_mask_14
78    do_mask(15,:) = data_output_mask_15; do_mask(16,:) = data_output_mask_16
79    do_mask(17,:) = data_output_mask_17; do_mask(18,:) = data_output_mask_18
80    do_mask(19,:) = data_output_mask_19; do_mask(20,:) = data_output_mask_20
81    do_mask_user( 1,:) = data_output_mask_user_01
82    do_mask_user( 2,:) = data_output_mask_user_02
83    do_mask_user( 3,:) = data_output_mask_user_03
84    do_mask_user( 4,:) = data_output_mask_user_04
85    do_mask_user( 5,:) = data_output_mask_user_05
86    do_mask_user( 6,:) = data_output_mask_user_06
87    do_mask_user( 7,:) = data_output_mask_user_07
88    do_mask_user( 8,:) = data_output_mask_user_08
89    do_mask_user( 9,:) = data_output_mask_user_09
90    do_mask_user(10,:) = data_output_mask_user_10
91    do_mask_user(11,:) = data_output_mask_user_11
92    do_mask_user(12,:) = data_output_mask_user_12
93    do_mask_user(13,:) = data_output_mask_user_13
94    do_mask_user(14,:) = data_output_mask_user_14
95    do_mask_user(15,:) = data_output_mask_user_15
96    do_mask_user(16,:) = data_output_mask_user_16
97    do_mask_user(17,:) = data_output_mask_user_17
98    do_mask_user(18,:) = data_output_mask_user_18
99    do_mask_user(19,:) = data_output_mask_user_19
100    do_mask_user(20,:) = data_output_mask_user_20
101    mask( 1,1,:) = mask_01_x; mask( 2,1,:) = mask_02_x
102    mask( 3,1,:) = mask_03_x; mask( 4,1,:) = mask_04_x
103    mask( 5,1,:) = mask_05_x; mask( 6,1,:) = mask_06_x
104    mask( 7,1,:) = mask_07_x; mask( 8,1,:) = mask_08_x
105    mask( 9,1,:) = mask_09_x; mask(10,1,:) = mask_10_x
106    mask(11,1,:) = mask_11_x; mask(12,1,:) = mask_12_x
107    mask(13,1,:) = mask_13_x; mask(14,1,:) = mask_14_x
108    mask(15,1,:) = mask_15_x; mask(16,1,:) = mask_16_x
109    mask(17,1,:) = mask_17_x; mask(18,1,:) = mask_18_x
110    mask(19,1,:) = mask_19_x; mask(20,1,:) = mask_20_x
111    mask( 1,2,:) = mask_01_y; mask( 2,2,:) = mask_02_y
112    mask( 3,2,:) = mask_03_y; mask( 4,2,:) = mask_04_y
113    mask( 5,2,:) = mask_05_y; mask( 6,2,:) = mask_06_y
114    mask( 7,2,:) = mask_07_y; mask( 8,2,:) = mask_08_y
115    mask( 9,2,:) = mask_09_y; mask(10,2,:) = mask_10_y
116    mask(11,2,:) = mask_11_y; mask(12,2,:) = mask_12_y
117    mask(13,2,:) = mask_13_y; mask(14,2,:) = mask_14_y
118    mask(15,2,:) = mask_15_y; mask(16,2,:) = mask_16_y
119    mask(17,2,:) = mask_17_y; mask(18,2,:) = mask_18_y
120    mask(19,2,:) = mask_19_y; mask(20,2,:) = mask_20_y
121    mask( 1,3,:) = mask_01_z; mask( 2,3,:) = mask_02_z
122    mask( 3,3,:) = mask_03_z; mask( 4,3,:) = mask_04_z
123    mask( 5,3,:) = mask_05_z; mask( 6,3,:) = mask_06_z
124    mask( 7,3,:) = mask_07_z; mask( 8,3,:) = mask_08_z
125    mask( 9,3,:) = mask_09_z; mask(10,3,:) = mask_10_z
126    mask(11,3,:) = mask_11_z; mask(12,3,:) = mask_12_z
127    mask(13,3,:) = mask_13_z; mask(14,3,:) = mask_14_z
128    mask(15,3,:) = mask_15_z; mask(16,3,:) = mask_16_z
129    mask(17,3,:) = mask_17_z; mask(18,3,:) = mask_18_z
130    mask(19,3,:) = mask_19_z; mask(20,3,:) = mask_20_z
131    mask_loop( 1,1,:) = mask_01_x_loop; mask_loop( 2,1,:) = mask_02_x_loop
132    mask_loop( 3,1,:) = mask_03_x_loop; mask_loop( 4,1,:) = mask_04_x_loop
133    mask_loop( 5,1,:) = mask_05_x_loop; mask_loop( 6,1,:) = mask_06_x_loop
134    mask_loop( 7,1,:) = mask_07_x_loop; mask_loop( 8,1,:) = mask_08_x_loop
135    mask_loop( 9,1,:) = mask_09_x_loop; mask_loop(10,1,:) = mask_10_x_loop
136    mask_loop(11,1,:) = mask_11_x_loop; mask_loop(12,1,:) = mask_12_x_loop
137    mask_loop(13,1,:) = mask_13_x_loop; mask_loop(14,1,:) = mask_14_x_loop
138    mask_loop(15,1,:) = mask_15_x_loop; mask_loop(16,1,:) = mask_16_x_loop
139    mask_loop(17,1,:) = mask_17_x_loop; mask_loop(18,1,:) = mask_18_x_loop
140    mask_loop(19,1,:) = mask_19_x_loop; mask_loop(20,1,:) = mask_20_x_loop
141    mask_loop( 1,2,:) = mask_01_y_loop; mask_loop( 2,2,:) = mask_02_y_loop
142    mask_loop( 3,2,:) = mask_03_y_loop; mask_loop( 4,2,:) = mask_04_y_loop
143    mask_loop( 5,2,:) = mask_05_y_loop; mask_loop( 6,2,:) = mask_06_y_loop
144    mask_loop( 7,2,:) = mask_07_y_loop; mask_loop( 8,2,:) = mask_08_y_loop
145    mask_loop( 9,2,:) = mask_09_y_loop; mask_loop(10,2,:) = mask_10_y_loop
146    mask_loop(11,2,:) = mask_11_y_loop; mask_loop(12,2,:) = mask_12_y_loop
147    mask_loop(13,2,:) = mask_13_y_loop; mask_loop(14,2,:) = mask_14_y_loop
148    mask_loop(15,2,:) = mask_15_y_loop; mask_loop(16,2,:) = mask_16_y_loop
149    mask_loop(17,2,:) = mask_17_y_loop; mask_loop(18,2,:) = mask_18_y_loop
150    mask_loop(19,2,:) = mask_19_y_loop; mask_loop(20,2,:) = mask_20_y_loop
151    mask_loop( 1,3,:) = mask_01_z_loop; mask_loop( 2,3,:) = mask_02_z_loop
152    mask_loop( 3,3,:) = mask_03_z_loop; mask_loop( 4,3,:) = mask_04_z_loop
153    mask_loop( 5,3,:) = mask_05_z_loop; mask_loop( 6,3,:) = mask_06_z_loop
154    mask_loop( 7,3,:) = mask_07_z_loop; mask_loop( 8,3,:) = mask_08_z_loop
155    mask_loop( 9,3,:) = mask_09_z_loop; mask_loop(10,3,:) = mask_10_z_loop
156    mask_loop(11,3,:) = mask_11_z_loop; mask_loop(12,3,:) = mask_12_z_loop
157    mask_loop(13,3,:) = mask_13_z_loop; mask_loop(14,3,:) = mask_14_z_loop
158    mask_loop(15,3,:) = mask_15_z_loop; mask_loop(16,3,:) = mask_16_z_loop
159    mask_loop(17,3,:) = mask_17_z_loop; mask_loop(18,3,:) = mask_18_z_loop
160    mask_loop(19,3,:) = mask_19_z_loop; mask_loop(20,3,:) = mask_20_z_loop
161    mask_i = -1; mask_j = -1; mask_k = -1
162!
163!-- Global arrays are required by define_netcdf_header.
164    IF ( format_parallel_io )  THEN
165       ALLOCATE( mask_i_global(max_masks,nx+1), &
166                 mask_j_global(max_masks,ny+1), &
167                 mask_k_global(max_masks,nz+1) )
168       mask_i_global = -1; mask_j_global = -1; mask_k_global = -1
169    ELSEIF ( myid == 0 )  THEN
170       ALLOCATE( mask_i_global(max_masks,nx+1), &
171                 mask_j_global(max_masks,ny+1), &
172                 mask_k_global(max_masks,nz+1) )
173       mask_i_global = -1; mask_j_global = -1; mask_k_global = -1
174    ENDIF
175
176!
177!-- Determine variable names for each mask
178    DO  mid = 1, masks
179!
180!--    Append user-defined data output variables to the standard data output
181       IF ( do_mask_user(mid,1) /= ' ' )  THEN
182          i = 1
183          DO  WHILE ( do_mask(mid,i) /= ' '  .AND.  i <= 100 )
184             i = i + 1
185          ENDDO
186          j = 1
187          DO  WHILE ( do_mask_user(mid,j) /= ' '  .AND.  j <= 100 )
188             IF ( i > 100 )  THEN
189                WRITE ( message_string, * ) 'number of output quantitities ', &
190                     'given by data_output_mask and data_output_mask_user ', &
191                     'exceeds the limit of 100'
192                CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
193             ENDIF
194             do_mask(mid,i) = do_mask_user(mid,j)
195             i = i + 1
196             j = j + 1
197          ENDDO
198       ENDIF
199
200!
201!--    Check and set steering parameters for mask data output and averaging
202       i   = 1
203       DO  WHILE ( do_mask(mid,i) /= ' '  .AND.  i <= 100 )
204!
205!--       Check for data averaging
206          ilen = LEN_TRIM( do_mask(mid,i) )
207          j = 0                                              ! no data averaging
208          IF ( ilen > 3 )  THEN
209             IF ( do_mask(mid,i)(ilen-2:ilen) == '_av' )  THEN
210                j = 1                                           ! data averaging
211                do_mask(mid,i) = do_mask(mid,i)(1:ilen-3)
212             ENDIF
213          ENDIF
214          var = TRIM( do_mask(mid,i) )
215!
216!--       Check for allowed value and set units
217          SELECT CASE ( TRIM( var ) )
218
219             CASE ( 'e' )
220                IF ( constant_diffusion )  THEN
221                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
222                        '" requires constant_diffusion = .FALSE.'
223                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
224                ENDIF
225                unit = 'm2/s2'
226
227             CASE ( 'pc', 'pr' )
228                IF ( .NOT. particle_advection )  THEN
229                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
230                        '" requires a "particles_par"-NAMELIST in the ', &
231                        'parameter file (PARIN)'
232                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
233                ENDIF
234                IF ( TRIM( var ) == 'pc' )  unit = 'number'
235                IF ( TRIM( var ) == 'pr' )  unit = 'm'
236
237             CASE ( 'q', 'vpt' )
238                IF ( .NOT. humidity )  THEN
239                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
240                        '" requires humidity = .TRUE.'
241                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
242                ENDIF
243                IF ( TRIM( var ) == 'q'   )  unit = 'kg/kg'
244                IF ( TRIM( var ) == 'vpt' )  unit = 'K'
245
246             CASE ( 'ql' )
247                IF ( .NOT. ( cloud_physics  .OR.  cloud_droplets ) )  THEN
248                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
249                        '" requires cloud_physics = .TRUE. or cloud_droplets', &
250                        ' = .TRUE.'
251                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
252                ENDIF
253                unit = 'kg/kg'
254
255             CASE ( 'ql_c', 'ql_v', 'ql_vp' )
256                IF ( .NOT. cloud_droplets )  THEN
257                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
258                        '" requires cloud_droplets = .TRUE.'
259                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
260                ENDIF
261                IF ( TRIM( var ) == 'ql_c'  )  unit = 'kg/kg'
262                IF ( TRIM( var ) == 'ql_v'  )  unit = 'm3'
263                IF ( TRIM( var ) == 'ql_vp' )  unit = 'none'
264
265             CASE ( 'qv' )
266                IF ( .NOT. cloud_physics )  THEN
267                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
268                        '" requires cloud_physics = .TRUE.'
269                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
270                ENDIF
271                unit = 'kg/kg'
272
273             CASE ( 'rho' )
274                IF ( .NOT. ocean )  THEN
275                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
276                        '" requires ocean = .TRUE.'
277                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
278                ENDIF
279                unit = 'kg/m3'
280
281             CASE ( 's' )
282                IF ( .NOT. passive_scalar )  THEN
283                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
284                        '" requires passive_scalar = .TRUE.'
285                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
286                ENDIF
287                unit = 'conc'
288
289             CASE ( 'sa' )
290                IF ( .NOT. ocean )  THEN
291                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
292                        '" requires ocean = .TRUE.'
293                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
294                ENDIF
295                unit = 'psu'
296
297             CASE ( 'u*', 't*', 'lwp*', 'pra*', 'prr*', 'z0*' )
298                WRITE ( message_string, * ) 'illegal value for data_',&
299                     'output: "', TRIM( var ), '" is only allowed', &
300                     'for horizontal cross section'
301                CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
302!                IF ( TRIM( var ) == 'lwp*'  .AND.  .NOT. cloud_physics )  THEN
303!                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
304!                         '" requires cloud_physics = .TRUE.'
305!                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
306!                ENDIF
307!                IF ( TRIM( var ) == 'pra*'  .AND.  .NOT. precipitation )  THEN
308!                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
309!                         '" requires precipitation = .TRUE.'
310!                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
311!                ENDIF
312!                IF ( TRIM( var ) == 'pra*'  .AND.  j == 1 )  THEN
313!                   WRITE ( message_string, * ) 'temporal averaging of ', &
314!                         ' precipitation amount "', TRIM( var ),         &
315!                         '" not possible'
316!                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
317!                ENDIF
318!                IF ( TRIM( var ) == 'prr*'  .AND.  .NOT. precipitation )  THEN
319!                   WRITE ( message_string, * ) 'output of "', TRIM( var ), &
320!                         '" requires precipitation = .TRUE.'
321!                   CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
322!                ENDIF
323!
324!                IF ( TRIM( var ) == 'u*'   )  unit = 'm/s'
325!                IF ( TRIM( var ) == 't*'   )  unit = 'K'
326!                IF ( TRIM( var ) == 'lwp*' )  unit = 'kg/kg*m'
327!                IF ( TRIM( var ) == 'pra*' )  unit = 'mm'
328!                IF ( TRIM( var ) == 'prr*' )  unit = 'mm/s'
329!                IF ( TRIM( var ) == 'z0*'  )  unit = 'm'
330
331             CASE ( 'p', 'pt', 'u', 'v', 'w' )
332                IF ( TRIM( var ) == 'p'  )  unit = 'Pa'
333                IF ( TRIM( var ) == 'pt' )  unit = 'K'
334                IF ( TRIM( var ) == 'u'  )  unit = 'm/s'
335                IF ( TRIM( var ) == 'v'  )  unit = 'm/s'
336                IF ( TRIM( var ) == 'w'  )  unit = 'm/s'
337                CONTINUE
338
339             CASE DEFAULT
340                CALL user_check_data_output( var, unit )
341
342                IF ( unit == 'illegal' )  THEN
343                   IF ( do_mask_user(mid,1) /= ' ' )  THEN
344                      WRITE ( message_string, * ) 'illegal value for data_',&
345                           'output or data_output_user: "', &
346                           TRIM( do_mask(mid,i) ), '"'
347                      CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
348                   ELSE
349                      WRITE ( message_string, * ) 'illegal value for data_',&
350                           'output: "', TRIM( do_mask(mid,i) ), '"'
351                      CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
352                   ENDIF
353                ENDIF
354
355          END SELECT
356!
357!--       Set the internal steering parameters appropriately
358          domask_no(mid,j)                    = domask_no(mid,j) + 1
359          domask(mid,j,domask_no(mid,j))      = do_mask(mid,i)
360          domask_unit(mid,j,domask_no(mid,j)) = unit
361
362          IF ( j == 1 )  THEN
363!
364!--          Check, if variable is already subject to averaging
365             found = .FALSE.
366             DO  k = 1, doav_n
367                IF ( TRIM( doav(k) ) == TRIM( var ) )  found = .TRUE.
368             ENDDO
369
370             IF ( .NOT. found )  THEN
371                doav_n = doav_n + 1
372                doav(doav_n) = var
373             ENDIF
374          ENDIF
375
376          i = i + 1
377
378       ENDDO   ! do_mask(mid,i)
379    ENDDO   ! mid
380
381
382!
383!-- Determine mask locations for each mask
384    DO  mid = 1, masks
385!
386!--    Set local masks for each subdomain along all three dimensions
387       CALL set_mask_locations( 1, dx, 'dx', nx, 'nx', nxl, nxr )
388       CALL set_mask_locations( 2, dy, 'dy', ny, 'ny', nys, nyn )
389       CALL set_mask_locations( 3, dz, 'dz', nz, 'nz', nzb, nzt )
390!
391!--    Set global masks along all three dimensions (required by
392!--    define_netcdf_header).
393#if defined( __parallel )
394!
395!--    PE0 receives partial arrays from all processors of the respective mask
396!--    and outputs them. Here a barrier has to be set, because otherwise
397!--    "-MPI- FATAL: Remote protocol queue full" may occur.
398       CALL MPI_BARRIER( comm2d, ierr )
399
400       IF ( myid == 0 )  THEN
401!
402!--       Local arrays can be relocated directly.
403          mask_i_global(mid,mask_start_l(mid,1): &
404                       mask_start_l(mid,1)+mask_size_l(mid,1)-1) = &
405                       mask_i(mid,:mask_size_l(mid,1))
406          mask_j_global(mid,mask_start_l(mid,2): &
407                       mask_start_l(mid,2)+mask_size_l(mid,2)-1) = &
408                       mask_j(mid,:mask_size_l(mid,2))
409          mask_k_global(mid,mask_start_l(mid,3): &
410                       mask_start_l(mid,3)+mask_size_l(mid,3)-1) = &
411                       mask_k(mid,:mask_size_l(mid,3))
412!
413!--       Receive data from all other PEs.
414          DO  n = 1, numprocs-1
415!
416!--          Receive index limits first, then arrays.
417!--          Index limits are received in arbitrary order from the PEs.
418             CALL MPI_RECV( ind(1), 6, MPI_INTEGER, MPI_ANY_SOURCE, 0,  &
419                  comm2d, status, ierr )
420!
421!--          Not all PEs have data for the mask.
422             IF ( ind(1) /= -9999 )  THEN
423                sender = status(MPI_SOURCE)
424                CALL MPI_RECV( tmp_array(ind(1)), ind(2)-ind(1)+1,  &
425                               MPI_INTEGER, sender, 1, comm2d, status, ierr )
426                mask_i_global(mid,ind(1):ind(2)) = tmp_array(ind(1):ind(2))
427                CALL MPI_RECV( tmp_array(ind(3)), ind(4)-ind(3)+1,  &
428                               MPI_INTEGER, sender, 2, comm2d, status, ierr )
429                mask_j_global(mid,ind(3):ind(4)) = tmp_array(ind(3):ind(4))
430                CALL MPI_RECV( tmp_array(ind(5)), ind(6)-ind(5)+1,  &
431                               MPI_INTEGER, sender, 3, comm2d, status, ierr )
432                mask_k_global(mid,ind(5):ind(6)) = tmp_array(ind(5):ind(6))
433             ENDIF
434          ENDDO
435
436       ELSE
437!
438!--       If at least part of the mask resides on the PE, send the index limits
439!--       for the target array, otherwise send -9999 to PE0.
440          IF ( mask_size_l(mid,1) > 0 .AND.  mask_size_l(mid,2) > 0 .AND. &
441               mask_size_l(mid,3) > 0  ) &
442               THEN
443             ind(1) = mask_start_l(mid,1)
444             ind(2) = mask_start_l(mid,1) + mask_size_l(mid,1) - 1
445             ind(3) = mask_start_l(mid,2)
446             ind(4) = mask_start_l(mid,2) + mask_size_l(mid,2) - 1
447             ind(5) = mask_start_l(mid,3)
448             ind(6) = mask_start_l(mid,3) + mask_size_l(mid,3) - 1
449          ELSE
450             ind(1) = -9999; ind(2) = -9999
451             ind(3) = -9999; ind(4) = -9999
452             ind(5) = -9999; ind(6) = -9999
453          ENDIF
454          CALL MPI_SEND( ind(1), 6, MPI_INTEGER, 0, 0, comm2d, ierr )
455!
456!--       If applicable, send data to PE0.
457          IF ( ind(1) /= -9999 )  THEN
458             tmp_array(:mask_size_l(mid,1)) = mask_i(mid,:mask_size_l(mid,1))
459             CALL MPI_SEND( tmp_array(1), mask_size_l(mid,1),  &
460                            MPI_INTEGER, 0, 1, comm2d, ierr )
461             tmp_array(:mask_size_l(mid,2)) = mask_j(mid,:mask_size_l(mid,2))
462             CALL MPI_SEND( tmp_array(1), mask_size_l(mid,2),  &
463                            MPI_INTEGER, 0, 2, comm2d, ierr )
464             tmp_array(:mask_size_l(mid,3)) = mask_k(mid,:mask_size_l(mid,3))
465             CALL MPI_SEND( tmp_array(1), mask_size_l(mid,3),  &
466                            MPI_INTEGER, 0, 3, comm2d, ierr )
467          ENDIF
468       ENDIF
469!
470!--    A barrier has to be set, because otherwise some PEs may proceed too fast
471!--    so that PE0 may receive wrong data on tag 0.
472       CALL MPI_BARRIER( comm2d, ierr )
473       
474       IF ( format_parallel_io )  THEN 
475         
476          CALL MPI_BCAST( mask_i_global(mid,:), nx+1, MPI_INTEGER, 0, comm2d, ierr )
477          CALL MPI_BCAST( mask_j_global(mid,:), ny+1, MPI_INTEGER, 0, comm2d, ierr )
478          CALL MPI_BCAST( mask_k_global(mid,:), nz+1, MPI_INTEGER, 0, comm2d, ierr ) 
479         
480       ENDIF
481
482#else
483!
484!--    Local arrays can be relocated directly.
485       mask_i_global(mid,:) = mask_i(mid,:)
486       mask_j_global(mid,:) = mask_j(mid,:)
487       mask_k_global(mid,:) = mask_k(mid,:)
488#endif
489    ENDDO   ! mid
490
491    DEALLOCATE( tmp_array )
492!
493!-- Internal mask arrays cannot be deallocated on PE 0 because they are
494!-- required for header output on PE 0.
495    IF ( myid /= 0 )  DEALLOCATE( mask, mask_loop )
496
497 CONTAINS
498    SUBROUTINE set_mask_locations( dim, dxyz, dxyz_string, nxyz, nxyz_string, &
499                                   lb, ub )
500!------------------------------------------------------------------------------!
501!
502! Description:
503! ------------
504! Set local mask for each subdomain along 'dim' direction.
505!------------------------------------------------------------------------------!
506
507       IMPLICIT NONE
508
509       CHARACTER (LEN=2) :: dxyz_string, nxyz_string
510       INTEGER  ::  count, count_l, dim, m, loop_begin, loop_end, loop_stride, &
511                    lb, nxyz, ub
512       REAL     ::  dxyz, ddxyz, tmp1, tmp2
513
514       count = 0;  count_l = 0;  ddxyz = 1.0 / dxyz;  tmp1 = 0.0;  tmp2 = 0.0
515
516       IF ( mask(mid,dim,1) >= 0.0 )  THEN
517!
518!--       use predefined mask_* array
519          DO  WHILE ( mask(mid,dim,count+1) >= 0.0 )
520             count = count + 1
521             IF ( dim == 1 .OR. dim == 2 )  THEN
522                m = NINT( mask(mid,dim,count) * mask_scale(dim) * ddxyz )
523             ELSEIF ( dim == 3 )  THEN
524                ind_array =  &
525                     MINLOC( ABS( mask(mid,dim,count) * mask_scale(dim) - zw ) )
526                m = ind_array(1) - 1 + nzb  ! MINLOC uses lower array bound 1
527             ENDIF
528             IF ( m > nxyz )  THEN
529                WRITE ( message_string, '(I3,A,I3,A,I1,3A,I3)' )  &
530                     m,' in mask ',mid,' along dimension ',dim,  &
531                     ' exceeds ',nxyz_string,' = ',nxyz
532                CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
533             ENDIF
534             IF ( m >= lb .AND. m <= ub )  THEN
535                IF ( count_l == 0 )  mask_start_l(mid,dim) = count
536                count_l = count_l + 1
537                IF ( dim == 1 )  THEN
538                   mask_i(mid,count_l) = m
539                ELSEIF ( dim == 2 )  THEN
540                   mask_j(mid,count_l) = m
541                ELSEIF ( dim == 3 )  THEN
542                   mask_k(mid,count_l) = m
543                ENDIF
544             ENDIF
545             IF ( count == mask_xyz_dimension )  EXIT
546          ENDDO
547          mask_size(mid,dim)   = count
548          mask_size_l(mid,dim) = count_l
549
550       ELSE
551!
552!--       use predefined mask_loop_* array, or use the default (all grid points
553!--       along this direction)
554          IF ( mask_loop(mid,dim,1) < 0.0 )  THEN
555             tmp1 = mask_loop(mid,dim,1)
556             mask_loop(mid,dim,1) = 0.0   ! (default)
557          ENDIF
558          IF ( dim == 1 .OR. dim == 2 )  THEN
559             IF ( mask_loop(mid,dim,2) < 0.0 )  THEN
560                tmp2 = mask_loop(mid,dim,2)
561                mask_loop(mid,dim,2) = nxyz*dxyz / mask_scale(dim)   ! (default)
562             ENDIF
563             IF ( MAXVAL( mask_loop(mid,dim,1:2) )  &
564                  > nxyz * dxyz / mask_scale(dim) )  THEN
565                WRITE ( message_string, '(2(A,I3,A,I1,A,F9.3),5A,I1,A,F9.3)' ) &
566                     'mask_loop(',mid,',',dim,',1)=',mask_loop(mid,dim,1), &
567                     ' and/or mask_loop(',mid,',',dim,',2)=', &
568                     mask_loop(mid,dim,2),'&exceed ', &
569                     nxyz_string,'*',dxyz_string,'/mask_scale(',dim,')=', &
570                     nxyz*dxyz/mask_scale(dim)
571                CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
572             ENDIF
573             loop_begin  = NINT( mask_loop(mid,dim,1) * mask_scale(dim) * ddxyz )
574             loop_end    = NINT( mask_loop(mid,dim,2) * mask_scale(dim) * ddxyz )
575             loop_stride = NINT( mask_loop(mid,dim,3) * mask_scale(dim) * ddxyz )
576          ELSEIF ( dim == 3 )  THEN
577             IF ( mask_loop(mid,dim,2) < 0.0 )  THEN
578                tmp2 = mask_loop(mid,dim,2)
579                mask_loop(mid,dim,2) = zw(nz) / mask_scale(dim)   ! (default)
580             ENDIF
581             IF ( MAXVAL( mask_loop(mid,dim,1:2) )  &
582                  > zw(nz) / mask_scale(dim) )  THEN
583                WRITE ( message_string, '(2(A,I3,A,I1,A,F9.3),A,I1,A,F9.3)' ) &
584                     'mask_loop(',mid,',',dim,',1)=',mask_loop(mid,dim,1), &
585                     ' and/or mask_loop(',mid,',',dim,',2)=', &
586                     mask_loop(mid,dim,2),'&exceed zw(nz)/mask_scale(',dim, &
587                     ')=',zw(nz)/mask_scale(dim)
588                CALL message( 'init_masks', 'PA9998', 1, 2, 0, 6, 0 )
589             ENDIF
590             ind_array =  &
591                  MINLOC( ABS( mask_loop(mid,dim,1) * mask_scale(dim) - zw ) )
592             loop_begin =  &
593                  ind_array(1) - 1 + nzb ! MINLOC uses lower array bound 1
594             ind_array =  &
595                  MINLOC( ABS( mask_loop(mid,dim,2) * mask_scale(dim) - zw ) )
596             loop_end = ind_array(1) - 1 + nzb ! MINLOC uses lower array bound 1
597!
598!--          The following line assumes a constant vertical grid spacing within
599!--          the vertical mask range; it fails for vertical grid stretching.
600!--          Maybe revise later. Issue warning but continue execution.
601             loop_stride = NINT( mask_loop(mid,dim,3) * mask_scale(dim) * ddxyz )
602
603             IF ( mask_loop(mid,dim,2) * mask_scale(dim) > dz_stretch_level )  &
604                  THEN
605                WRITE ( message_string, '(A,I3,A,I1,A,F9.3,A,F8.2,3A)' )  &
606                     'mask_loop(',mid,dim,',2)=', mask_loop(mid,dim,2),&
607                     ' exceeds dz_stretch_level=',dz_stretch_level, &
608                     '.&Vertical mask locations will not ', &
609                     'match the desired heights&within the stretching ', &
610                     'region. Recommendation: use mask instead of mask_loop.'
611                CALL message( 'init_masks', 'PA9998', 0, 1, 0, 6, 0 )
612             ENDIF
613
614          ENDIF
615!
616!--       If necessary, reset mask_loop(mid,dim,1) and mask_loop(mid,dim,2).
617          IF ( tmp1 < 0.0 )  mask_loop(mid,dim,1) = tmp1
618          IF ( tmp2 < 0.0 )  mask_loop(mid,dim,2) = tmp2
619!
620!--       The default stride +/-1 (every grid point) applies if
621!--       mask_loop(mid,dim,3) is not specified (its default is zero).
622          IF ( loop_stride == 0 )  THEN
623             IF ( loop_end >= loop_begin )  THEN
624                loop_stride =  1
625             ELSE
626                loop_stride = -1
627             ENDIF
628          ENDIF
629          DO  m = loop_begin, loop_end, loop_stride
630             count = count + 1
631             IF ( m >= lb .AND. m <= ub )  THEN
632                IF ( count_l == 0 )  mask_start_l(mid,dim) = count
633                count_l = count_l + 1
634                IF ( dim == 1 )  THEN
635                   mask_i(mid,count_l) = m
636                ELSEIF ( dim == 2 )  THEN
637                   mask_j(mid,count_l) = m
638                ELSEIF ( dim == 3 )  THEN
639                   mask_k(mid,count_l) = m
640                ENDIF
641             ENDIF
642          ENDDO
643          mask_size(mid,dim)   = count
644          mask_size_l(mid,dim) = count_l
645       ENDIF
646
647    END SUBROUTINE set_mask_locations
648
649 END SUBROUTINE init_masks
Note: See TracBrowser for help on using the repository browser.