source: palm/trunk/SOURCE/pmc_handle_communicator_mod.f90 @ 4784

Last change on this file since 4784 was 4771, checked in by hellstea, 3 years ago

Canopy-restricted anterpolation introduced

  • Property svn:keywords set to Id
File size: 20.5 KB
Line 
1!> @file pmc_handle_communicator_mod.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 terms of the GNU General
6! Public License as published by the Free Software Foundation, either version 3 of the License, or
7! (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
10! implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
11! Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with PALM. If not, see
14! <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2020 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------------------------!
18!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: pmc_handle_communicator_mod.f90 4771 2020-11-04 13:12:46Z suehring $
27! Canopy-restricted anterpolation introduced. New namelist parameter anterpolation_starting_height
28! introduced for controlling canopy-restricted anterpolation.
29!
30! 4650 2020-08-25 14:35:50Z raasch
31! bugfix for r4649
32!
33! 4649 2020-08-25 12:11:17Z raasch
34! File re-formatted to follow the PALM coding standard
35!
36!
37! 4629 2020-07-29 09:37:56Z raasch
38! Support for MPI Fortran77 interface (mpif.h) removed
39!
40! 4360 2020-01-07 11:25:50Z suehring
41! Corrected "Former revisions" section
42!
43! 3888 2019-04-12 09:18:10Z hellstea
44! Missing MPI_BCAST of anterpolation_buffer_width added.
45!
46! 3885 2019-04-11 11:29:34Z kanani
47! Changes related to global restructuring of location messages and introduction of additional debug
48! messages
49!
50! 3819 2019-03-27 11:01:36Z hellstea
51! Adjustable anterpolation buffer introduced on all nest boundaries, it is controlled by the new
52! nesting_parameters parameter anterpolation_buffer_width.
53!
54! 3655 2019-01-07 16:51:22Z knoop
55! nestpar renamed to nesting_parameters
56!
57! 1762 2016-02-25 12:31:13Z hellstea
58! Initial revision by K. Ketelsen
59!
60! Description:
61! ------------
62! Handle MPI communicator in PALM model coupler
63!--------------------------------------------------------------------------------------------------!
64 MODULE PMC_handle_communicator
65#if defined( __parallel )
66    USE kinds
67
68    USE MPI
69
70    USE pmc_general,                                                                               &
71        ONLY: pmc_max_models,                                                                      &
72              pmc_status_error,                                                                    &
73              pmc_status_ok
74
75
76    USE control_parameters,                                                                        &
77        ONLY: message_string
78
79    IMPLICIT NONE
80
81!
82!-- ATTENTION: Do not change the order of variable declarations in the following TYPE definition,
83!-- because the order must follow the order in which the layout data is given in the NAMELIST file.
84    TYPE pmc_layout
85
86       CHARACTER(LEN=32) ::  name  !<
87
88       INTEGER ::  id            !<
89       INTEGER ::  parent_id     !<
90       INTEGER ::  npe_total     !<
91
92       REAL(wp) ::  lower_left_x  !<
93       REAL(wp) ::  lower_left_y  !<
94
95    END TYPE pmc_layout
96
97    PUBLIC  pmc_status_ok, pmc_status_error  !<
98
99    INTEGER, PARAMETER, PUBLIC ::  pmc_error_npes        = 1  !< illegal number of processes
100    INTEGER, PARAMETER, PUBLIC ::  pmc_namelist_error    = 2  !< error(s) in nesting_parameters namelist
101    INTEGER, PARAMETER, PUBLIC ::  pmc_no_namelist_found = 3  !< no couple layout namelist found
102
103    INTEGER ::  m_my_cpl_id   !< coupler id of this model
104    INTEGER ::  m_ncpl        !< number of couplers given in nesting_parameters namelist
105    INTEGER ::  m_parent_id   !< coupler id of parent of this model
106    INTEGER ::  m_world_comm  !< global nesting communicator
107
108    TYPE(pmc_layout), PUBLIC, DIMENSION(pmc_max_models) ::  m_couplers  !< information of all couplers
109
110    INTEGER, PUBLIC ::  m_model_comm          !< communicator of this model
111    INTEGER, PUBLIC ::  m_model_npes          !<
112    INTEGER, PUBLIC ::  m_model_rank          !<
113    INTEGER, PUBLIC ::  m_to_parent_comm      !< communicator to the parent
114    INTEGER, PUBLIC ::  m_world_rank          !<
115    INTEGER         ::  m_parent_remote_size  !< number of processes in the parent model
116    INTEGER         ::  m_world_npes          !<
117    INTEGER         ::  peer_comm             !< peer_communicator for inter communicators
118
119    INTEGER, DIMENSION(pmc_max_models), PUBLIC ::  m_to_child_comm   !< communicator to the child(ren)
120    INTEGER, DIMENSION(:), POINTER, PUBLIC ::  pmc_parent_for_child  !<
121
122
123    INTERFACE pmc_get_model_info
124       MODULE PROCEDURE pmc_get_model_info
125    END INTERFACE pmc_get_model_info
126
127    INTERFACE pmc_is_rootmodel
128       MODULE PROCEDURE pmc_is_rootmodel
129    END INTERFACE pmc_is_rootmodel
130
131    PUBLIC pmc_get_model_info, pmc_init_model, pmc_is_rootmodel   !<
132
133
134
135 CONTAINS
136
137
138!--------------------------------------------------------------------------------------------------!
139! Description:
140! ------------
141!> @Todo: Missing subroutine description.
142!--------------------------------------------------------------------------------------------------!
143 SUBROUTINE pmc_init_model( comm, nesting_datatransfer_mode, nesting_mode,                         &
144                            anterpolation_buffer_width, anterpolation_starting_height, pmc_status )
145
146    USE control_parameters,                                                                        &
147        ONLY:  message_string
148
149    USE pegrid,                                                                                    &
150        ONLY:  myid
151
152      IMPLICIT NONE
153
154    CHARACTER(LEN=7), INTENT(INOUT) ::  nesting_datatransfer_mode  !<
155    CHARACTER(LEN=8), INTENT(INOUT) ::  nesting_mode               !<
156
157    INTEGER, INTENT(INOUT) ::  anterpolation_buffer_width  !< Boundary buffer width for anterpolation
158    INTEGER, INTENT(INOUT) ::  comm                        !<
159    INTEGER, INTENT(INOUT) ::  pmc_status                  !<
160
161    REAL(wp), INTENT(INOUT) ::  anterpolation_starting_height  !< steering parameter for canopy restricted anterpolation
162   
163    INTEGER ::  childcount     !<
164    INTEGER ::  i              !<
165    INTEGER ::  ierr           !<
166    INTEGER ::  istat          !<
167    INTEGER ::  m_my_cpl_rank  !<
168    INTEGER ::  tag            !<
169
170    INTEGER, DIMENSION(pmc_max_models)   ::  activeparent  !< I am active parent for this child ID
171    INTEGER, DIMENSION(pmc_max_models+1) ::  start_pe      !<
172
173    pmc_status   = pmc_status_ok
174    comm         = -1
175    m_world_comm = MPI_COMM_WORLD
176    m_my_cpl_id  = -1
177    childcount   =  0
178    activeparent = -1
179    start_pe(:)  =  0
180
181    CALL MPI_COMM_RANK( MPI_COMM_WORLD, m_world_rank, istat )
182    CALL MPI_COMM_SIZE( MPI_COMM_WORLD, m_world_npes, istat )
183!
184!-- Only process 0 of root model reads
185    IF ( m_world_rank == 0 )  THEN
186
187       CALL read_coupling_layout( nesting_datatransfer_mode, nesting_mode,                         &
188            anterpolation_buffer_width, anterpolation_starting_height,                             &
189            pmc_status )
190
191       IF ( pmc_status /= pmc_no_namelist_found  .AND.                                             &
192            pmc_status /= pmc_namelist_error )                                                     &
193       THEN
194!
195!--       Calculate start PE of every model
196          start_pe(1) = 0
197          DO  i = 2, m_ncpl+1
198             start_pe(i) = start_pe(i-1) + m_couplers(i-1)%npe_total
199          ENDDO
200
201!
202!--       The sum of numbers of processes requested by all the domains must be equal to the total
203!--       number of processes of the run
204          IF ( start_pe(m_ncpl+1) /= m_world_npes )  THEN
205             WRITE( message_string, '(2A,I6,2A,I6,A)' )                                            &
206                                                'nesting-setup requires different number of ',     &
207                                                'MPI procs (', start_pe(m_ncpl+1), ') than ',      &
208                                                'provided (', m_world_npes,')'
209             CALL message( 'pmc_init_model', 'PA0229', 3, 2, 0, 6, 0 )
210          ENDIF
211
212       ENDIF
213
214    ENDIF
215!
216!-- Broadcast the read status. This synchronises all other processes with process 0 of the root
217!-- model. Without synchronisation, they would not behave in the correct way (e.g. they would not
218!-- return in case of a missing NAMELIST).
219    CALL MPI_BCAST( pmc_status, 1, MPI_INTEGER, 0, MPI_COMM_WORLD, istat )
220
221    IF ( pmc_status == pmc_no_namelist_found )  THEN
222!
223!--    Not a nested run; return the MPI_WORLD communicator
224       comm = MPI_COMM_WORLD
225       RETURN
226
227    ELSEIF ( pmc_status == pmc_namelist_error )  THEN
228!
229!--    Only the root model gives the error message. Others are aborted by the message-routine with
230!--    MPI_ABORT. Must be done this way since myid and comm2d have not yet been assigned at this
231!--    point.
232       IF ( m_world_rank == 0 )  THEN
233          message_string = 'errors in \$nesting_parameters'
234          CALL message( 'pmc_init_model', 'PA0223', 3, 2, 0, 6, 0 )
235       ENDIF
236
237    ENDIF
238
239    CALL MPI_BCAST( m_ncpl,          1, MPI_INTEGER, 0, MPI_COMM_WORLD, istat )
240    CALL MPI_BCAST( start_pe, m_ncpl+1, MPI_INTEGER, 0, MPI_COMM_WORLD, istat )
241!
242!-- Broadcast coupling layout
243    DO  i = 1, m_ncpl
244       CALL MPI_BCAST( m_couplers(i)%name, LEN( m_couplers(i)%name ),                              &
245                       MPI_CHARACTER, 0, MPI_COMM_WORLD, istat )
246       CALL MPI_BCAST( m_couplers(i)%id,           1, MPI_INTEGER, 0,                              &
247                       MPI_COMM_WORLD, istat )
248       CALL MPI_BCAST( m_couplers(i)%Parent_id,    1, MPI_INTEGER, 0,                              &
249                       MPI_COMM_WORLD, istat )
250       CALL MPI_BCAST( m_couplers(i)%npe_total,    1, MPI_INTEGER, 0,                              &
251                       MPI_COMM_WORLD, istat )
252       CALL MPI_BCAST( m_couplers(i)%lower_left_x, 1, MPI_REAL,    0,                              &
253                       MPI_COMM_WORLD, istat )
254       CALL MPI_BCAST( m_couplers(i)%lower_left_y, 1, MPI_REAL,    0,                              &
255                       MPI_COMM_WORLD, istat )
256    ENDDO
257    CALL MPI_BCAST( nesting_mode, LEN( nesting_mode ), MPI_CHARACTER, 0, MPI_COMM_WORLD, istat )
258    CALL MPI_BCAST( nesting_datatransfer_mode, LEN(nesting_datatransfer_mode), MPI_CHARACTER, 0,   &
259                    MPI_COMM_WORLD, istat )
260    CALL MPI_BCAST( anterpolation_buffer_width, 1, MPI_INT, 0, MPI_COMM_WORLD, istat )
261    CALL MPI_BCAST( anterpolation_starting_height, 1, MPI_REAL, 0, MPI_COMM_WORLD, istat )
262!
263!-- Assign global MPI processes to individual models by setting the couple id
264    DO  i = 1, m_ncpl
265       IF ( m_world_rank >= start_pe(i)  .AND.  m_world_rank < start_pe(i+1) )  THEN
266          m_my_cpl_id = i
267          EXIT
268       ENDIF
269    ENDDO
270    m_my_cpl_rank = m_world_rank - start_pe(i)
271!
272!-- MPI_COMM_WORLD is the communicator for ALL models (MPI-1 approach). The communictors for the
273!-- individual models as created by MPI_COMM_SPLIT. The color of the model is represented by the
274!-- coupler id
275    CALL MPI_COMM_SPLIT( MPI_COMM_WORLD, m_my_cpl_id, m_my_cpl_rank, comm, istat )
276!
277!-- Get size and rank of the model running on this process
278    CALL  MPI_COMM_RANK( comm, m_model_rank, istat )
279    CALL  MPI_COMM_SIZE( comm, m_model_npes, istat )
280!
281!-- Broadcast (from process 0) the parent id and id of every model
282    DO  i = 1, m_ncpl
283       CALL MPI_BCAST( m_couplers(i)%parent_id, 1, MPI_INTEGER, 0, MPI_COMM_WORLD, istat )
284       CALL MPI_BCAST( m_couplers(i)%id,        1, MPI_INTEGER, 0, MPI_COMM_WORLD, istat )
285    ENDDO
286!
287!-- Save the current model communicator for pmc internal use
288    m_model_comm = comm
289
290!
291!-- Create intercommunicator between the parent and children.
292!-- MPI_INTERCOMM_CREATE creates an intercommunicator between 2 groups of different colors. The
293!-- grouping was done above with MPI_COMM_SPLIT. A duplicate of MPI_COMM_WORLD is created and used
294!-- as peer communicator (peer_comm) for MPI_INTERCOMM_CREATE.
295    CALL MPI_COMM_DUP( MPI_COMM_WORLD, peer_comm, ierr )
296    DO  i = 2, m_ncpl
297       IF ( m_couplers(i)%parent_id == m_my_cpl_id )  THEN
298!
299!--       Identify all children models of the current model and create inter-communicators to
300!--       connect between the current model and its children models.
301          tag = 500 + i
302          CALL MPI_INTERCOMM_CREATE( comm, 0, peer_comm, start_pe(i), tag, m_to_child_comm(i),     &
303                                     istat )
304          childcount = childcount + 1
305          activeparent(i) = 1
306       ELSEIF ( i == m_my_cpl_id)  THEN
307!
308!--       Create an inter-communicator to connect between the current model and its parent model.
309          tag = 500 + i
310          CALL MPI_INTERCOMM_CREATE( comm, 0, peer_comm, start_pe(m_couplers(i)%parent_id), tag,   &
311                                     m_to_parent_comm, istat )
312       ENDIF
313    ENDDO
314!
315!-- If I am a parent, count the number of children I have. Although this loop is symmetric on all
316!-- processes, the "activeparent" flag is true (==1) on the respective individual process only.
317    ALLOCATE( pmc_parent_for_child(childcount+1) )
318
319    childcount = 0
320    DO  i = 2, m_ncpl
321       IF ( activeparent(i) == 1 )  THEN
322          childcount = childcount + 1
323          pmc_parent_for_child(childcount) = i
324       ENDIF
325    ENDDO
326!
327!-- Get the size of the parent model
328    IF ( m_my_cpl_id > 1 )  THEN
329       CALL MPI_COMM_REMOTE_SIZE( m_to_parent_comm, m_parent_remote_size, istat )
330    ELSE
331!
332!--    The root model does not have a parent
333       m_parent_remote_size = -1
334    ENDIF
335!
336!-- Set myid to non-zero value except for the root domain. This is a setting for the message routine
337!-- which is called at the end of pmci_init. That routine outputs messages for myid = 0, only.
338!-- However, myid has not been assigened so far, so that all processes of the root model would
339!-- output a message. To avoid this, set myid to some other value except for process 0 of the root
340!-- domain.
341    IF ( m_world_rank /= 0 )  myid = 1
342
343 END SUBROUTINE PMC_init_model
344
345
346!--------------------------------------------------------------------------------------------------!
347! Description:
348! ------------
349!> @Todo: Missing subroutine description.
350!--------------------------------------------------------------------------------------------------!
351 SUBROUTINE pmc_get_model_info( comm_world_nesting, cpl_id, cpl_name, cpl_parent_id, lower_left_x, &
352                                lower_left_y, ncpl, npe_total, request_for_cpl_id )
353!
354!-- Provide module private variables of the pmc for PALM
355
356    USE kinds
357
358    IMPLICIT NONE
359
360    CHARACTER(LEN=*), INTENT(OUT), OPTIONAL ::  cpl_name   !<
361
362    INTEGER, INTENT(IN), OPTIONAL ::  request_for_cpl_id   !<
363
364    INTEGER, INTENT(OUT), OPTIONAL ::  comm_world_nesting  !<
365    INTEGER, INTENT(OUT), OPTIONAL ::  cpl_id              !<
366    INTEGER, INTENT(OUT), OPTIONAL ::  cpl_parent_id       !<
367    INTEGER, INTENT(OUT), OPTIONAL ::  ncpl                !<
368    INTEGER, INTENT(OUT), OPTIONAL ::  npe_total           !<
369
370    INTEGER ::  requested_cpl_id                           !<
371
372    REAL(wp), INTENT(OUT), OPTIONAL ::  lower_left_x       !<
373    REAL(wp), INTENT(OUT), OPTIONAL ::  lower_left_y       !<
374
375!
376!-- Set the requested coupler id
377    IF ( PRESENT( request_for_cpl_id ) )  THEN
378       requested_cpl_id = request_for_cpl_id
379!
380!--    Check for allowed range of values
381       IF ( requested_cpl_id < 1  .OR.  requested_cpl_id > m_ncpl )  RETURN
382    ELSE
383       requested_cpl_id = m_my_cpl_id
384    ENDIF
385!
386!-- Return the requested information
387    IF ( PRESENT( comm_world_nesting )  )  THEN
388       comm_world_nesting = m_world_comm
389    ENDIF
390    IF ( PRESENT( cpl_id )        )  THEN
391       cpl_id = requested_cpl_id
392    ENDIF
393    IF ( PRESENT( cpl_parent_id ) )  THEN
394       cpl_parent_id = m_couplers(requested_cpl_id)%parent_id
395    ENDIF
396    IF ( PRESENT( cpl_name )      )  THEN
397       cpl_name = m_couplers(requested_cpl_id)%name
398    ENDIF
399    IF ( PRESENT( ncpl )          )  THEN
400       ncpl = m_ncpl
401    ENDIF
402    IF ( PRESENT( npe_total )     )  THEN
403       npe_total = m_couplers(requested_cpl_id)%npe_total
404    ENDIF
405    IF ( PRESENT( lower_left_x )  )  THEN
406       lower_left_x = m_couplers(requested_cpl_id)%lower_left_x
407    ENDIF
408    IF ( PRESENT( lower_left_y )  )  THEN
409       lower_left_y = m_couplers(requested_cpl_id)%lower_left_y
410    ENDIF
411
412 END SUBROUTINE pmc_get_model_info
413
414
415
416 LOGICAL function pmc_is_rootmodel( )
417
418    IMPLICIT NONE
419
420    pmc_is_rootmodel = ( m_my_cpl_id == 1 )
421
422 END FUNCTION pmc_is_rootmodel
423
424
425
426!--------------------------------------------------------------------------------------------------!
427! Description:
428! ------------
429!> @Todo: Missing subroutine description.
430!--------------------------------------------------------------------------------------------------!
431 SUBROUTINE read_coupling_layout( nesting_datatransfer_mode, nesting_mode,                         &
432                                  anterpolation_buffer_width, anterpolation_starting_height,       &
433                                  pmc_status )
434
435    IMPLICIT NONE
436
437    CHARACTER(LEN=7), INTENT(INOUT) ::  nesting_datatransfer_mode  !<
438    CHARACTER(LEN=8), INTENT(INOUT) ::  nesting_mode               !<
439
440    INTEGER, INTENT(INOUT)      ::  anterpolation_buffer_width  !< Boundary buffer width for anterpolation
441    INTEGER(iwp), INTENT(INOUT) ::  pmc_status                  !<
442
443    REAL(wp), INTENT(INOUT) ::  anterpolation_starting_height   !< steering parameter for canopy restricted anterpolation
444
445    INTEGER(iwp) ::  bad_llcorner  !<
446    INTEGER(iwp) ::  i             !<
447    INTEGER(iwp) ::  istat         !<
448
449    TYPE(pmc_layout), DIMENSION(pmc_max_models) ::  domain_layouts  !<
450
451    NAMELIST /nesting_parameters/  domain_layouts,                                                 &
452                                   nesting_datatransfer_mode,                                      &
453                                   nesting_mode,                                                   &
454                                   anterpolation_buffer_width,                                     &
455                                   anterpolation_starting_height
456
457!
458!-- Initialize some coupling variables
459    domain_layouts(1:pmc_max_models)%id = -1
460    m_ncpl =   0
461
462    pmc_status = pmc_status_ok
463!
464!-- Open the NAMELIST-file and read the nesting layout
465    CALL check_open( 11 )
466    READ ( 11, nesting_parameters, IOSTAT = istat )
467!
468!-- Set filepointer to the beginning of the file. Otherwise process 0 will later be unable to read
469!-- the inipar-NAMELIST
470    REWIND ( 11 )
471
472    IF ( istat < 0 )  THEN
473!
474!--    No nesting_parameters-NAMELIST found
475       pmc_status = pmc_no_namelist_found
476       RETURN
477    ELSEIF ( istat > 0 )  THEN
478!
479!--    Errors in reading nesting_parameters-NAMELIST
480       pmc_status = pmc_namelist_error
481       RETURN
482    ENDIF
483!
484!-- Output location message
485    CALL location_message( 'initialize communicators for nesting', 'start' )
486!
487!-- Assign the layout to the corresponding internally used variable m_couplers
488    m_couplers = domain_layouts
489!
490!-- Get the number of nested models given in the nesting_parameters-NAMELIST
491    DO  i = 1, pmc_max_models
492!
493!--    When id=-1 is found for the first time, the list of domains is finished
494       IF ( m_couplers(i)%id == -1  .OR.  i == pmc_max_models )  THEN
495          IF ( m_couplers(i)%id == -1 )  THEN
496             m_ncpl = i - 1
497             EXIT
498          ELSE
499             m_ncpl = pmc_max_models
500          ENDIF
501       ENDIF
502    ENDDO
503!
504!-- Make sure that all domains have equal lower left corner in case of vertical nesting
505    IF ( nesting_mode == 'vertical' )  THEN
506       bad_llcorner = 0
507       DO  i = 1, m_ncpl
508          IF ( domain_layouts(i)%lower_left_x /= 0.0_wp .OR.                                       &
509               domain_layouts(i)%lower_left_y /= 0.0_wp )  THEN
510             bad_llcorner = bad_llcorner + 1
511             domain_layouts(i)%lower_left_x = 0.0_wp
512             domain_layouts(i)%lower_left_y = 0.0_wp
513          ENDIF
514       ENDDO
515       IF ( bad_llcorner /= 0)  THEN
516          WRITE( message_string, *)  'at least one dimension of lower ',                           &
517                                     'left corner of one domain is not 0. ',                       &
518                                     'All lower left corners were set to (0, 0)'
519          CALL message( 'read_coupling_layout', 'PA0427', 0, 0, 0, 6, 0 )
520       ENDIF
521    ENDIF
522
523    CALL location_message( 'initialize communicators for nesting', 'finished' )
524
525 END SUBROUTINE read_coupling_layout
526
527#endif
528 END MODULE pmc_handle_communicator
Note: See TracBrowser for help on using the repository browser.