Home

Context Navigation

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

Last change on this file since 3151 was 3058, checked in by raasch, 6 years ago
bugfix: wrong error number in r3057 revised
Property svn:keywords set to `Id`
File size: 51.8 KB

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

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

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |