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 @ 1581

Last change on this file since 1581 was 1581, checked in by smasson, 15 years ago

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