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

Last change on this file since 3049 was 3049, checked in by Giersch, 3 years ago

Revision history corrected

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