Home

Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |