source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/LBC/mppini.F90 @ 6498

Last change on this file since 6498 was 6498, checked in by timgraham, 5 years ago

Merge head of nemo_v3_6_STABLE into package branch

File size: 18.1 KB
Line 
1MODULE mppini
2   !!==============================================================================
3   !!                       ***  MODULE mppini   ***
4   !! Ocean initialization : distributed memory computing initialization
5   !!==============================================================================
6
7   !!----------------------------------------------------------------------
8   !!   mpp_init       : Lay out the global domain over processors
9   !!   mpp_init2      : Lay out the global domain over processors
10   !!                    with land processor elimination
11   !!   mpp_init_ioispl: IOIPSL initialization in mpp
12   !!----------------------------------------------------------------------
13   !! * Modules used
14   USE dom_oce         ! ocean space and time domain
15   USE in_out_manager  ! I/O Manager
16   USE lib_mpp         ! distribued memory computing library
17   USE ioipsl
18
19   IMPLICIT NONE
20   PRIVATE
21
22   PUBLIC mpp_init       ! called by opa.F90
23   PUBLIC mpp_init2      ! called by opa.F90
24
25   !! * Substitutions
26#  include "domzgr_substitute.h90"
27   !!----------------------------------------------------------------------
28   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
29   !! $Id$
30   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
31   !!----------------------------------------------------------------------
32CONTAINS
33
34#if ! defined key_mpp_mpi
35   !!----------------------------------------------------------------------
36   !!   Default option :                            shared memory computing
37   !!----------------------------------------------------------------------
38
39   SUBROUTINE mpp_init
40      !!----------------------------------------------------------------------
41      !!                  ***  ROUTINE mpp_init  ***
42      !!
43      !! ** Purpose :   Lay out the global domain over processors.
44      !!
45      !! ** Method  :   Shared memory computing, set the local processor
46      !!      variables to the value of the global domain
47      !!
48      !! History :
49      !!   9.0  !  04-01  (G. Madec, J.M. Molines)  F90 : free form, north fold jpni >1
50      !!----------------------------------------------------------------------
51
52      ! No mpp computation
53      nimpp  = 1
54      njmpp  = 1
55      nlci   = jpi
56      nlcj   = jpj
57      nldi   = 1
58      nldj   = 1
59      nlei   = jpi
60      nlej   = jpj
61      nperio = jperio
62      nbondi = 2
63      nbondj = 2
64      nidom  = FLIO_DOM_NONE
65      npolj = jperio
66
67      IF(lwp) THEN
68         WRITE(numout,*)
69         WRITE(numout,*) 'mpp_init(2) : NO massively parallel processing'
70         WRITE(numout,*) '~~~~~~~~~~~: '
71         WRITE(numout,*) '         nperio = ', nperio
72         WRITE(numout,*) '         npolj  = ', npolj
73         WRITE(numout,*) '         nimpp  = ', nimpp
74         WRITE(numout,*) '         njmpp  = ', njmpp
75      ENDIF
76
77      IF(  jpni /= 1 .OR. jpnj /= 1 .OR. jpnij /= 1 ) &
78          CALL ctl_stop( 'equality  jpni = jpnj = jpnij = 1 is not satisfied',   &
79          &              'the domain is lay out for distributed memory computing! ' )
80
81   END SUBROUTINE mpp_init
82
83
84   SUBROUTINE mpp_init2 
85      CALL mpp_init                             ! same routine as mpp_init
86   END SUBROUTINE mpp_init2
87
88#else
89   !!----------------------------------------------------------------------
90   !!   'key_mpp_mpi'          OR         MPI massively parallel processing
91   !!----------------------------------------------------------------------
92
93   SUBROUTINE mpp_init
94      !!----------------------------------------------------------------------
95      !!                  ***  ROUTINE mpp_init  ***
96      !!                   
97      !! ** Purpose :   Lay out the global domain over processors.
98      !!
99      !! ** Method  :   Global domain is distributed in smaller local domains.
100      !!      Periodic condition is a function of the local domain position
101      !!      (global boundary or neighbouring domain) and of the global
102      !!      periodic
103      !!      Type :         jperio global periodic condition
104      !!                     nperio local  periodic condition
105      !!
106      !! ** Action  : - set domain parameters
107      !!                    nimpp     : longitudinal index
108      !!                    njmpp     : latitudinal  index
109      !!                    nperio    : lateral condition type
110      !!                    narea     : number for local area
111      !!                    nlci      : first dimension
112      !!                    nlcj      : second dimension
113      !!                    nbondi    : mark for "east-west local boundary"
114      !!                    nbondj    : mark for "north-south local boundary"
115      !!                    nproc     : number for local processor
116      !!                    noea      : number for local neighboring processor
117      !!                    nowe      : number for local neighboring processor
118      !!                    noso      : number for local neighboring processor
119      !!                    nono      : number for local neighboring processor
120      !!
121      !! History :
122      !!        !  94-11  (M. Guyon)  Original code
123      !!        !  95-04  (J. Escobar, M. Imbard)
124      !!        !  98-02  (M. Guyon)  FETI method
125      !!        !  98-05  (M. Imbard, J. Escobar, L. Colombet )  SHMEM and MPI versions
126      !!   8.5  !  02-08  (G. Madec)  F90 : free form
127      !!   3.4  !  11-11  (C. Harris) decomposition changes for running with CICE
128      !!----------------------------------------------------------------------
129      INTEGER  ::   ji, jj, jn   ! dummy loop indices
130      INTEGER  ::   ii, ij, ifreq, il1, il2            ! local integers
131      INTEGER  ::   iresti, irestj, ijm1, imil, inum   !   -      -
132      REAL(wp) ::   zidom, zjdom                       ! local scalars
133      INTEGER, DIMENSION(jpni,jpnj) ::   iimppt, ijmppt, ilcit, ilcjt   ! local workspace
134      !!----------------------------------------------------------------------
135
136      IF(lwp) WRITE(numout,*)
137      IF(lwp) WRITE(numout,*) 'mpp_init : Message Passing MPI'
138      IF(lwp) WRITE(numout,*) '~~~~~~~~'
139
140
141      !  1. Dimension arrays for subdomains
142      ! -----------------------------------
143      !  Computation of local domain sizes ilcit() ilcjt()
144      !  These dimensions depend on global sizes jpni,jpnj and jpiglo,jpjglo
145      !  The subdomains are squares leeser than or equal to the global
146      !  dimensions divided by the number of processors minus the overlap
147      !  array (cf. par_oce.F90).
148     
149      nreci  = 2 * jpreci
150      nrecj  = 2 * jprecj
151      iresti = MOD( jpiglo - nreci , jpni )
152      irestj = MOD( jpjglo - nrecj , jpnj )
153
154      IF(  iresti == 0 )   iresti = jpni
155
156#if defined key_nemocice_decomp
157      ! In order to match CICE the size of domains in NEMO has to be changed
158      ! The last line of blocks (west) will have fewer points
159
160      DO jj = 1, jpnj
161         DO ji=1, jpni-1
162            ilcit(ji,jj) = jpi
163         END DO
164         ilcit(jpni,jj) = jpiglo - (jpni - 1) * (jpi - nreci)
165      END DO
166
167#else
168
169      DO jj = 1, jpnj
170         DO ji = 1, iresti
171            ilcit(ji,jj) = jpi
172         END DO
173         DO ji = iresti+1, jpni
174            ilcit(ji,jj) = jpi -1
175         END DO
176      END DO
177     
178#endif
179      nfilcit(:,:) = ilcit(:,:)
180      IF( irestj == 0 )   irestj = jpnj
181
182#if defined key_nemocice_decomp
183      ! Same change to domains in North-South direction as in East-West.
184      DO ji=1,jpni
185         DO jj=1,jpnj-1
186            ilcjt(ji,jj) = jpj
187         END DO
188         ilcjt(ji,jpnj) = jpjglo - (jpnj - 1) * (jpj - nrecj)
189      END DO
190
191#else
192
193      DO ji = 1, jpni
194         DO jj = 1, irestj
195            ilcjt(ji,jj) = jpj
196         END DO
197         DO jj = irestj+1, jpnj
198            ilcjt(ji,jj) = jpj -1
199         END DO
200      END DO
201     
202#endif
203
204      !  2. Index arrays for subdomains
205      ! -------------------------------
206     
207      iimppt(:,:) = 1
208      ijmppt(:,:) = 1
209     
210      IF( jpni > 1 ) THEN
211         DO jj = 1, jpnj
212            DO ji = 2, jpni
213               iimppt(ji,jj) = iimppt(ji-1,jj) + ilcit(ji-1,jj) - nreci
214            END DO
215         END DO
216      ENDIF
217      nfiimpp(:,:)=iimppt(:,:)
218
219      IF( jpnj > 1 ) THEN
220         DO jj = 2, jpnj
221            DO ji = 1, jpni
222               ijmppt(ji,jj) = ijmppt(ji,jj-1)+ilcjt(ji,jj-1)-nrecj
223            END DO
224         END DO
225      ENDIF
226     
227      ! 3. Subdomain description
228      ! ------------------------
229
230      DO jn = 1, jpnij
231         ii = 1 + MOD( jn-1, jpni )
232         ij = 1 + (jn-1) / jpni
233         nfipproc(ii,ij) = jn - 1
234         nimppt(jn) = iimppt(ii,ij)
235         njmppt(jn) = ijmppt(ii,ij)
236         nlcit (jn) = ilcit (ii,ij)     
237         nlci       = nlcit (jn)     
238         nlcjt (jn) = ilcjt (ii,ij)     
239         nlcj       = nlcjt (jn)
240         nbondj = -1                                   ! general case
241         IF( jn   >  jpni          )   nbondj = 0      ! first row of processor
242         IF( jn   >  (jpnj-1)*jpni )   nbondj = 1      ! last  row of processor
243         IF( jpnj == 1             )   nbondj = 2      ! one processor only in j-direction
244         ibonjt(jn) = nbondj
245         
246         nbondi = 0                                    !
247         IF( MOD( jn, jpni ) == 1 )   nbondi = -1      !
248         IF( MOD( jn, jpni ) == 0 )   nbondi =  1      !
249         IF( jpni            == 1 )   nbondi =  2      ! one processor only in i-direction
250         ibonit(jn) = nbondi
251         
252         nldi =  1   + jpreci
253         nlei = nlci - jpreci
254         IF( nbondi == -1 .OR. nbondi == 2 )   nldi = 1
255         IF( nbondi ==  1 .OR. nbondi == 2 )   nlei = nlci
256         nldj =  1   + jprecj
257         nlej = nlcj - jprecj
258         IF( nbondj == -1 .OR. nbondj == 2 )   nldj = 1
259         IF( nbondj ==  1 .OR. nbondj == 2 )   nlej = nlcj
260         nldit(jn) = nldi
261         nleit(jn) = nlei
262         nldjt(jn) = nldj
263         nlejt(jn) = nlej
264      END DO
265
266      ! 4. Subdomain print
267      ! ------------------
268     
269      IF(lwp) WRITE(numout,*)
270      IF(lwp) WRITE(numout,*) ' mpp_init: defines mpp subdomains'
271      IF(lwp) WRITE(numout,*) ' ~~~~~~  ----------------------'
272      IF(lwp) WRITE(numout,*)
273      IF(lwp) WRITE(numout,*) 'iresti=',iresti,' irestj=',irestj
274      IF(lwp) WRITE(numout,*)
275      IF(lwp) WRITE(numout,*) 'jpni=',jpni,' jpnj=',jpnj
276      zidom = nreci
277      DO ji = 1, jpni
278         zidom = zidom + ilcit(ji,1) - nreci
279      END DO
280      IF(lwp) WRITE(numout,*)
281      IF(lwp) WRITE(numout,*)' sum ilcit(i,1)=', zidom, ' jpiglo=', jpiglo
282
283      zjdom = nrecj
284      DO jj = 1, jpnj
285         zjdom = zjdom + ilcjt(1,jj) - nrecj
286      END DO
287      IF(lwp) WRITE(numout,*)' sum ilcit(1,j)=', zjdom, ' jpjglo=', jpjglo
288      IF(lwp) WRITE(numout,*)
289
290      IF(lwp) THEN
291         ifreq = 4
292         il1   = 1
293         DO jn = 1, (jpni-1)/ifreq+1
294            il2 = MIN( jpni, il1+ifreq-1 )
295            WRITE(numout,*)
296            WRITE(numout,9200) ('***',ji = il1,il2-1)
297            DO jj = jpnj, 1, -1
298               WRITE(numout,9203) ('   ',ji = il1,il2-1)
299               WRITE(numout,9202) jj, ( ilcit(ji,jj),ilcjt(ji,jj),ji = il1,il2 )
300               WRITE(numout,9204) (nfipproc(ji,jj),ji=il1,il2)
301               WRITE(numout,9203) ('   ',ji = il1,il2-1)
302               WRITE(numout,9200) ('***',ji = il1,il2-1)
303            END DO
304            WRITE(numout,9201) (ji,ji = il1,il2)
305            il1 = il1+ifreq
306         END DO
307 9200     FORMAT('     ***',20('*************',a3))
308 9203     FORMAT('     *     ',20('         *   ',a3))
309 9201     FORMAT('        ',20('   ',i3,'          '))
310 9202     FORMAT(' ',i3,' *  ',20(i3,'  x',i3,'   *   '))
311 9204     FORMAT('     *  ',20('      ',i3,'   *   '))
312      ENDIF
313
314      ! 5. From global to local
315      ! -----------------------
316
317      nperio = 0
318      IF( jperio == 2 .AND. nbondj == -1 )   nperio = 2
319
320
321      ! 6. Subdomain neighbours
322      ! ----------------------
323
324      nproc = narea - 1
325      noso  = nproc - jpni
326      nowe  = nproc - 1
327      noea  = nproc + 1
328      nono  = nproc + jpni
329      ! great neighbours
330      npnw = nono - 1
331      npne = nono + 1
332      npsw = noso - 1
333      npse = noso + 1
334      nbsw = 1
335      nbnw = 1
336      IF( MOD( nproc, jpni ) == 0 ) THEN
337         nbsw = 0
338         nbnw = 0
339      ENDIF
340      nbse = 1
341      nbne = 1
342      IF( MOD( nproc, jpni ) == jpni-1 ) THEN
343         nbse = 0
344         nbne = 0
345      ENDIF
346      IF(nproc < jpni) THEN
347         nbsw = 0
348         nbse = 0
349      ENDIF
350      IF( nproc >= (jpnj-1)*jpni ) THEN
351         nbnw = 0
352         nbne = 0
353      ENDIF
354      nlcj = nlcjt(narea) 
355      nlci = nlcit(narea) 
356      nldi = nldit(narea)
357      nlei = nleit(narea)
358      nldj = nldjt(narea)
359      nlej = nlejt(narea)
360      nbondi = ibonit(narea)
361      nbondj = ibonjt(narea)
362      nimpp  = nimppt(narea) 
363      njmpp  = njmppt(narea) 
364
365     ! Save processor layout in layout.dat file
366       IF (lwp) THEN
367        CALL ctl_opn( inum, 'layout.dat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., narea )
368        WRITE(inum,'(a)') '   jpnij     jpi     jpj     jpk  jpiglo  jpjglo'
369        WRITE(inum,'(6i8)') jpnij,jpi,jpj,jpk,jpiglo,jpjglo
370        WRITE(inum,'(a)') 'NAREA nlci nlcj nldi nldj nlei nlej nimpp njmpp'
371
372        DO  jn = 1, jpnij
373         WRITE(inum,'(9i5)') jn, nlcit(jn), nlcjt(jn), &
374                                      nldit(jn), nldjt(jn), &
375                                      nleit(jn), nlejt(jn), &
376                                      nimppt(jn), njmppt(jn)
377        END DO
378        CLOSE(inum)   
379      END IF
380
381
382      ! w a r n i n g  narea (zone) /= nproc (processors)!
383
384      IF( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 ) THEN
385         IF( jpni == 1 )THEN
386            nbondi = 2
387            nperio = 1
388         ELSE
389            nbondi = 0
390         ENDIF
391         IF( MOD( narea, jpni ) == 0 ) THEN
392            noea = nproc-(jpni-1)
393            npne = npne-jpni
394            npse = npse-jpni
395         ENDIF
396         IF( MOD( narea, jpni ) == 1 ) THEN
397            nowe = nproc+(jpni-1)
398            npnw = npnw+jpni
399            npsw = npsw+jpni
400         ENDIF
401         nbsw = 1
402         nbnw = 1
403         nbse = 1
404         nbne = 1
405         IF( nproc < jpni ) THEN
406            nbsw = 0
407            nbse = 0
408         ENDIF
409         IF( nproc >= (jpnj-1)*jpni ) THEN
410            nbnw = 0
411            nbne = 0
412         ENDIF
413      ENDIF
414      npolj = 0
415      IF( jperio == 3 .OR. jperio == 4 ) THEN
416         ijm1 = jpni*(jpnj-1)
417         imil = ijm1+(jpni+1)/2
418         IF( narea > ijm1 ) npolj = 3
419         IF( MOD(jpni,2) == 1 .AND. narea == imil ) npolj = 4
420         IF( npolj == 3 ) nono = jpni*jpnj-narea+ijm1
421      ENDIF
422      IF( jperio == 5 .OR. jperio == 6 ) THEN
423          ijm1 = jpni*(jpnj-1)
424          imil = ijm1+(jpni+1)/2
425          IF( narea > ijm1) npolj = 5
426          IF( MOD(jpni,2) == 1 .AND. narea == imil ) npolj = 6
427          IF( npolj == 5 ) nono = jpni*jpnj-narea+ijm1
428      ENDIF
429
430      ! Periodicity : no corner if nbondi = 2 and nperio != 1
431
432      IF(lwp) THEN
433         WRITE(numout,*) ' nproc  = ', nproc
434         WRITE(numout,*) ' nowe   = ', nowe  , ' noea   =  ', noea
435         WRITE(numout,*) ' nono   = ', nono  , ' noso   =  ', noso
436         WRITE(numout,*) ' nbondi = ', nbondi
437         WRITE(numout,*) ' nbondj = ', nbondj
438         WRITE(numout,*) ' npolj  = ', npolj
439         WRITE(numout,*) ' nperio = ', nperio
440         WRITE(numout,*) ' nlci   = ', nlci
441         WRITE(numout,*) ' nlcj   = ', nlcj
442         WRITE(numout,*) ' nimpp  = ', nimpp
443         WRITE(numout,*) ' njmpp  = ', njmpp
444         WRITE(numout,*) ' nreci  = ', nreci  , ' npse   = ', npse
445         WRITE(numout,*) ' nrecj  = ', nrecj  , ' npsw   = ', npsw
446         WRITE(numout,*) ' jpreci = ', jpreci , ' npne   = ', npne
447         WRITE(numout,*) ' jprecj = ', jprecj , ' npnw   = ', npnw
448         WRITE(numout,*)
449      ENDIF
450
451      IF( nperio == 1 .AND. jpni /= 1 ) CALL ctl_stop( ' mpp_init: error on cyclicity' )
452
453      ! Prepare mpp north fold
454
455      IF( jperio >= 3 .AND. jperio <= 6 .AND. jpni > 1 ) THEN
456         CALL mpp_ini_north
457         IF(lwp) WRITE(numout,*) ' mpp_init : North fold boundary prepared for jpni >1'
458      ENDIF
459
460      ! Prepare NetCDF output file (if necessary)
461      CALL mpp_init_ioipsl
462
463   END SUBROUTINE mpp_init
464
465#  include "mppini_2.h90"
466
467# if defined key_dimgout
468   !!----------------------------------------------------------------------
469   !!   'key_dimgout'                  NO use of NetCDF files
470   !!----------------------------------------------------------------------
471   SUBROUTINE mpp_init_ioipsl       ! Dummy routine
472   END SUBROUTINE mpp_init_ioipsl 
473# else
474   SUBROUTINE mpp_init_ioipsl
475      !!----------------------------------------------------------------------
476      !!                  ***  ROUTINE mpp_init_ioipsl  ***
477      !!
478      !! ** Purpose :   
479      !!
480      !! ** Method  :   
481      !!
482      !! History :
483      !!   9.0  !  04-03  (G. Madec )  MPP-IOIPSL
484      !!   " "  !  08-12  (A. Coward)  addition in case of jpni*jpnj < jpnij
485      !!----------------------------------------------------------------------
486      INTEGER, DIMENSION(2) ::   iglo, iloc, iabsf, iabsl, ihals, ihale, idid
487      !!----------------------------------------------------------------------
488
489      ! The domain is split only horizontally along i- or/and j- direction
490      ! So we need at the most only 1D arrays with 2 elements.
491      ! Set idompar values equivalent to the jpdom_local_noextra definition
492      ! used in IOM. This works even if jpnij .ne. jpni*jpnj.
493      iglo(1) = jpiglo
494      iglo(2) = jpjglo
495      iloc(1) = nlci
496      iloc(2) = nlcj
497      iabsf(1) = nimppt(narea)
498      iabsf(2) = njmppt(narea)
499      iabsl(:) = iabsf(:) + iloc(:) - 1
500      ihals(1) = nldi - 1
501      ihals(2) = nldj - 1
502      ihale(1) = nlci - nlei
503      ihale(2) = nlcj - nlej
504      idid(1) = 1
505      idid(2) = 2
506
507      IF(lwp) THEN
508          WRITE(numout,*)
509          WRITE(numout,*) 'mpp_init_ioipsl :   iloc  = ', iloc (1), iloc (2)
510          WRITE(numout,*) '~~~~~~~~~~~~~~~     iabsf = ', iabsf(1), iabsf(2)
511          WRITE(numout,*) '                    ihals = ', ihals(1), ihals(2)
512          WRITE(numout,*) '                    ihale = ', ihale(1), ihale(2)
513      ENDIF
514      !
515      CALL flio_dom_set ( jpnij, nproc, idid, iglo, iloc, iabsf, iabsl, ihals, ihale, 'BOX', nidom)
516      !
517   END SUBROUTINE mpp_init_ioipsl 
518
519# endif
520#endif
521
522   !!======================================================================
523END MODULE mppini
Note: See TracBrowser for help on using the repository browser.