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

Last change on this file since 3655 was 3655, checked in by knoop, 3 years ago

Bugfix: made "unit" and "found" intend INOUT in module interface subroutines + automatic copyright update

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