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

Last change on this file since 2776 was 2776, checked in by Giersch, 4 years ago

Skipping of module related restart data changed + adapting synthetic turbulence generator to current restart procedure

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