New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
mppini.F90 in branches/2016/dev_r6711_SIMPLIF_6_aerobulk/NEMOGCM/NEMO/OPA_SRC/LBC – NEMO

source: branches/2016/dev_r6711_SIMPLIF_6_aerobulk/NEMOGCM/NEMO/OPA_SRC/LBC/mppini.F90 @ 7163

Last change on this file since 7163 was 7163, checked in by gm, 7 years ago

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