source: palm/trunk/SOURCE/init_pegrid.f90 @ 2516

Last change on this file since 2516 was 2516, checked in by suehring, 7 years ago

document changes

  • Property svn:keywords set to Id
File size: 48.5 KB
Line 
1!> @file init_pegrid.f90
2!------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
17! Copyright 1997-2017 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: init_pegrid.f90 2516 2017-10-04 11:03:04Z suehring $
27! Remove tabs
28!
29! 2514 2017-10-04 09:52:37Z suehring
30! Redundant preprocessor directives removed
31!
32! 2372 2017-08-25 12:37:32Z sward
33! Shifted cyclic boundary conditions implemented
34!
35! 2365 2017-08-21 14:59:59Z kanani
36! Vertical nesting implemented (SadiqHuq)
37!
38! 2300 2017-06-29 13:31:14Z raasch
39! host-specific settings removed
40!
41! 2298 2017-06-29 09:28:18Z raasch
42! MPI2 related parts removed
43!
44! 2271 2017-06-09 12:34:55Z sward
45! Error message changed
46!
47! 2259 2017-06-08 09:09:11Z gronemeier
48! Implemented synthetic turbulence generator
49!
50! 2238 2017-05-31 16:49:16Z suehring
51! Remove unnecessary module load of pmc_interface
52!
53! 2231 2017-05-30 16:44:33Z suehring
54!
55! 2200 2017-04-11 11:37:51Z suehring
56! monotonic_adjustment removed
57!
58! 2197 2017-03-24 02:25:00Z raasch
59! bugfix: do not allow odd values for nz at the coarsest grid level in case of
60! optimized multigrid solver
61!
62! 2180 2017-03-17 13:33:05Z hellstea
63! Checks to ensure (2178) that pdims match the grid dimensions in the
64! automatic determination of pdims are canceled as unnecessary
65!
66! 2178 2017-03-17 11:07:39Z hellstea
67! Checks to ensure that pdims match the grid dimensions are added in the
68! automatic determination of pdims
69!
70! 2050 2016-11-08 15:00:55Z gronemeier
71! Implement turbulent outflow condition
72!
73! 2000 2016-08-20 18:09:15Z knoop
74! Forced header and separation lines into 80 columns
75!
76! 1968 2016-07-18 12:01:49Z suehring
77! Extent MPI-datatypes for exchange of 2D-INTEGER arrays on coarser multigrid
78! level 
79!
80! 1964 2016-07-14 15:35:18Z hellstea
81! Bugfix: erroneous setting of nest_bound_l/r/s/n = .TRUE. for vertical nesting mode removed.
82!
83! 1923 2016-05-31 16:37:07Z boeske
84! Initial version of purely vertical nesting introduced.
85!
86! 1922 2016-05-31 16:36:08Z boeske
87! Bugfix: array transposition checks restricted to cases if a fourier
88! transform is used , removed unused variable nnx_z
89!
90! 1833 2016-04-07 14:23:03Z raasch
91! spectra related variables moved to spectra_mod
92!
93! 1815 2016-04-06 13:49:59Z raasch
94! cpp-directives for intel openmp bug removed
95!
96! 1804 2016-04-05 16:30:18Z maronga
97! Removed code for parameter file check (__check)
98!
99! 1779 2016-03-03 08:01:28Z raasch
100! changes regarding nested domain removed: virtual PE grid will be automatically
101! calculated for nested runs too
102!
103! 1764 2016-02-28 12:45:19Z raasch
104! cpp-statements for nesting removed
105!
106! 1762 2016-02-25 12:31:13Z hellstea
107! Introduction of nested domain feature
108!
109! 1682 2015-10-07 23:56:08Z knoop
110! Code annotations made doxygen readable
111!
112! 1677 2015-10-02 13:25:23Z boeske
113! New MPI-data types for exchange of 3D integer arrays.
114!
115! 1575 2015-03-27 09:56:27Z raasch
116! adjustments for psolver-queries, calculation of ngp_xz added
117!
118! 1565 2015-03-09 20:59:31Z suehring
119! Refine if-clause for setting nbgp.
120!
121! 1557 2015-03-05 16:43:04Z suehring
122! Adjustment for monotonic limiter
123!
124! 1468 2014-09-24 14:06:57Z maronga
125! Adapted for use on up to 6-digit processor cores
126!
127! 1435 2014-07-21 10:37:02Z keck
128! bugfix: added missing parameter coupling_mode_remote to ONLY-attribute
129!
130! 1402 2014-05-09 14:25:13Z raasch
131! location messages modified
132!
133! 1384 2014-05-02 14:31:06Z raasch
134! location messages added
135!
136! 1353 2014-04-08 15:21:23Z heinze
137! REAL constants provided with KIND-attribute
138!
139! 1322 2014-03-20 16:38:49Z raasch
140! REAL functions provided with KIND-attribute
141!
142! 1320 2014-03-20 08:40:49Z raasch
143! ONLY-attribute added to USE-statements,
144! kind-parameters added to all INTEGER and REAL declaration statements,
145! kinds are defined in new module kinds,
146! revision history before 2012 removed,
147! comment fields (!:) to be used for variable explanations added to
148! all variable declaration statements
149!
150! 1304 2014-03-12 10:29:42Z raasch
151! bugfix: single core MPI runs missed some settings of transpose indices
152!
153! 1212 2013-08-15 08:46:27Z raasch
154! error message for poisfft_hybrid removed
155!
156! 1159 2013-05-21 11:58:22Z fricke
157! dirichlet/neumann and neumann/dirichlet removed
158!
159! 1139 2013-04-18 07:25:03Z raasch
160! bugfix for calculating the id of the PE carrying the recycling plane
161!
162! 1111 2013-03-08 23:54:10Z raasch
163! initialization of poisfft moved to module poisfft
164!
165! 1092 2013-02-02 11:24:22Z raasch
166! unused variables removed
167!
168! 1056 2012-11-16 15:28:04Z raasch
169! Indices for arrays n.._mg start from zero due to definition of arrays f2 and
170! p2 as automatic arrays in recursive subroutine next_mg_level
171!
172! 1041 2012-11-06 02:36:29Z raasch
173! a 2d virtual processor topology is used by default for all machines
174!
175! 1036 2012-10-22 13:43:42Z raasch
176! code put under GPL (PALM 3.9)
177!
178! 1003 2012-09-14 14:35:53Z raasch
179! subdomains must have identical size (grid matching = "match" removed)
180!
181! 1001 2012-09-13 14:08:46Z raasch
182! all actions concerning upstream-spline-method removed
183!
184! 978 2012-08-09 08:28:32Z fricke
185! dirichlet/neumann and neumann/dirichlet added
186! nxlu and nysv are also calculated for inflow boundary
187!
188! 809 2012-01-30 13:32:58Z maronga
189! Bugfix: replaced .AND. and .NOT. with && and ! in the preprocessor directives
190!
191! 807 2012-01-25 11:53:51Z maronga
192! New cpp directive "__check" implemented which is used by check_namelist_files
193!
194! Revision 1.1  1997/07/24 11:15:09  raasch
195! Initial revision
196!
197!
198! Description:
199! ------------
200!> Determination of the virtual processor topology (if not prescribed by the
201!> user)and computation of the grid point number and array bounds of the local
202!> domains.
203!------------------------------------------------------------------------------!
204 SUBROUTINE init_pegrid
205 
206
207    USE control_parameters,                                                    &
208        ONLY:  bc_lr, bc_ns, coupling_mode, coupling_mode_remote,              &
209               coupling_topology, gathered_size, grid_level,                   &
210               grid_level_count, inflow_l, inflow_n, inflow_r, inflow_s,       &
211               io_blocks, io_group, maximum_grid_level,                        &
212               maximum_parallel_io_streams, message_string,                    &
213               mg_switch_to_pe0_level, momentum_advec, nest_bound_l,           &
214               nest_bound_n, nest_bound_r, nest_bound_s, nest_domain, neutral, &
215               psolver, outflow_l, outflow_n, outflow_r, outflow_s,            &
216               outflow_source_plane, recycling_width, scalar_advec,            &
217               subdomain_size, turbulent_outflow, y_shift
218
219    USE grid_variables,                                                        &
220        ONLY:  dx
221       
222    USE indices,                                                               &
223        ONLY:  mg_loc_ind, nbgp, nnx, nny, nnz, nx, nx_a, nx_o, nxl, nxl_mg,   &
224               nxlu, nxr, nxr_mg, ny, ny_a, ny_o, nyn, nyn_mg, nys, nys_mg,    &
225               nysv, nz, nzb, nzt, nzt_mg, wall_flags_1, wall_flags_2,         &
226               wall_flags_3, wall_flags_4, wall_flags_5, wall_flags_6,         &
227               wall_flags_7, wall_flags_8, wall_flags_9, wall_flags_10
228
229    USE kinds
230     
231    USE pegrid
232     
233    USE spectra_mod,                                                           &
234        ONLY:  calculate_spectra, dt_dosp
235
236    USE synthetic_turbulence_generator_mod,                                    &
237        ONLY:  use_synthetic_turbulence_generator
238
239    USE transpose_indices,                                                     &
240        ONLY:  nxl_y, nxl_yd, nxl_z, nxr_y, nxr_yd, nxr_z, nyn_x, nyn_z, nys_x,&
241               nys_z, nzb_x, nzb_y, nzb_yd, nzt_x, nzt_yd, nzt_y
242
243    USE vertical_nesting_mod,                                                  &
244        ONLY:  vnested, vnest_init_pegrid_domain, vnest_init_pegrid_rank
245
246    IMPLICIT NONE
247
248    INTEGER(iwp) ::  i                        !<
249    INTEGER(iwp) ::  id_inflow_l              !<
250    INTEGER(iwp) ::  id_outflow_l             !< local value of id_outflow
251    INTEGER(iwp) ::  id_outflow_source_l      !< local value of id_outflow_source
252    INTEGER(iwp) ::  id_recycling_l           !<
253    INTEGER(iwp) ::  ind(5)                   !<
254    INTEGER(iwp) ::  j                        !<
255    INTEGER(iwp) ::  k                        !<
256    INTEGER(iwp) ::  maximum_grid_level_l     !<
257    INTEGER(iwp) ::  mg_levels_x              !<
258    INTEGER(iwp) ::  mg_levels_y              !<
259    INTEGER(iwp) ::  mg_levels_z              !<
260    INTEGER(iwp) ::  mg_switch_to_pe0_level_l !<
261    INTEGER(iwp) ::  nnx_y                    !<
262    INTEGER(iwp) ::  nnx_z                    !<
263    INTEGER(iwp) ::  nny_x                    !<
264    INTEGER(iwp) ::  nny_z                    !<
265    INTEGER(iwp) ::  nnz_x                    !<
266    INTEGER(iwp) ::  nnz_y                    !<
267    INTEGER(iwp) ::  numproc_sqr              !<
268    INTEGER(iwp) ::  nxl_l                    !<
269    INTEGER(iwp) ::  nxr_l                    !<
270    INTEGER(iwp) ::  nyn_l                    !<
271    INTEGER(iwp) ::  nys_l                    !<
272    INTEGER(iwp) ::  nzb_l                    !<
273    INTEGER(iwp) ::  nzt_l                    !<
274    INTEGER(iwp) ::  omp_get_num_threads      !<
275
276    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  ind_all !<
277    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxlf    !<
278    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nxrf    !<
279    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nynf    !<
280    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  nysf    !<
281
282    INTEGER(iwp), DIMENSION(2) ::  pdims_remote         !<
283    INTEGER(iwp)               ::  lcoord(2)            !< PE coordinates of left neighbor along x and y
284    INTEGER(iwp)               ::  rcoord(2)            !< PE coordinates of right neighbor along x and y
285
286!
287!-- Get the number of OpenMP threads
288    !$OMP PARALLEL
289!$  threads_per_task = omp_get_num_threads()
290    !$OMP END PARALLEL
291
292
293#if defined( __parallel )
294
295    CALL location_message( 'creating virtual PE grids + MPI derived data types', &
296                           .FALSE. )
297
298!
299!-- Determine the processor topology or check it, if prescribed by the user
300    IF ( npex == -1  .AND.  npey == -1 )  THEN
301
302!
303!--    Automatic determination of the topology
304       numproc_sqr = SQRT( REAL( numprocs, KIND=wp ) )
305       pdims(1)    = MAX( numproc_sqr , 1 )
306       DO  WHILE ( MOD( numprocs , pdims(1) ) /= 0 )
307          pdims(1) = pdims(1) - 1
308       ENDDO
309       pdims(2) = numprocs / pdims(1)
310
311    ELSEIF ( npex /= -1  .AND.  npey /= -1 )  THEN
312
313!
314!--    Prescribed by user. Number of processors on the prescribed topology
315!--    must be equal to the number of PEs available to the job
316       IF ( ( npex * npey ) /= numprocs )  THEN
317          WRITE( message_string, * ) 'number of PEs of the prescribed ',   &
318              'topology (', npex*npey,') does not match & the number of ', &
319              'PEs available to the job (', numprocs, ')'
320          CALL message( 'init_pegrid', 'PA0221', 1, 2, 0, 6, 0 )
321       ENDIF
322       pdims(1) = npex
323       pdims(2) = npey
324
325    ELSE
326!
327!--    If the processor topology is prescribed by the user, the number of
328!--    PEs must be given in both directions
329       message_string = 'if the processor topology is prescribed by th' //  &
330                'e user& both values of "npex" and "npey" must be given' // &
331                ' in the &NAMELIST-parameter file'
332       CALL message( 'init_pegrid', 'PA0222', 1, 2, 0, 6, 0 )
333
334    ENDIF
335
336!
337!-- If necessary, set horizontal boundary conditions to non-cyclic
338    IF ( bc_lr /= 'cyclic' )  cyclic(1) = .FALSE.
339    IF ( bc_ns /= 'cyclic' )  cyclic(2) = .FALSE.
340
341
342!
343!-- Create the virtual processor grid
344    CALL MPI_CART_CREATE( comm_palm, ndim, pdims, cyclic, reorder, &
345                          comm2d, ierr )
346    CALL MPI_COMM_RANK( comm2d, myid, ierr )
347    WRITE (myid_char,'(''_'',I6.6)')  myid
348
349    CALL MPI_CART_COORDS( comm2d, myid, ndim, pcoord, ierr )
350    CALL MPI_CART_SHIFT( comm2d, 0, 1, pleft, pright, ierr )
351    CALL MPI_CART_SHIFT( comm2d, 1, 1, psouth, pnorth, ierr )
352
353!
354!-- In case of cyclic boundary conditions, a y-shift at the boundaries in
355!-- x-direction can be introduced via parameter y_shift. The shift is done
356!-- by modifying the processor grid in such a way that processors located
357!-- at the x-boundary communicate across it to processors with y-coordinate
358!-- shifted by y_shift relative to their own. This feature can not be used
359!-- in combination with an fft pressure solver. It has been implemented to
360!-- counter the effect of streak structures in case of cyclic boundary
361!-- conditions. For a description of these see Munters
362!-- (2016; dx.doi.org/10.1063/1.4941912)
363!--
364!-- Get coordinates of left and right neighbor on PE grid
365    IF ( y_shift /= 0 ) THEN
366
367       IF ( bc_lr /= 'cyclic'  .OR.  bc_ns /= 'cyclic' )  THEN
368          message_string = 'y_shift /= 0 is only allowed for cyclic ' //       &
369                           'boundary conditions in both directions '
370          CALL message( 'check_parameters', 'PA0467', 1, 2, 0, 6, 0 )
371       ENDIF
372       IF ( TRIM( psolver ) /= 'multigrid' .AND.                               &
373            TRIM( psolver ) /= 'multigrid_noopt')                              &
374       THEN
375          message_string = 'y_shift /= 0 requires a multigrid pressure solver '
376          CALL message( 'check_parameters', 'PA0468', 1, 2, 0, 6, 0 )
377       ENDIF
378
379       CALL MPI_CART_COORDS( comm2d, pright, ndim, rcoord, ierr )
380       CALL MPI_CART_COORDS( comm2d, pleft, ndim, lcoord, ierr )
381
382!
383!--    If the x(y)-coordinate of the right (left) neighbor is smaller (greater)
384!--    than that of the calling process, then the calling process is located on
385!--    the right (left) boundary of the processor grid. In that case,
386!--    the y-coordinate of that neighbor is increased (decreased) by y_shift.
387!--    The rank of the process with that coordinate is then inquired and the
388!--    neighbor rank for MPI_SENDRECV, pright (pleft) is set to it.
389!--    In this way, the calling process receives a new right (left) neighbor
390!--    for all future MPI_SENDRECV calls. That neighbor has a y-coordinate
391!--    of y+(-)y_shift, where y is the original right (left) neighbor's
392!--    y-coordinate. The modulo-operation ensures that if the neighbor's
393!--    y-coordinate exceeds the grid-boundary, it will be relocated to
394!--    the opposite part of the grid cyclicly.
395       IF ( rcoord(1) < pcoord(1) ) THEN
396          rcoord(2) = MODULO( rcoord(2) + y_shift, pdims(2) )
397          CALL MPI_CART_RANK( comm2d, rcoord, pright, ierr )
398       ENDIF
399
400       IF ( lcoord(1) > pcoord(1) ) THEN
401          lcoord(2) = MODULO( lcoord(2) - y_shift, pdims(2) )
402          CALL MPI_CART_RANK( comm2d, lcoord, pleft, ierr )
403       ENDIF
404    ENDIF
405
406!
407!-- Vertical nesting: store four lists that identify partner ranks to exchange
408!-- data
409    IF ( vnested )  CALL vnest_init_pegrid_rank
410
411!
412!-- Determine sub-topologies for transpositions
413!-- Transposition from z to x:
414    remain_dims(1) = .TRUE.
415    remain_dims(2) = .FALSE.
416    CALL MPI_CART_SUB( comm2d, remain_dims, comm1dx, ierr )
417    CALL MPI_COMM_RANK( comm1dx, myidx, ierr )
418!
419!-- Transposition from x to y
420    remain_dims(1) = .FALSE.
421    remain_dims(2) = .TRUE.
422    CALL MPI_CART_SUB( comm2d, remain_dims, comm1dy, ierr )
423    CALL MPI_COMM_RANK( comm1dy, myidy, ierr )
424
425
426!
427!-- Calculate array bounds along x-direction for every PE.
428    ALLOCATE( nxlf(0:pdims(1)-1), nxrf(0:pdims(1)-1), nynf(0:pdims(2)-1), &
429              nysf(0:pdims(2)-1) )
430
431    IF ( MOD( nx+1 , pdims(1) ) /= 0 )  THEN
432       WRITE( message_string, * ) 'x-direction: gridpoint number (',nx+1,') ',&
433                               'is not an& integral divisor of the number ',  &
434                               'processors (', pdims(1),')'
435       CALL message( 'init_pegrid', 'PA0225', 1, 2, 0, 6, 0 )
436    ELSE
437       nnx  = ( nx + 1 ) / pdims(1)
438       IF ( nnx*pdims(1) - ( nx + 1) > nnx )  THEN
439          WRITE( message_string, * ) 'x-direction: nx does not match the',    & 
440                       'requirements given by the number of PEs &used',       &
441                       '& please use nx = ', nx - ( pdims(1) - ( nnx*pdims(1) &
442                                      - ( nx + 1 ) ) ), ' instead of nx =', nx
443          CALL message( 'init_pegrid', 'PA0226', 1, 2, 0, 6, 0 )
444       ENDIF
445    ENDIF   
446
447!
448!-- Left and right array bounds, number of gridpoints
449    DO  i = 0, pdims(1)-1
450       nxlf(i)   = i * nnx
451       nxrf(i)   = ( i + 1 ) * nnx - 1
452    ENDDO
453
454!
455!-- Calculate array bounds in y-direction for every PE.
456    IF ( MOD( ny+1 , pdims(2) ) /= 0 )  THEN
457       WRITE( message_string, * ) 'y-direction: gridpoint number (',ny+1,') ', &
458                           'is not an& integral divisor of the number of',     &
459                           'processors (', pdims(2),')'
460       CALL message( 'init_pegrid', 'PA0227', 1, 2, 0, 6, 0 )
461    ELSE
462       nny  = ( ny + 1 ) / pdims(2)
463       IF ( nny*pdims(2) - ( ny + 1) > nny )  THEN
464          WRITE( message_string, * ) 'y-direction: ny does not match the',    &
465                       'requirements given by the number of PEs &used ',      &
466                       '& please use ny = ', ny - ( pdims(2) - ( nnx*pdims(2) &
467                                     - ( ny + 1 ) ) ), ' instead of ny =', ny
468          CALL message( 'init_pegrid', 'PA0228', 1, 2, 0, 6, 0 )
469       ENDIF
470    ENDIF   
471
472!
473!-- South and north array bounds
474    DO  j = 0, pdims(2)-1
475       nysf(j)   = j * nny
476       nynf(j)   = ( j + 1 ) * nny - 1
477    ENDDO
478
479!
480!-- Local array bounds of the respective PEs
481    nxl = nxlf(pcoord(1))
482    nxr = nxrf(pcoord(1))
483    nys = nysf(pcoord(2))
484    nyn = nynf(pcoord(2))
485    nzb = 0
486    nzt = nz
487    nnz = nz
488
489!
490!-- Set switches to define if the PE is situated at the border of the virtual
491!-- processor grid
492    IF ( nxl == 0 )   left_border_pe  = .TRUE.
493    IF ( nxr == nx )  right_border_pe = .TRUE.
494    IF ( nys == 0 )   south_border_pe = .TRUE.
495    IF ( nyn == ny )  north_border_pe = .TRUE.
496
497!
498!-- Calculate array bounds and gridpoint numbers for the transposed arrays
499!-- (needed in the pressure solver)
500!-- For the transposed arrays, cyclic boundaries as well as top and bottom
501!-- boundaries are omitted, because they are obstructive to the transposition
502
503!
504!-- 1. transposition  z --> x
505!-- This transposition is not neccessary in case of a 1d-decomposition along x
506    IF ( psolver == 'poisfft'  .OR.  calculate_spectra  .OR.                   &
507         use_synthetic_turbulence_generator )  THEN
508
509       IF ( pdims(2) /= 1 )  THEN
510          IF ( MOD( nz , pdims(1) ) /= 0 )  THEN
511             WRITE( message_string, * ) 'transposition z --> x:',              &
512                       '&nz=',nz,' is not an integral divisior of pdims(1)=',  &
513                                                                   pdims(1)
514             CALL message( 'init_pegrid', 'PA0230', 1, 2, 0, 6, 0 )
515          ENDIF
516       ENDIF
517
518       nys_x = nys
519       nyn_x = nyn
520       nny_x = nny
521       nnz_x = nz / pdims(1)
522       nzb_x = 1 + myidx * nnz_x
523       nzt_x = ( myidx + 1 ) * nnz_x
524       sendrecvcount_zx = nnx * nny * nnz_x
525
526    ENDIF
527
528
529    IF ( psolver == 'poisfft' )  THEN 
530!
531!--    2. transposition  x --> y
532       IF ( MOD( nx+1 , pdims(2) ) /= 0 )  THEN
533          WRITE( message_string, * ) 'transposition x --> y:',                 &
534                            '&nx+1=',nx+1,' is not an integral divisor of ',   &
535                            'pdims(2)=',pdims(2)
536          CALL message( 'init_pegrid', 'PA0231', 1, 2, 0, 6, 0 )
537       ENDIF
538
539       nnz_y = nnz_x
540       nzb_y = nzb_x
541       nzt_y = nzt_x
542       nnx_y = (nx+1) / pdims(2)
543       nxl_y = myidy * nnx_y
544       nxr_y = ( myidy + 1 ) * nnx_y - 1
545       sendrecvcount_xy = nnx_y * nny_x * nnz_y
546!
547!--    3. transposition  y --> z 
548!--    (ELSE:  x --> y  in case of 1D-decomposition along x)
549       nxl_z = nxl_y
550       nxr_z = nxr_y
551       nny_z = (ny+1) / pdims(1)
552       nys_z = myidx * nny_z
553       nyn_z = ( myidx + 1 ) * nny_z - 1
554       sendrecvcount_yz = nnx_y * nny_z * nnz_y
555
556       IF ( pdims(2) /= 1 )  THEN
557!
558!--       y --> z
559!--       This transposition is not neccessary in case of a 1d-decomposition
560!--       along x, except that the uptream-spline method is switched on
561          IF ( MOD( ny+1 , pdims(1) ) /= 0 )  THEN
562             WRITE( message_string, * ) 'transposition y --> z:',              &
563                               '& ny+1=',ny+1,' is not an integral divisor of',&
564                               ' pdims(1)=',pdims(1)
565             CALL message( 'init_pegrid', 'PA0232', 1, 2, 0, 6, 0 )
566          ENDIF
567
568       ELSE
569!
570!--       x --> y
571!--       This condition must be fulfilled for a 1D-decomposition along x
572          IF ( MOD( ny+1 , pdims(1) ) /= 0 )  THEN
573             WRITE( message_string, * ) 'transposition x --> y:',              &
574                               '& ny+1=',ny+1,' is not an integral divisor of',&
575                               ' pdims(1)=',pdims(1)
576             CALL message( 'init_pegrid', 'PA0233', 1, 2, 0, 6, 0 )
577          ENDIF
578
579       ENDIF
580
581    ENDIF
582
583!
584!-- Indices for direct transpositions z --> y (used for calculating spectra)
585    IF ( calculate_spectra )  THEN
586       IF ( MOD( nz, pdims(2) ) /= 0 )  THEN
587          WRITE( message_string, * ) 'direct transposition z --> y (needed ',  &
588                    'for spectra):& nz=',nz,' is not an integral divisor of ', &
589                    'pdims(2)=',pdims(2)
590          CALL message( 'init_pegrid', 'PA0234', 1, 2, 0, 6, 0 )
591       ELSE
592          nxl_yd = nxl
593          nxr_yd = nxr
594          nzb_yd = 1 + myidy * ( nz / pdims(2) )
595          nzt_yd = ( myidy + 1 ) * ( nz / pdims(2) )
596          sendrecvcount_zyd = nnx * nny * ( nz / pdims(2) )
597       ENDIF
598    ENDIF
599
600    IF ( psolver == 'poisfft'  .OR.  calculate_spectra )  THEN
601!
602!--    Indices for direct transpositions y --> x
603!--    (they are only possible in case of a 1d-decomposition along x)
604       IF ( pdims(2) == 1 )  THEN
605          nny_x = nny / pdims(1)
606          nys_x = myid * nny_x
607          nyn_x = ( myid + 1 ) * nny_x - 1
608          nzb_x = 1
609          nzt_x = nz
610          sendrecvcount_xy = nnx * nny_x * nz
611       ENDIF
612
613    ENDIF
614
615    IF ( psolver == 'poisfft' )  THEN
616!
617!--    Indices for direct transpositions x --> y
618!--    (they are only possible in case of a 1d-decomposition along y)
619       IF ( pdims(1) == 1 )  THEN
620          nnx_y = nnx / pdims(2)
621          nxl_y = myid * nnx_y
622          nxr_y = ( myid + 1 ) * nnx_y - 1
623          nzb_y = 1
624          nzt_y = nz
625          sendrecvcount_xy = nnx_y * nny * nz
626       ENDIF
627
628    ENDIF
629
630!
631!-- Arrays for storing the array bounds are needed any more
632    DEALLOCATE( nxlf , nxrf , nynf , nysf )
633
634
635!
636!-- Collect index bounds from other PEs (to be written to restart file later)
637    ALLOCATE( hor_index_bounds(4,0:numprocs-1) )
638
639    IF ( myid == 0 )  THEN
640
641       hor_index_bounds(1,0) = nxl
642       hor_index_bounds(2,0) = nxr
643       hor_index_bounds(3,0) = nys
644       hor_index_bounds(4,0) = nyn
645
646!
647!--    Receive data from all other PEs
648       DO  i = 1, numprocs-1
649          CALL MPI_RECV( ibuf, 4, MPI_INTEGER, i, MPI_ANY_TAG, comm2d, status, &
650                         ierr )
651          hor_index_bounds(:,i) = ibuf(1:4)
652       ENDDO
653
654    ELSE
655!
656!--    Send index bounds to PE0
657       ibuf(1) = nxl
658       ibuf(2) = nxr
659       ibuf(3) = nys
660       ibuf(4) = nyn
661       CALL MPI_SEND( ibuf, 4, MPI_INTEGER, 0, myid, comm2d, ierr )
662
663    ENDIF
664
665
666#if defined( __print )
667!
668!-- Control output
669    IF ( myid == 0 )  THEN
670       PRINT*, '*** processor topology ***'
671       PRINT*, ' '
672       PRINT*, 'myid   pcoord    left right  south north  idx idy   nxl: nxr',&
673               &'   nys: nyn'
674       PRINT*, '------------------------------------------------------------',&
675               &'-----------'
676       WRITE (*,1000)  0, pcoord(1), pcoord(2), pleft, pright, psouth, pnorth, &
677                       myidx, myidy, nxl, nxr, nys, nyn
6781000   FORMAT (I4,2X,'(',I3,',',I3,')',3X,I4,2X,I4,3X,I4,2X,I4,2X,I3,1X,I3, &
679               2(2X,I4,':',I4))
680
681!
682!--    Receive data from the other PEs
683       DO  i = 1,numprocs-1
684          CALL MPI_RECV( ibuf, 12, MPI_INTEGER, i, MPI_ANY_TAG, comm2d, status, &
685                         ierr )
686          WRITE (*,1000)  i, ( ibuf(j) , j = 1,12 )
687       ENDDO
688    ELSE
689
690!
691!--    Send data to PE0
692       ibuf(1) = pcoord(1); ibuf(2) = pcoord(2); ibuf(3) = pleft
693       ibuf(4) = pright; ibuf(5) = psouth; ibuf(6) = pnorth; ibuf(7) = myidx
694       ibuf(8) = myidy; ibuf(9) = nxl; ibuf(10) = nxr; ibuf(11) = nys
695       ibuf(12) = nyn
696       CALL MPI_SEND( ibuf, 12, MPI_INTEGER, 0, myid, comm2d, ierr )       
697    ENDIF
698#endif
699
700
701!
702!-- Determine the number of ghost point layers
703    IF ( ( scalar_advec == 'ws-scheme' .AND. .NOT. neutral ) .OR.             &
704         momentum_advec == 'ws-scheme' )  THEN
705       nbgp = 3
706    ELSE
707       nbgp = 1
708    ENDIF 
709
710!
711!-- Create a new MPI derived datatype for the exchange of surface (xy) data,
712!-- which is needed for coupled atmosphere-ocean runs.
713!-- First, calculate number of grid points of an xy-plane.
714    ngp_xy  = ( nxr - nxl + 1 + 2 * nbgp ) * ( nyn - nys + 1 + 2 * nbgp )
715    CALL MPI_TYPE_VECTOR( ngp_xy, 1, nzt-nzb+2, MPI_REAL, type_xy, ierr )
716    CALL MPI_TYPE_COMMIT( type_xy, ierr )
717
718    IF ( TRIM( coupling_mode ) /= 'uncoupled' .AND. .NOT. vnested )  THEN
719   
720!
721!--    Pass the number of grid points of the atmosphere model to
722!--    the ocean model and vice versa
723       IF ( coupling_mode == 'atmosphere_to_ocean' )  THEN
724
725          nx_a = nx
726          ny_a = ny
727
728          IF ( myid == 0 )  THEN
729
730             CALL MPI_SEND( nx_a, 1, MPI_INTEGER, numprocs, 1, comm_inter,  &
731                            ierr )
732             CALL MPI_SEND( ny_a, 1, MPI_INTEGER, numprocs, 2, comm_inter,  &
733                            ierr )
734             CALL MPI_SEND( pdims, 2, MPI_INTEGER, numprocs, 3, comm_inter, &
735                            ierr )
736             CALL MPI_RECV( nx_o, 1, MPI_INTEGER, numprocs, 4, comm_inter,  &
737                            status, ierr )
738             CALL MPI_RECV( ny_o, 1, MPI_INTEGER, numprocs, 5, comm_inter,  &
739                            status, ierr )
740             CALL MPI_RECV( pdims_remote, 2, MPI_INTEGER, numprocs, 6,      &
741                            comm_inter, status, ierr )
742          ENDIF
743
744          CALL MPI_BCAST( nx_o, 1, MPI_INTEGER, 0, comm2d, ierr )
745          CALL MPI_BCAST( ny_o, 1, MPI_INTEGER, 0, comm2d, ierr ) 
746          CALL MPI_BCAST( pdims_remote, 2, MPI_INTEGER, 0, comm2d, ierr )
747       
748       ELSEIF ( coupling_mode == 'ocean_to_atmosphere' )  THEN
749
750          nx_o = nx
751          ny_o = ny 
752
753          IF ( myid == 0 ) THEN
754
755             CALL MPI_RECV( nx_a, 1, MPI_INTEGER, 0, 1, comm_inter, status, &
756                            ierr )
757             CALL MPI_RECV( ny_a, 1, MPI_INTEGER, 0, 2, comm_inter, status, &
758                            ierr )
759             CALL MPI_RECV( pdims_remote, 2, MPI_INTEGER, 0, 3, comm_inter, &
760                            status, ierr )
761             CALL MPI_SEND( nx_o, 1, MPI_INTEGER, 0, 4, comm_inter, ierr )
762             CALL MPI_SEND( ny_o, 1, MPI_INTEGER, 0, 5, comm_inter, ierr )
763             CALL MPI_SEND( pdims, 2, MPI_INTEGER, 0, 6, comm_inter, ierr )
764          ENDIF
765
766          CALL MPI_BCAST( nx_a, 1, MPI_INTEGER, 0, comm2d, ierr)
767          CALL MPI_BCAST( ny_a, 1, MPI_INTEGER, 0, comm2d, ierr) 
768          CALL MPI_BCAST( pdims_remote, 2, MPI_INTEGER, 0, comm2d, ierr) 
769
770       ENDIF
771 
772       ngp_a = ( nx_a+1 + 2 * nbgp ) * ( ny_a+1 + 2 * nbgp )
773       ngp_o = ( nx_o+1 + 2 * nbgp ) * ( ny_o+1 + 2 * nbgp )
774
775!
776!--    Determine if the horizontal grid and the number of PEs in ocean and
777!--    atmosphere is same or not
778       IF ( nx_o == nx_a  .AND.  ny_o == ny_a  .AND.  &
779            pdims(1) == pdims_remote(1) .AND. pdims(2) == pdims_remote(2) ) &
780       THEN
781          coupling_topology = 0
782       ELSE
783          coupling_topology = 1
784       ENDIF 
785
786!
787!--    Determine the target PEs for the exchange between ocean and
788!--    atmosphere (comm2d)
789       IF ( coupling_topology == 0 )  THEN
790!
791!--       In case of identical topologies, every atmosphere PE has exactly one
792!--       ocean PE counterpart and vice versa
793          IF ( TRIM( coupling_mode ) == 'atmosphere_to_ocean' ) THEN
794             target_id = myid + numprocs
795          ELSE
796             target_id = myid 
797          ENDIF
798
799       ELSE
800!
801!--       In case of nonequivalent topology in ocean and atmosphere only for
802!--       PE0 in ocean and PE0 in atmosphere a target_id is needed, since
803!--       data echxchange between ocean and atmosphere will be done only
804!--       between these PEs.   
805          IF ( myid == 0 )  THEN
806
807             IF ( TRIM( coupling_mode ) == 'atmosphere_to_ocean' )  THEN
808                target_id = numprocs 
809             ELSE
810                target_id = 0
811             ENDIF
812
813          ENDIF
814
815       ENDIF
816
817    ENDIF
818
819!
820!-- Store partner grid point co-ordinates as lists.
821!-- Create custom MPI vector datatypes for contiguous data transfer
822    IF ( vnested )  CALL vnest_init_pegrid_domain
823
824
825#else
826
827!
828!-- Array bounds when running on a single PE (respectively a non-parallel
829!-- machine)
830    nxl = 0
831    nxr = nx
832    nnx = nxr - nxl + 1
833    nys = 0
834    nyn = ny
835    nny = nyn - nys + 1
836    nzb = 0
837    nzt = nz
838    nnz = nz
839
840    ALLOCATE( hor_index_bounds(4,0:0) )
841    hor_index_bounds(1,0) = nxl
842    hor_index_bounds(2,0) = nxr
843    hor_index_bounds(3,0) = nys
844    hor_index_bounds(4,0) = nyn
845
846!
847!-- Array bounds for the pressure solver (in the parallel code, these bounds
848!-- are the ones for the transposed arrays)
849    nys_x = nys
850    nyn_x = nyn
851    nzb_x = nzb + 1
852    nzt_x = nzt
853
854    nxl_y = nxl
855    nxr_y = nxr
856    nzb_y = nzb + 1
857    nzt_y = nzt
858
859    nxl_z = nxl
860    nxr_z = nxr
861    nys_z = nys
862    nyn_z = nyn
863
864#endif
865
866!
867!-- Calculate number of grid levels necessary for the multigrid poisson solver
868!-- as well as the gridpoint indices on each level
869    IF ( psolver(1:9) == 'multigrid' )  THEN
870
871!
872!--    First calculate number of possible grid levels for the subdomains
873       mg_levels_x = 1
874       mg_levels_y = 1
875       mg_levels_z = 1
876
877       i = nnx
878       DO WHILE ( MOD( i, 2 ) == 0  .AND.  i /= 2 )
879          i = i / 2
880          mg_levels_x = mg_levels_x + 1
881       ENDDO
882
883       j = nny
884       DO WHILE ( MOD( j, 2 ) == 0  .AND.  j /= 2 )
885          j = j / 2
886          mg_levels_y = mg_levels_y + 1
887       ENDDO
888
889       k = nz    ! do not use nnz because it might be > nz due to transposition
890                 ! requirements
891       DO WHILE ( MOD( k, 2 ) == 0  .AND.  k /= 2 )
892          k = k / 2
893          mg_levels_z = mg_levels_z + 1
894       ENDDO
895!
896!--    The optimized MG-solver does not allow odd values for nz at the coarsest
897!--    grid level
898       IF ( TRIM( psolver ) /= 'multigrid_noopt' )  THEN
899          IF ( MOD( k, 2 ) /= 0 )  mg_levels_z = mg_levels_z - 1
900       ENDIF
901
902       maximum_grid_level = MIN( mg_levels_x, mg_levels_y, mg_levels_z )
903
904!
905!--    Find out, if the total domain allows more levels. These additional
906!--    levels are identically processed on all PEs.
907       IF ( numprocs > 1  .AND.  mg_switch_to_pe0_level /= -1 )  THEN
908
909          IF ( mg_levels_z > MIN( mg_levels_x, mg_levels_y ) )  THEN
910
911             mg_switch_to_pe0_level_l = maximum_grid_level
912
913             mg_levels_x = 1
914             mg_levels_y = 1
915
916             i = nx+1
917             DO WHILE ( MOD( i, 2 ) == 0  .AND.  i /= 2 )
918                i = i / 2
919                mg_levels_x = mg_levels_x + 1
920             ENDDO
921
922             j = ny+1
923             DO WHILE ( MOD( j, 2 ) == 0  .AND.  j /= 2 )
924                j = j / 2
925                mg_levels_y = mg_levels_y + 1
926             ENDDO
927
928             maximum_grid_level_l = MIN( mg_levels_x, mg_levels_y, mg_levels_z )
929
930             IF ( maximum_grid_level_l > mg_switch_to_pe0_level_l )  THEN
931                mg_switch_to_pe0_level_l = maximum_grid_level_l - &
932                                           mg_switch_to_pe0_level_l + 1
933             ELSE
934                mg_switch_to_pe0_level_l = 0
935             ENDIF
936
937          ELSE
938             mg_switch_to_pe0_level_l = 0
939             maximum_grid_level_l = maximum_grid_level
940
941          ENDIF
942
943!
944!--       Use switch level calculated above only if it is not pre-defined
945!--       by user
946          IF ( mg_switch_to_pe0_level == 0 )  THEN
947             IF ( mg_switch_to_pe0_level_l /= 0 )  THEN
948                mg_switch_to_pe0_level = mg_switch_to_pe0_level_l
949                maximum_grid_level     = maximum_grid_level_l
950             ENDIF
951
952          ELSE
953!
954!--          Check pre-defined value and reset to default, if neccessary
955             IF ( mg_switch_to_pe0_level < mg_switch_to_pe0_level_l  .OR.  &
956                  mg_switch_to_pe0_level >= maximum_grid_level_l )  THEN
957                message_string = 'mg_switch_to_pe0_level ' // &
958                                 'out of range and reset to 0'
959                CALL message( 'init_pegrid', 'PA0235', 0, 1, 0, 6, 0 )
960                mg_switch_to_pe0_level = 0
961             ELSE
962!
963!--             Use the largest number of possible levels anyway and recalculate
964!--             the switch level to this largest number of possible values
965                maximum_grid_level = maximum_grid_level_l
966
967             ENDIF
968
969          ENDIF
970
971       ENDIF
972
973       ALLOCATE( grid_level_count(maximum_grid_level),                       &
974                 nxl_mg(0:maximum_grid_level), nxr_mg(0:maximum_grid_level), &
975                 nyn_mg(0:maximum_grid_level), nys_mg(0:maximum_grid_level), &
976                 nzt_mg(0:maximum_grid_level) )
977
978       grid_level_count = 0
979!
980!--    Index zero required as dummy due to definition of arrays f2 and p2 in
981!--    recursive subroutine next_mg_level
982       nxl_mg(0) = 0; nxr_mg(0) = 0; nyn_mg(0) = 0; nys_mg(0) = 0; nzt_mg(0) = 0
983
984       nxl_l = nxl; nxr_l = nxr; nys_l = nys; nyn_l = nyn; nzt_l = nzt
985
986       DO  i = maximum_grid_level, 1 , -1
987
988          IF ( i == mg_switch_to_pe0_level )  THEN
989#if defined( __parallel )
990!
991!--          Save the grid size of the subdomain at the switch level, because
992!--          it is needed in poismg.
993             ind(1) = nxl_l; ind(2) = nxr_l
994             ind(3) = nys_l; ind(4) = nyn_l
995             ind(5) = nzt_l
996             ALLOCATE( ind_all(5*numprocs), mg_loc_ind(5,0:numprocs-1) )
997             CALL MPI_ALLGATHER( ind, 5, MPI_INTEGER, ind_all, 5, &
998                                 MPI_INTEGER, comm2d, ierr )
999             DO  j = 0, numprocs-1
1000                DO  k = 1, 5
1001                   mg_loc_ind(k,j) = ind_all(k+j*5)
1002                ENDDO
1003             ENDDO
1004             DEALLOCATE( ind_all )
1005!
1006!--          Calculate the grid size of the total domain
1007             nxr_l = ( nxr_l-nxl_l+1 ) * pdims(1) - 1
1008             nxl_l = 0
1009             nyn_l = ( nyn_l-nys_l+1 ) * pdims(2) - 1
1010             nys_l = 0
1011!
1012!--          The size of this gathered array must not be larger than the
1013!--          array tend, which is used in the multigrid scheme as a temporary
1014!--          array. Therefore the subdomain size of an PE is calculated and
1015!--          the size of the gathered grid. These values are used in 
1016!--          routines pres and poismg
1017             subdomain_size = ( nxr - nxl + 2 * nbgp + 1 ) * &
1018                              ( nyn - nys + 2 * nbgp + 1 ) * ( nzt - nzb + 2 )
1019             gathered_size  = ( nxr_l - nxl_l + 3 ) * ( nyn_l - nys_l + 3 ) * &
1020                              ( nzt_l - nzb + 2 )
1021
1022#else
1023             message_string = 'multigrid gather/scatter impossible ' // &
1024                          'in non parallel mode'
1025             CALL message( 'init_pegrid', 'PA0237', 1, 2, 0, 6, 0 )
1026#endif
1027          ENDIF
1028
1029          nxl_mg(i) = nxl_l
1030          nxr_mg(i) = nxr_l
1031          nys_mg(i) = nys_l
1032          nyn_mg(i) = nyn_l
1033          nzt_mg(i) = nzt_l
1034
1035          nxl_l = nxl_l / 2 
1036          nxr_l = nxr_l / 2
1037          nys_l = nys_l / 2 
1038          nyn_l = nyn_l / 2 
1039          nzt_l = nzt_l / 2 
1040
1041       ENDDO
1042
1043!
1044!--    Temporary problem: Currently calculation of maxerror iin routine poismg crashes
1045!--    if grid data are collected on PE0 already on the finest grid level.
1046!--    To be solved later.
1047       IF ( maximum_grid_level == mg_switch_to_pe0_level )  THEN
1048          message_string = 'grid coarsening on subdomain level cannot be performed'
1049          CALL message( 'poismg', 'PA0236', 1, 2, 0, 6, 0 )
1050       ENDIF
1051
1052    ELSE
1053
1054       maximum_grid_level = 0
1055
1056    ENDIF
1057
1058!
1059!-- Default level 0 tells exchange_horiz that all ghost planes have to be
1060!-- exchanged. grid_level is adjusted in poismg, where only one ghost plane
1061!-- is required.
1062    grid_level = 0
1063
1064#if defined( __parallel )
1065!
1066!-- Gridpoint number for the exchange of ghost points (y-line for 2D-arrays)
1067    ngp_y  = nyn - nys + 1 + 2 * nbgp
1068
1069!
1070!-- Define new MPI derived datatypes for the exchange of ghost points in
1071!-- x- and y-direction for 2D-arrays (line)
1072    CALL MPI_TYPE_VECTOR( nxr-nxl+1+2*nbgp, nbgp, ngp_y, MPI_REAL, type_x,     &
1073                          ierr )
1074    CALL MPI_TYPE_COMMIT( type_x, ierr )
1075
1076    CALL MPI_TYPE_VECTOR( nbgp, ngp_y, ngp_y, MPI_REAL, type_y, ierr )
1077    CALL MPI_TYPE_COMMIT( type_y, ierr )
1078!
1079!-- Define new MPI derived datatypes for the exchange of ghost points in
1080!-- x- and y-direction for 2D-INTEGER arrays (line) - on normal grid
1081    ALLOCATE( type_x_int(0:maximum_grid_level),                                &
1082              type_y_int(0:maximum_grid_level) )
1083
1084    CALL MPI_TYPE_VECTOR( nxr-nxl+1+2*nbgp, nbgp, ngp_y, MPI_INTEGER,          &
1085                          type_x_int(0), ierr )
1086    CALL MPI_TYPE_COMMIT( type_x_int(0), ierr )
1087
1088    CALL MPI_TYPE_VECTOR( nbgp, ngp_y, ngp_y, MPI_INTEGER, type_y_int(0), ierr )
1089    CALL MPI_TYPE_COMMIT( type_y_int(0), ierr )
1090!
1091!-- Calculate gridpoint numbers for the exchange of ghost points along x
1092!-- (yz-plane for 3D-arrays) and define MPI derived data type(s) for the
1093!-- exchange of ghost points in y-direction (xz-plane).
1094!-- Do these calculations for the model grid and (if necessary) also
1095!-- for the coarser grid levels used in the multigrid method
1096    ALLOCATE ( ngp_xz(0:maximum_grid_level), ngp_yz(0:maximum_grid_level),     &
1097               type_xz(0:maximum_grid_level), type_yz(0:maximum_grid_level) )
1098
1099    nxl_l = nxl; nxr_l = nxr; nys_l = nys; nyn_l = nyn; nzb_l = nzb; nzt_l = nzt
1100
1101!
1102!-- Discern between the model grid, which needs nbgp ghost points and
1103!-- grid levels for the multigrid scheme. In the latter case only one
1104!-- ghost point is necessary.
1105!-- First definition of MPI-datatypes for exchange of ghost layers on normal
1106!-- grid. The following loop is needed for data exchange in poismg.f90.
1107!
1108!-- Determine number of grid points of yz-layer for exchange
1109    ngp_yz(0) = (nzt - nzb + 2) * (nyn - nys + 1 + 2 * nbgp)
1110
1111!
1112!-- Define an MPI-datatype for the exchange of left/right boundaries.
1113!-- Although data are contiguous in physical memory (which does not
1114!-- necessarily require an MPI-derived datatype), the data exchange between
1115!-- left and right PE's using the MPI-derived type is 10% faster than without.
1116    CALL MPI_TYPE_VECTOR( nxr-nxl+1+2*nbgp, nbgp*(nzt-nzb+2), ngp_yz(0), &
1117                          MPI_REAL, type_xz(0), ierr )
1118    CALL MPI_TYPE_COMMIT( type_xz(0), ierr )
1119
1120    CALL MPI_TYPE_VECTOR( nbgp, ngp_yz(0), ngp_yz(0), MPI_REAL, type_yz(0), &
1121                          ierr ) 
1122    CALL MPI_TYPE_COMMIT( type_yz(0), ierr )
1123
1124!
1125!-- Definition of MPI-datatypes for multigrid method (coarser level grids)
1126    IF ( psolver(1:9) == 'multigrid' )  THEN
1127!   
1128!--    Definition of MPI-datatyoe as above, but only 1 ghost level is used
1129       DO  i = maximum_grid_level, 1 , -1
1130!
1131!--       For 3D-exchange
1132          ngp_xz(i) = (nzt_l - nzb_l + 2) * (nxr_l - nxl_l + 3)
1133          ngp_yz(i) = (nzt_l - nzb_l + 2) * (nyn_l - nys_l + 3)
1134
1135          CALL MPI_TYPE_VECTOR( nxr_l-nxl_l+3, nzt_l-nzb_l+2, ngp_yz(i), &
1136                                MPI_REAL, type_xz(i), ierr )
1137          CALL MPI_TYPE_COMMIT( type_xz(i), ierr )
1138
1139          CALL MPI_TYPE_VECTOR( 1, ngp_yz(i), ngp_yz(i), MPI_REAL, type_yz(i), &
1140                                ierr )
1141          CALL MPI_TYPE_COMMIT( type_yz(i), ierr )
1142
1143
1144!--       For 2D-exchange of INTEGER arrays on coarser grid level, where 2 ghost
1145!--       points need to be exchanged.
1146          CALL MPI_TYPE_VECTOR( nxr_l-nxl_l+5, 2, nyn_l-nys_l+5, MPI_INTEGER,          &
1147                                type_x_int(i), ierr )
1148          CALL MPI_TYPE_COMMIT( type_x_int(i), ierr )
1149
1150
1151          CALL MPI_TYPE_VECTOR( 2, nyn_l-nys_l+5, nyn_l-nys_l+5, MPI_INTEGER,          &
1152                                type_y_int(i), ierr )
1153          CALL MPI_TYPE_COMMIT( type_y_int(i), ierr )
1154
1155
1156
1157          nxl_l = nxl_l / 2
1158          nxr_l = nxr_l / 2
1159          nys_l = nys_l / 2
1160          nyn_l = nyn_l / 2
1161          nzt_l = nzt_l / 2
1162
1163       ENDDO
1164
1165    ENDIF
1166!
1167!-- Define data types for exchange of 3D Integer arrays.
1168    ngp_yz_int = (nzt - nzb + 2) * (nyn - nys + 1 + 2 * nbgp)
1169
1170    CALL MPI_TYPE_VECTOR( nxr-nxl+1+2*nbgp, nbgp*(nzt-nzb+2), ngp_yz_int, &
1171                          MPI_INTEGER, type_xz_int, ierr )
1172    CALL MPI_TYPE_COMMIT( type_xz_int, ierr )
1173
1174    CALL MPI_TYPE_VECTOR( nbgp, ngp_yz_int, ngp_yz_int, MPI_INTEGER, type_yz_int, &
1175                          ierr )
1176    CALL MPI_TYPE_COMMIT( type_yz_int, ierr )
1177
1178#endif
1179
1180#if defined( __parallel )
1181!
1182!-- Setting of flags for inflow/outflow/nesting conditions.
1183    IF ( pleft == MPI_PROC_NULL )  THEN
1184       IF ( bc_lr == 'dirichlet/radiation' )  THEN
1185          inflow_l  = .TRUE.
1186       ELSEIF ( bc_lr == 'radiation/dirichlet' )  THEN
1187          outflow_l = .TRUE.
1188       ELSEIF ( bc_lr == 'nested' )  THEN
1189          nest_bound_l = .TRUE.
1190       ENDIF
1191    ENDIF
1192 
1193    IF ( pright == MPI_PROC_NULL )  THEN
1194       IF ( bc_lr == 'dirichlet/radiation' )  THEN
1195          outflow_r = .TRUE.
1196       ELSEIF ( bc_lr == 'radiation/dirichlet' )  THEN
1197          inflow_r  = .TRUE.
1198       ELSEIF ( bc_lr == 'nested' )  THEN
1199          nest_bound_r = .TRUE.
1200       ENDIF
1201    ENDIF
1202
1203    IF ( psouth == MPI_PROC_NULL )  THEN
1204       IF ( bc_ns == 'dirichlet/radiation' )  THEN
1205          outflow_s = .TRUE.
1206       ELSEIF ( bc_ns == 'radiation/dirichlet' )  THEN
1207          inflow_s  = .TRUE.
1208       ELSEIF ( bc_ns == 'nested' )  THEN
1209          nest_bound_s = .TRUE.
1210       ENDIF
1211    ENDIF
1212
1213    IF ( pnorth == MPI_PROC_NULL )  THEN
1214       IF ( bc_ns == 'dirichlet/radiation' )  THEN
1215          inflow_n  = .TRUE.
1216       ELSEIF ( bc_ns == 'radiation/dirichlet' )  THEN
1217          outflow_n = .TRUE.
1218       ELSEIF ( bc_ns == 'nested' )  THEN
1219          nest_bound_n = .TRUE.
1220       ENDIF
1221    ENDIF
1222
1223!
1224!-- Broadcast the id of the inflow PE
1225    IF ( inflow_l )  THEN
1226       id_inflow_l = myidx
1227    ELSE
1228       id_inflow_l = 0
1229    ENDIF
1230    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1231    CALL MPI_ALLREDUCE( id_inflow_l, id_inflow, 1, MPI_INTEGER, MPI_SUM, &
1232                        comm1dx, ierr )
1233
1234!
1235!-- Broadcast the id of the recycling plane
1236!-- WARNING: needs to be adjusted in case of inflows other than from left side!
1237    IF ( NINT( recycling_width / dx ) >= nxl  .AND. &
1238         NINT( recycling_width / dx ) <= nxr )  THEN
1239       id_recycling_l = myidx
1240    ELSE
1241       id_recycling_l = 0
1242    ENDIF
1243    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1244    CALL MPI_ALLREDUCE( id_recycling_l, id_recycling, 1, MPI_INTEGER, MPI_SUM, &
1245                        comm1dx, ierr )
1246
1247!
1248!-- Broadcast the id of the outflow PE and outflow-source plane
1249    IF ( turbulent_outflow )  THEN
1250
1251       IF ( outflow_r )  THEN
1252          id_outflow_l = myidx
1253       ELSE
1254          id_outflow_l = 0
1255       ENDIF
1256       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1257       CALL MPI_ALLREDUCE( id_outflow_l, id_outflow, 1, MPI_INTEGER, MPI_SUM, &
1258                           comm1dx, ierr )
1259
1260       IF ( NINT( outflow_source_plane / dx ) >= nxl  .AND. &
1261            NINT( outflow_source_plane / dx ) <= nxr )  THEN
1262          id_outflow_source_l = myidx
1263       ELSE
1264          id_outflow_source_l = 0
1265       ENDIF
1266       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1267       CALL MPI_ALLREDUCE( id_outflow_source_l, id_outflow_source, 1, &
1268                           MPI_INTEGER, MPI_SUM, comm1dx, ierr )
1269
1270    ENDIF
1271
1272    CALL location_message( 'finished', .TRUE. )
1273
1274#else
1275    IF ( bc_lr == 'dirichlet/radiation' )  THEN
1276       inflow_l  = .TRUE.
1277       outflow_r = .TRUE.
1278    ELSEIF ( bc_lr == 'radiation/dirichlet' )  THEN
1279       outflow_l = .TRUE.
1280       inflow_r  = .TRUE.
1281    ENDIF
1282
1283    IF ( bc_ns == 'dirichlet/radiation' )  THEN
1284       inflow_n  = .TRUE.
1285       outflow_s = .TRUE.
1286    ELSEIF ( bc_ns == 'radiation/dirichlet' )  THEN
1287       outflow_n = .TRUE.
1288       inflow_s  = .TRUE.
1289    ENDIF
1290#endif
1291
1292!
1293!-- At the inflow or outflow, u or v, respectively, have to be calculated for
1294!-- one more grid point.
1295    IF ( inflow_l .OR. outflow_l .OR. nest_bound_l )  THEN
1296       nxlu = nxl + 1
1297    ELSE
1298       nxlu = nxl
1299    ENDIF
1300    IF ( inflow_s .OR. outflow_s .OR. nest_bound_s )  THEN
1301       nysv = nys + 1
1302    ELSE
1303       nysv = nys
1304    ENDIF
1305
1306!
1307!-- Allocate wall flag arrays used in the multigrid solver
1308    IF ( psolver(1:9) == 'multigrid' )  THEN
1309
1310       DO  i = maximum_grid_level, 1, -1
1311
1312           SELECT CASE ( i )
1313
1314              CASE ( 1 )
1315                 ALLOCATE( wall_flags_1(nzb:nzt_mg(i)+1,         &
1316                                        nys_mg(i)-1:nyn_mg(i)+1, &
1317                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1318
1319              CASE ( 2 )
1320                 ALLOCATE( wall_flags_2(nzb:nzt_mg(i)+1,         &
1321                                        nys_mg(i)-1:nyn_mg(i)+1, &
1322                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1323
1324              CASE ( 3 )
1325                 ALLOCATE( wall_flags_3(nzb:nzt_mg(i)+1,         &
1326                                        nys_mg(i)-1:nyn_mg(i)+1, &
1327                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1328
1329              CASE ( 4 )
1330                 ALLOCATE( wall_flags_4(nzb:nzt_mg(i)+1,         &
1331                                        nys_mg(i)-1:nyn_mg(i)+1, &
1332                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1333
1334              CASE ( 5 )
1335                 ALLOCATE( wall_flags_5(nzb:nzt_mg(i)+1,         &
1336                                        nys_mg(i)-1:nyn_mg(i)+1, &
1337                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1338
1339              CASE ( 6 )
1340                 ALLOCATE( wall_flags_6(nzb:nzt_mg(i)+1,         &
1341                                        nys_mg(i)-1:nyn_mg(i)+1, &
1342                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1343
1344              CASE ( 7 )
1345                 ALLOCATE( wall_flags_7(nzb:nzt_mg(i)+1,         &
1346                                        nys_mg(i)-1:nyn_mg(i)+1, &
1347                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1348
1349              CASE ( 8 )
1350                 ALLOCATE( wall_flags_8(nzb:nzt_mg(i)+1,         &
1351                                        nys_mg(i)-1:nyn_mg(i)+1, &
1352                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1353
1354              CASE ( 9 )
1355                 ALLOCATE( wall_flags_9(nzb:nzt_mg(i)+1,         &
1356                                        nys_mg(i)-1:nyn_mg(i)+1, &
1357                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1358
1359              CASE ( 10 )
1360                 ALLOCATE( wall_flags_10(nzb:nzt_mg(i)+1,        &
1361                                        nys_mg(i)-1:nyn_mg(i)+1, &
1362                                        nxl_mg(i)-1:nxr_mg(i)+1) )
1363
1364              CASE DEFAULT
1365                 message_string = 'more than 10 multigrid levels'
1366                 CALL message( 'init_pegrid', 'PA0238', 1, 2, 0, 6, 0 )
1367
1368          END SELECT
1369
1370       ENDDO
1371
1372    ENDIF
1373
1374!
1375!-- Calculate the number of groups into which parallel I/O is split.
1376!-- The default for files which are opened by all PEs (or where each
1377!-- PE opens his own independent file) is, that all PEs are doing input/output
1378!-- in parallel at the same time. This might cause performance or even more
1379!-- severe problems depending on the configuration of the underlying file
1380!-- system.
1381!-- First, set the default:
1382    IF ( maximum_parallel_io_streams == -1  .OR. &
1383         maximum_parallel_io_streams > numprocs )  THEN
1384       maximum_parallel_io_streams = numprocs
1385    ENDIF
1386
1387!
1388!-- Now calculate the number of io_blocks and the io_group to which the
1389!-- respective PE belongs. I/O of the groups is done in serial, but in parallel
1390!-- for all PEs belonging to the same group. A preliminary setting with myid
1391!-- based on MPI_COMM_WORLD has been done in parin.
1392    io_blocks = numprocs / maximum_parallel_io_streams
1393    io_group  = MOD( myid+1, io_blocks )
1394   
1395
1396 END SUBROUTINE init_pegrid
Note: See TracBrowser for help on using the repository browser.