Home

Context Navigation

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

Last change on this file since 3182 was 3182, checked in by suehring, 6 years ago
New Inifor features: grid stretching, improved command-interface, support start dates in different formats in both YYYYMMDD and YYYYMMDDHH, Ability to manually control input file prefixes (--radiation-prefix, --soil-preifx, --flow-prefix, --soilmoisture-prefix) for compatiblity with DWD forcast naming scheme; GNU-style short and long option; Prepared output of large-scale forcing profiles (no computation yet); Added preprocessor flag netcdf4 to switch output format between netCDF 3 and 4; Updated netCDF variable names and attributes to comply with PIDS v1.9; Inifor bugfixes: Improved compatibility with older Intel Intel compilers by avoiding implicit array allocation; Added origin_lon/_lat values and correct reference time in dynamic driver global attributes; corresponding PALM changes: adjustments to revised Inifor; variables names in dynamic driver adjusted; enable geostrophic forcing also in offline nested mode; variable names in LES-LES and COSMO offline nesting changed; lateral boundary flags for nesting, in- and outflow conditions renamed
Property svn:keywords set to `Id`
File size: 51.4 KB

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

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

Download in other formats:

| Impressum | ©Leibniz Universität Hannover |