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 trunk/NEMO/OPA_SRC – NEMO

source: trunk/NEMO/OPA_SRC/mppini.F90 @ 703

Last change on this file since 703 was 699, checked in by smasson, 17 years ago

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