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.
lib_mpp.F90 in NEMO/trunk/src/OCE/LBC – NEMO

source: NEMO/trunk/src/OCE/LBC/lib_mpp.F90 @ 11536

Last change on this file since 11536 was 11536, checked in by smasson, 5 years ago

trunk: merge dev_r10984_HPC-13 into the trunk

  • Property svn:keywords set to Id
File size: 56.2 KB
RevLine 
[3]1MODULE lib_mpp
[13]2   !!======================================================================
3   !!                       ***  MODULE  lib_mpp  ***
[1344]4   !! Ocean numerics:  massively parallel processing library
[13]5   !!=====================================================================
[1344]6   !! History :  OPA  !  1994  (M. Guyon, J. Escobar, M. Imbard)  Original code
7   !!            7.0  !  1997  (A.M. Treguier)  SHMEM additions
8   !!            8.0  !  1998  (M. Imbard, J. Escobar, L. Colombet ) SHMEM and MPI
9   !!                 !  1998  (J.M. Molines) Open boundary conditions
[9019]10   !!   NEMO     1.0  !  2003  (J.M. Molines, G. Madec)  F90, free form
[1344]11   !!                 !  2003  (J.M. Molines) add mpp_ini_north(_3d,_2d)
12   !!             -   !  2004  (R. Bourdalle Badie)  isend option in mpi
13   !!                 !  2004  (J.M. Molines) minloc, maxloc
14   !!             -   !  2005  (G. Madec, S. Masson)  npolj=5,6 F-point & ice cases
15   !!             -   !  2005  (R. Redler) Replacement of MPI_COMM_WORLD except for MPI_Abort
16   !!             -   !  2005  (R. Benshila, G. Madec)  add extra halo case
17   !!             -   !  2008  (R. Benshila) add mpp_ini_ice
18   !!            3.2  !  2009  (R. Benshila) SHMEM suppression, north fold in lbc_nfd
[3764]19   !!            3.2  !  2009  (O. Marti)    add mpp_ini_znl
[2715]20   !!            4.0  !  2011  (G. Madec)  move ctl_ routines from in_out_manager
[9019]21   !!            3.5  !  2012  (S.Mocavero, I. Epicoco) Add mpp_lnk_bdy_3d/2d routines to optimize the BDY comm.
22   !!            3.5  !  2013  (C. Ethe, G. Madec)  message passing arrays as local variables
[6140]23   !!            3.5  !  2013  (S.Mocavero, I.Epicoco - CMCC) north fold optimizations
[9019]24   !!            3.6  !  2015  (O. Tintó and M. Castrillo - BSC) Added '_multiple' case for 2D lbc and max
25   !!            4.0  !  2017  (G. Madec) automatique allocation of array argument (use any 3rd dimension)
26   !!             -   !  2017  (G. Madec) create generic.h90 files to generate all lbc and north fold routines
[13]27   !!----------------------------------------------------------------------
[2715]28
29   !!----------------------------------------------------------------------
[6140]30   !!   ctl_stop      : update momentum and tracer Kz from a tke scheme
31   !!   ctl_warn      : initialization, namelist read, and parameters control
32   !!   ctl_opn       : Open file and check if required file is available.
33   !!   ctl_nam       : Prints informations when an error occurs while reading a namelist
[2715]34   !!----------------------------------------------------------------------
[13]35   !!----------------------------------------------------------------------
[11536]36   !!   mpp_start     : get local communicator its size and rank
[2715]37   !!   mpp_lnk       : interface (defined in lbclnk) for message passing of 2d or 3d arrays (mpp_lnk_2d, mpp_lnk_3d)
[4990]38   !!   mpp_lnk_icb   : interface for message passing of 2d arrays with extra halo for icebergs (mpp_lnk_2d_icb)
[6140]39   !!   mpprecv       :
[9019]40   !!   mppsend       :
[2715]41   !!   mppscatter    :
42   !!   mppgather     :
43   !!   mpp_min       : generic interface for mppmin_int , mppmin_a_int , mppmin_real, mppmin_a_real
44   !!   mpp_max       : generic interface for mppmax_int , mppmax_a_int , mppmax_real, mppmax_a_real
45   !!   mpp_sum       : generic interface for mppsum_int , mppsum_a_int , mppsum_real, mppsum_a_real
46   !!   mpp_minloc    :
47   !!   mpp_maxloc    :
48   !!   mppsync       :
49   !!   mppstop       :
[1344]50   !!   mpp_ini_north : initialisation of north fold
[9019]51   !!   mpp_lbc_north_icb : alternative to mpp_nfd for extra outer halo with icebergs
[13]52   !!----------------------------------------------------------------------
[3764]53   USE dom_oce        ! ocean space and time domain
[2715]54   USE in_out_manager ! I/O manager
[3]55
[13]56   IMPLICIT NONE
[415]57   PRIVATE
[9019]58   !
[11536]59   PUBLIC   ctl_stop, ctl_warn, ctl_opn, ctl_nam
60   PUBLIC   mpp_start, mppstop, mppsync, mpp_comm_free
[9019]61   PUBLIC   mpp_ini_north
[1344]62   PUBLIC   mpp_min, mpp_max, mpp_sum, mpp_minloc, mpp_maxloc
[10425]63   PUBLIC   mpp_delay_max, mpp_delay_sum, mpp_delay_rcv
[3294]64   PUBLIC   mppscatter, mppgather
[10425]65   PUBLIC   mpp_ini_znl
[3764]66   PUBLIC   mppsend, mpprecv                          ! needed by TAM and ICB routines
[11536]67   PUBLIC   mpp_report
68   PUBLIC   tic_tac
69#if ! defined key_mpp_mpi
70   PUBLIC MPI_Wtime
71#endif
[5429]72   
[13]73   !! * Interfaces
74   !! define generic interface for these routine as they are called sometimes
[1344]75   !! with scalar arguments instead of array arguments, which causes problems
76   !! for the compilation on AIX system as well as NEC and SGI. Ok on COMPACQ
[13]77   INTERFACE mpp_min
78      MODULE PROCEDURE mppmin_a_int, mppmin_int, mppmin_a_real, mppmin_real
79   END INTERFACE
80   INTERFACE mpp_max
[681]81      MODULE PROCEDURE mppmax_a_int, mppmax_int, mppmax_a_real, mppmax_real
[13]82   END INTERFACE
83   INTERFACE mpp_sum
[6140]84      MODULE PROCEDURE mppsum_a_int, mppsum_int, mppsum_a_real, mppsum_real,   &
[9019]85         &             mppsum_realdd, mppsum_a_realdd
[13]86   END INTERFACE
[1344]87   INTERFACE mpp_minloc
88      MODULE PROCEDURE mpp_minloc2d ,mpp_minloc3d
89   END INTERFACE
90   INTERFACE mpp_maxloc
91      MODULE PROCEDURE mpp_maxloc2d ,mpp_maxloc3d
92   END INTERFACE
[6490]93
[51]94   !! ========================= !!
95   !!  MPI  variable definition !!
96   !! ========================= !!
[11536]97#if   defined key_mpp_mpi
[1629]98!$AGRIF_DO_NOT_TREAT
[2004]99   INCLUDE 'mpif.h'
[1629]100!$AGRIF_END_DO_NOT_TREAT
[1344]101   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp = .TRUE.    !: mpp flag
[11536]102#else   
103   INTEGER, PUBLIC, PARAMETER ::   MPI_STATUS_SIZE = 1
104   INTEGER, PUBLIC, PARAMETER ::   MPI_DOUBLE_PRECISION = 8
105   LOGICAL, PUBLIC, PARAMETER ::   lk_mpp = .FALSE.    !: mpp flag
106#endif
[3]107
[1344]108   INTEGER, PARAMETER         ::   nprocmax = 2**10   ! maximun dimension (required to be a power of 2)
[3764]109
[10425]110   INTEGER, PUBLIC ::   mppsize        ! number of process
111   INTEGER, PUBLIC ::   mpprank        ! process number  [ 0 - size-1 ]
[2363]112!$AGRIF_DO_NOT_TREAT
[9570]113   INTEGER, PUBLIC ::   mpi_comm_oce   ! opa local communicator
[2363]114!$AGRIF_END_DO_NOT_TREAT
[3]115
[2480]116   INTEGER :: MPI_SUMDD
[1976]117
[1345]118   ! variables used for zonal integration
119   INTEGER, PUBLIC ::   ncomm_znl       !: communicator made by the processors on the same zonal average
[9019]120   LOGICAL, PUBLIC ::   l_znl_root      !: True on the 'left'most processor on the same row
121   INTEGER         ::   ngrp_znl        !  group ID for the znl processors
122   INTEGER         ::   ndim_rank_znl   !  number of processors on the same zonal average
[2715]123   INTEGER, DIMENSION(:), ALLOCATABLE, SAVE ::   nrank_znl  ! dimension ndim_rank_znl, number of the procs into the same znl domain
[3]124
[3764]125   ! North fold condition in mpp_mpi with jpni > 1 (PUBLIC for TAM)
[9019]126   INTEGER, PUBLIC ::   ngrp_world        !: group ID for the world processors
127   INTEGER, PUBLIC ::   ngrp_opa          !: group ID for the opa processors
128   INTEGER, PUBLIC ::   ngrp_north        !: group ID for the northern processors (to be fold)
129   INTEGER, PUBLIC ::   ncomm_north       !: communicator made by the processors belonging to ngrp_north
130   INTEGER, PUBLIC ::   ndim_rank_north   !: number of 'sea' processor in the northern line (can be /= jpni !)
131   INTEGER, PUBLIC ::   njmppmax          !: value of njmpp for the processors of the northern line
132   INTEGER, PUBLIC ::   north_root        !: number (in the comm_opa) of proc 0 in the northern comm
133   INTEGER, PUBLIC, DIMENSION(:), ALLOCATABLE, SAVE ::   nrank_north   !: dimension ndim_rank_north
[3764]134
[10425]135   ! Communications summary report
136   CHARACTER(len=128), DIMENSION(:), ALLOCATABLE ::   crname_lbc                   !: names of lbc_lnk calling routines
[10437]137   CHARACTER(len=128), DIMENSION(:), ALLOCATABLE ::   crname_glb                   !: names of global comm calling routines
138   CHARACTER(len=128), DIMENSION(:), ALLOCATABLE ::   crname_dlg                   !: names of delayed global comm calling routines
[10425]139   INTEGER, PUBLIC                               ::   ncom_stp = 0                 !: copy of time step # istp
140   INTEGER, PUBLIC                               ::   ncom_fsbc = 1                !: copy of sbc time step # nn_fsbc
141   INTEGER, PUBLIC                               ::   ncom_dttrc = 1               !: copy of top time step # nn_dttrc
142   INTEGER, PUBLIC                               ::   ncom_freq                    !: frequency of comm diagnostic
143   INTEGER, PUBLIC , DIMENSION(:,:), ALLOCATABLE ::   ncomm_sequence               !: size of communicated arrays (halos)
[10781]144   INTEGER, PARAMETER, PUBLIC                    ::   ncom_rec_max = 5000          !: max number of communication record
[10425]145   INTEGER, PUBLIC                               ::   n_sequence_lbc = 0           !: # of communicated arraysvia lbc
146   INTEGER, PUBLIC                               ::   n_sequence_glb = 0           !: # of global communications
[10437]147   INTEGER, PUBLIC                               ::   n_sequence_dlg = 0           !: # of delayed global communications
[10425]148   INTEGER, PUBLIC                               ::   numcom = -1                  !: logical unit for communicaton report
149   LOGICAL, PUBLIC                               ::   l_full_nf_update = .TRUE.    !: logical for a full (2lines) update of bc at North fold report
150   INTEGER,                    PARAMETER, PUBLIC ::   nbdelay = 2       !: number of delayed operations
151   !: name (used as id) of allreduce-delayed operations
[10521]152   ! Warning: we must use the same character length in an array constructor (at least for gcc compiler)
153   CHARACTER(len=32), DIMENSION(nbdelay), PUBLIC ::   c_delaylist = (/ 'cflice', 'fwb   ' /)
[10425]154   !: component name where the allreduce-delayed operation is performed
155   CHARACTER(len=3),  DIMENSION(nbdelay), PUBLIC ::   c_delaycpnt = (/ 'ICE'   , 'OCE' /)
156   TYPE, PUBLIC ::   DELAYARR
157      REAL(   wp), POINTER, DIMENSION(:) ::  z1d => NULL()
158      COMPLEX(wp), POINTER, DIMENSION(:) ::  y1d => NULL()
159   END TYPE DELAYARR
[10817]160   TYPE( DELAYARR ), DIMENSION(nbdelay), PUBLIC, SAVE  ::   todelay         !: must have SAVE for default initialization of DELAYARR
161   INTEGER,          DIMENSION(nbdelay), PUBLIC        ::   ndelayid = -1   !: mpi request id of the delayed operations
[10425]162
163   ! timing summary report
164   REAL(wp), DIMENSION(2), PUBLIC ::  waiting_time = 0._wp
165   REAL(wp)              , PUBLIC ::  compute_time = 0._wp, elapsed_time = 0._wp
166   
[9019]167   REAL(wp), DIMENSION(:), ALLOCATABLE, SAVE ::   tampon   ! buffer in case of bsend
[3]168
[9019]169   LOGICAL, PUBLIC ::   ln_nnogather                !: namelist control of northfold comms
170   LOGICAL, PUBLIC ::   l_north_nogather = .FALSE.  !: internal control of northfold comms
[11536]171   
[51]172   !!----------------------------------------------------------------------
[9598]173   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[888]174   !! $Id$
[10068]175   !! Software governed by the CeCILL license (see ./LICENSE)
[1344]176   !!----------------------------------------------------------------------
[3]177CONTAINS
178
[11536]179   SUBROUTINE mpp_start( localComm )
[2715]180      !!----------------------------------------------------------------------
[11536]181      !!                  ***  routine mpp_start  ***
[3764]182      !!
[11536]183      !! ** Purpose :   get mpi_comm_oce, mpprank and mppsize
[51]184      !!----------------------------------------------------------------------
[6140]185      INTEGER         , OPTIONAL   , INTENT(in   ) ::   localComm    !
[2715]186      !
[11536]187      INTEGER ::   ierr
188      LOGICAL ::   llmpi_init
[51]189      !!----------------------------------------------------------------------
[11536]190#if defined key_mpp_mpi
[1344]191      !
[11536]192      CALL mpi_initialized ( llmpi_init, ierr )
193      IF( ierr /= MPI_SUCCESS ) CALL ctl_stop( 'STOP', ' lib_mpp: Error in routine mpi_initialized' )
[2715]194
[11536]195      IF( .NOT. llmpi_init ) THEN
196         IF( PRESENT(localComm) ) THEN
197            WRITE(ctmp1,*) ' lib_mpp: You cannot provide a local communicator '
198            WRITE(ctmp2,*) '          without calling MPI_Init before ! '
199            CALL ctl_stop( 'STOP', ctmp1, ctmp2 )
200         ENDIF
201         CALL mpi_init( ierr )
202         IF( ierr /= MPI_SUCCESS ) CALL ctl_stop( 'STOP', ' lib_mpp: Error in routine mpi_init' )
[2480]203      ENDIF
[11536]204       
[3764]205      IF( PRESENT(localComm) ) THEN
[2480]206         IF( Agrif_Root() ) THEN
[9570]207            mpi_comm_oce = localComm
[2480]208         ENDIF
209      ELSE
[11536]210         CALL mpi_comm_dup( mpi_comm_world, mpi_comm_oce, ierr)
211         IF( ierr /= MPI_SUCCESS ) CALL ctl_stop( 'STOP', ' lib_mpp: Error in routine mpi_comm_dup' )
[3764]212      ENDIF
[2480]213
[11536]214# if defined key_agrif
[9019]215      IF( Agrif_Root() ) THEN
[9570]216         CALL Agrif_MPI_Init(mpi_comm_oce)
[5656]217      ELSE
[9570]218         CALL Agrif_MPI_set_grid_comm(mpi_comm_oce)
[5656]219      ENDIF
[11536]220# endif
[5656]221
[9570]222      CALL mpi_comm_rank( mpi_comm_oce, mpprank, ierr )
223      CALL mpi_comm_size( mpi_comm_oce, mppsize, ierr )
[3764]224      !
[1976]225      CALL MPI_OP_CREATE(DDPDD_MPI, .TRUE., MPI_SUMDD, ierr)
226      !
[11536]227#else
228      IF( PRESENT( localComm ) ) mpi_comm_oce = localComm
229      mppsize = 1
230      mpprank = 0
231#endif
232   END SUBROUTINE mpp_start
[3]233
[6140]234
[1344]235   SUBROUTINE mppsend( ktyp, pmess, kbytes, kdest, md_req )
[51]236      !!----------------------------------------------------------------------
237      !!                  ***  routine mppsend  ***
[3764]238      !!
[51]239      !! ** Purpose :   Send messag passing array
240      !!
241      !!----------------------------------------------------------------------
[1344]242      REAL(wp), INTENT(inout) ::   pmess(*)   ! array of real
243      INTEGER , INTENT(in   ) ::   kbytes     ! size of the array pmess
244      INTEGER , INTENT(in   ) ::   kdest      ! receive process number
245      INTEGER , INTENT(in   ) ::   ktyp       ! tag of the message
246      INTEGER , INTENT(in   ) ::   md_req     ! argument for isend
247      !!
248      INTEGER ::   iflag
[51]249      !!----------------------------------------------------------------------
[1344]250      !
[11536]251#if defined key_mpp_mpi
252      CALL mpi_isend( pmess, kbytes, mpi_double_precision, kdest , ktyp, mpi_comm_oce, md_req, iflag )
253#endif
[1344]254      !
[51]255   END SUBROUTINE mppsend
[3]256
257
[3294]258   SUBROUTINE mpprecv( ktyp, pmess, kbytes, ksource )
[51]259      !!----------------------------------------------------------------------
260      !!                  ***  routine mpprecv  ***
261      !!
262      !! ** Purpose :   Receive messag passing array
263      !!
264      !!----------------------------------------------------------------------
[1344]265      REAL(wp), INTENT(inout) ::   pmess(*)   ! array of real
266      INTEGER , INTENT(in   ) ::   kbytes     ! suze of the array pmess
267      INTEGER , INTENT(in   ) ::   ktyp       ! Tag of the recevied message
[3764]268      INTEGER, OPTIONAL, INTENT(in) :: ksource    ! source process number
[1344]269      !!
[51]270      INTEGER :: istatus(mpi_status_size)
271      INTEGER :: iflag
[3294]272      INTEGER :: use_source
[1344]273      !!----------------------------------------------------------------------
274      !
[11536]275#if defined key_mpp_mpi
[3764]276      ! If a specific process number has been passed to the receive call,
[3294]277      ! use that one. Default is to use mpi_any_source
[6140]278      use_source = mpi_any_source
279      IF( PRESENT(ksource) )   use_source = ksource
280      !
[9570]281      CALL mpi_recv( pmess, kbytes, mpi_double_precision, use_source, ktyp, mpi_comm_oce, istatus, iflag )
[11536]282#endif
[1344]283      !
[51]284   END SUBROUTINE mpprecv
[3]285
286
[51]287   SUBROUTINE mppgather( ptab, kp, pio )
288      !!----------------------------------------------------------------------
289      !!                   ***  routine mppgather  ***
[3764]290      !!
291      !! ** Purpose :   Transfert between a local subdomain array and a work
[51]292      !!     array which is distributed following the vertical level.
293      !!
[1344]294      !!----------------------------------------------------------------------
[6140]295      REAL(wp), DIMENSION(jpi,jpj)      , INTENT(in   ) ::   ptab   ! subdomain input array
296      INTEGER                           , INTENT(in   ) ::   kp     ! record length
[1344]297      REAL(wp), DIMENSION(jpi,jpj,jpnij), INTENT(  out) ::   pio    ! subdomain input array
[51]298      !!
[1344]299      INTEGER :: itaille, ierror   ! temporary integer
[51]300      !!---------------------------------------------------------------------
[1344]301      !
302      itaille = jpi * jpj
[11536]303#if defined key_mpp_mpi
[1344]304      CALL mpi_gather( ptab, itaille, mpi_double_precision, pio, itaille     ,   &
[9570]305         &                            mpi_double_precision, kp , mpi_comm_oce, ierror )
[11536]306#else
307      pio(:,:,1) = ptab(:,:)
308#endif
[1344]309      !
[51]310   END SUBROUTINE mppgather
[3]311
312
[51]313   SUBROUTINE mppscatter( pio, kp, ptab )
314      !!----------------------------------------------------------------------
315      !!                  ***  routine mppscatter  ***
316      !!
[3764]317      !! ** Purpose :   Transfert between awork array which is distributed
[51]318      !!      following the vertical level and the local subdomain array.
319      !!
320      !!----------------------------------------------------------------------
[6140]321      REAL(wp), DIMENSION(jpi,jpj,jpnij)  ::   pio    ! output array
322      INTEGER                             ::   kp     ! Tag (not used with MPI
323      REAL(wp), DIMENSION(jpi,jpj)        ::   ptab   ! subdomain array input
[1344]324      !!
325      INTEGER :: itaille, ierror   ! temporary integer
[51]326      !!---------------------------------------------------------------------
[1344]327      !
[6140]328      itaille = jpi * jpj
[1344]329      !
[11536]330#if defined key_mpp_mpi
[1344]331      CALL mpi_scatter( pio, itaille, mpi_double_precision, ptab, itaille     ,   &
[9570]332         &                            mpi_double_precision, kp  , mpi_comm_oce, ierror )
[11536]333#else
334      ptab(:,:) = pio(:,:,1)
335#endif
[1344]336      !
[51]337   END SUBROUTINE mppscatter
[3]338
[10425]339   
340   SUBROUTINE mpp_delay_sum( cdname, cdelay, y_in, pout, ldlast, kcom )
341     !!----------------------------------------------------------------------
342      !!                   ***  routine mpp_delay_sum  ***
[1344]343      !!
[10425]344      !! ** Purpose :   performed delayed mpp_sum, the result is received on next call
345      !!
[1344]346      !!----------------------------------------------------------------------
[10425]347      CHARACTER(len=*), INTENT(in   )               ::   cdname  ! name of the calling subroutine
348      CHARACTER(len=*), INTENT(in   )               ::   cdelay  ! name (used as id) of the delayed operation
349      COMPLEX(wp),      INTENT(in   ), DIMENSION(:) ::   y_in
350      REAL(wp),         INTENT(  out), DIMENSION(:) ::   pout
351      LOGICAL,          INTENT(in   )               ::   ldlast  ! true if this is the last time we call this routine
352      INTEGER,          INTENT(in   ), OPTIONAL     ::   kcom
[1344]353      !!
[10425]354      INTEGER ::   ji, isz
355      INTEGER ::   idvar
356      INTEGER ::   ierr, ilocalcomm
357      COMPLEX(wp), ALLOCATABLE, DIMENSION(:) ::   ytmp
[1344]358      !!----------------------------------------------------------------------
[11536]359#if defined key_mpp_mpi
[9570]360      ilocalcomm = mpi_comm_oce
[9019]361      IF( PRESENT(kcom) )   ilocalcomm = kcom
[3]362
[10425]363      isz = SIZE(y_in)
364     
[10437]365      IF( narea == 1 .AND. numcom == -1 ) CALL mpp_report( cdname, ld_dlg = .TRUE. )
[13]366
[10425]367      idvar = -1
368      DO ji = 1, nbdelay
369         IF( TRIM(cdelay) == TRIM(c_delaylist(ji)) ) idvar = ji
370      END DO
371      IF ( idvar == -1 )   CALL ctl_stop( 'STOP',' mpp_delay_sum : please add a new delayed exchange for '//TRIM(cdname) )
372
373      IF ( ndelayid(idvar) == 0 ) THEN         ! first call    with restart: %z1d defined in iom_delay_rst
374         !                                       --------------------------
375         IF ( SIZE(todelay(idvar)%z1d) /= isz ) THEN                  ! Check dimension coherence
376            IF(lwp) WRITE(numout,*) ' WARNING: the nb of delayed variables in restart file is not the model one'
377            DEALLOCATE(todelay(idvar)%z1d)
378            ndelayid(idvar) = -1                                      ! do as if we had no restart
379         ELSE
380            ALLOCATE(todelay(idvar)%y1d(isz))
381            todelay(idvar)%y1d(:) = CMPLX(todelay(idvar)%z1d(:), 0., wp)   ! create %y1d, complex variable needed by mpi_sumdd
382         END IF
383      ENDIF
384     
385      IF( ndelayid(idvar) == -1 ) THEN         ! first call without restart: define %y1d and %z1d from y_in with blocking allreduce
386         !                                       --------------------------
387         ALLOCATE(todelay(idvar)%z1d(isz), todelay(idvar)%y1d(isz))   ! allocate also %z1d as used for the restart
388         CALL mpi_allreduce( y_in(:), todelay(idvar)%y1d(:), isz, MPI_DOUBLE_COMPLEX, mpi_sumdd, ilocalcomm, ierr )   ! get %y1d
389         todelay(idvar)%z1d(:) = REAL(todelay(idvar)%y1d(:), wp)      ! define %z1d from %y1d
390      ENDIF
391
392      IF( ndelayid(idvar) > 0 )   CALL mpp_delay_rcv( idvar )         ! make sure %z1d is received
393
394      ! send back pout from todelay(idvar)%z1d defined at previous call
395      pout(:) = todelay(idvar)%z1d(:)
396
397      ! send y_in into todelay(idvar)%y1d with a non-blocking communication
[11536]398# if defined key_mpi2
[10526]399      IF( ln_timing ) CALL tic_tac( .TRUE., ld_global = .TRUE.)
400      CALL  mpi_allreduce( y_in(:), todelay(idvar)%y1d(:), isz, MPI_DOUBLE_COMPLEX, mpi_sumdd, ilocalcomm, ndelayid(idvar), ierr )
401      IF( ln_timing ) CALL tic_tac(.FALSE., ld_global = .TRUE.)
[11536]402# else
403      CALL mpi_iallreduce( y_in(:), todelay(idvar)%y1d(:), isz, MPI_DOUBLE_COMPLEX, mpi_sumdd, ilocalcomm, ndelayid(idvar), ierr )
404# endif
[10526]405#else
[11536]406      pout(:) = REAL(y_in(:), wp)
[10526]407#endif
[10425]408
409   END SUBROUTINE mpp_delay_sum
410
[9019]411   
[10425]412   SUBROUTINE mpp_delay_max( cdname, cdelay, p_in, pout, ldlast, kcom )
[9019]413      !!----------------------------------------------------------------------
[10425]414      !!                   ***  routine mpp_delay_max  ***
[9019]415      !!
[10425]416      !! ** Purpose :   performed delayed mpp_max, the result is received on next call
[9019]417      !!
418      !!----------------------------------------------------------------------
[10425]419      CHARACTER(len=*), INTENT(in   )                 ::   cdname  ! name of the calling subroutine
420      CHARACTER(len=*), INTENT(in   )                 ::   cdelay  ! name (used as id) of the delayed operation
421      REAL(wp),         INTENT(in   ), DIMENSION(:)   ::   p_in    !
422      REAL(wp),         INTENT(  out), DIMENSION(:)   ::   pout    !
423      LOGICAL,          INTENT(in   )                 ::   ldlast  ! true if this is the last time we call this routine
424      INTEGER,          INTENT(in   ), OPTIONAL       ::   kcom
[9019]425      !!
[10425]426      INTEGER ::   ji, isz
427      INTEGER ::   idvar
428      INTEGER ::   ierr, ilocalcomm
[9019]429      !!----------------------------------------------------------------------
[11536]430#if defined key_mpp_mpi
[9570]431      ilocalcomm = mpi_comm_oce
[9019]432      IF( PRESENT(kcom) )   ilocalcomm = kcom
[6140]433
[10425]434      isz = SIZE(p_in)
[9019]435
[10437]436      IF( narea == 1 .AND. numcom == -1 ) CALL mpp_report( cdname, ld_dlg = .TRUE. )
[13]437
[10425]438      idvar = -1
439      DO ji = 1, nbdelay
440         IF( TRIM(cdelay) == TRIM(c_delaylist(ji)) ) idvar = ji
441      END DO
442      IF ( idvar == -1 )   CALL ctl_stop( 'STOP',' mpp_delay_max : please add a new delayed exchange for '//TRIM(cdname) )
[3]443
[10425]444      IF ( ndelayid(idvar) == 0 ) THEN         ! first call    with restart: %z1d defined in iom_delay_rst
445         !                                       --------------------------
446         IF ( SIZE(todelay(idvar)%z1d) /= isz ) THEN                  ! Check dimension coherence
447            IF(lwp) WRITE(numout,*) ' WARNING: the nb of delayed variables in restart file is not the model one'
448            DEALLOCATE(todelay(idvar)%z1d)
449            ndelayid(idvar) = -1                                      ! do as if we had no restart
450         END IF
451      ENDIF
[13]452
[10425]453      IF( ndelayid(idvar) == -1 ) THEN         ! first call without restart: define %z1d from p_in with a blocking allreduce
454         !                                       --------------------------
455         ALLOCATE(todelay(idvar)%z1d(isz))
456         CALL mpi_allreduce( p_in(:), todelay(idvar)%z1d(:), isz, MPI_DOUBLE_PRECISION, mpi_max, ilocalcomm, ierr )   ! get %z1d
457      ENDIF
[3]458
[10425]459      IF( ndelayid(idvar) > 0 )   CALL mpp_delay_rcv( idvar )         ! make sure %z1d is received
[3]460
[10425]461      ! send back pout from todelay(idvar)%z1d defined at previous call
462      pout(:) = todelay(idvar)%z1d(:)
[13]463
[10425]464      ! send p_in into todelay(idvar)%z1d with a non-blocking communication
[11536]465# if defined key_mpi2
[10526]466      IF( ln_timing ) CALL tic_tac( .TRUE., ld_global = .TRUE.)
467      CALL  mpi_allreduce( p_in(:), todelay(idvar)%z1d(:), isz, MPI_DOUBLE_PRECISION, mpi_max, ilocalcomm, ndelayid(idvar), ierr )
468      IF( ln_timing ) CALL tic_tac(.FALSE., ld_global = .TRUE.)
[11536]469# else
470      CALL mpi_iallreduce( p_in(:), todelay(idvar)%z1d(:), isz, MPI_DOUBLE_PRECISION, mpi_max, ilocalcomm, ndelayid(idvar), ierr )
471# endif
[10526]472#else
[11536]473      pout(:) = p_in(:)
[10526]474#endif
[10425]475
476   END SUBROUTINE mpp_delay_max
477
478   
479   SUBROUTINE mpp_delay_rcv( kid )
480      !!----------------------------------------------------------------------
481      !!                   ***  routine mpp_delay_rcv  ***
[1344]482      !!
[10425]483      !! ** Purpose :  force barrier for delayed mpp (needed for restart)
[1344]484      !!
[10425]485      !!----------------------------------------------------------------------
486      INTEGER,INTENT(in   )      ::  kid 
487      INTEGER ::   ierr
488      !!----------------------------------------------------------------------
[11536]489#if defined key_mpp_mpi
[10425]490      IF( ndelayid(kid) /= -2 ) THEN 
[10526]491#if ! defined key_mpi2
[10425]492         IF( ln_timing ) CALL tic_tac( .TRUE., ld_global = .TRUE.)
493         CALL mpi_wait( ndelayid(kid), MPI_STATUS_IGNORE, ierr )                        ! make sure todelay(kid) is received
494         IF( ln_timing ) CALL tic_tac(.FALSE., ld_global = .TRUE.)
[10526]495#endif
[10425]496         IF( ASSOCIATED(todelay(kid)%y1d) )   todelay(kid)%z1d(:) = REAL(todelay(kid)%y1d(:), wp)  ! define %z1d from %y1d
497         ndelayid(kid) = -2   ! add flag to know that mpi_wait was already called on kid
498      ENDIF
[11536]499#endif
[10425]500   END SUBROUTINE mpp_delay_rcv
[3]501
[10425]502   
503   !!----------------------------------------------------------------------
504   !!    ***  mppmax_a_int, mppmax_int, mppmax_a_real, mppmax_real  ***
505   !!   
506   !!----------------------------------------------------------------------
507   !!
508#  define OPERATION_MAX
509#  define INTEGER_TYPE
510#  define DIM_0d
511#     define ROUTINE_ALLREDUCE           mppmax_int
512#     include "mpp_allreduce_generic.h90"
513#     undef ROUTINE_ALLREDUCE
514#  undef DIM_0d
515#  define DIM_1d
516#     define ROUTINE_ALLREDUCE           mppmax_a_int
517#     include "mpp_allreduce_generic.h90"
518#     undef ROUTINE_ALLREDUCE
519#  undef DIM_1d
520#  undef INTEGER_TYPE
521!
522#  define REAL_TYPE
523#  define DIM_0d
524#     define ROUTINE_ALLREDUCE           mppmax_real
525#     include "mpp_allreduce_generic.h90"
526#     undef ROUTINE_ALLREDUCE
527#  undef DIM_0d
528#  define DIM_1d
529#     define ROUTINE_ALLREDUCE           mppmax_a_real
530#     include "mpp_allreduce_generic.h90"
531#     undef ROUTINE_ALLREDUCE
532#  undef DIM_1d
533#  undef REAL_TYPE
534#  undef OPERATION_MAX
535   !!----------------------------------------------------------------------
536   !!    ***  mppmin_a_int, mppmin_int, mppmin_a_real, mppmin_real  ***
537   !!   
538   !!----------------------------------------------------------------------
539   !!
540#  define OPERATION_MIN
541#  define INTEGER_TYPE
542#  define DIM_0d
543#     define ROUTINE_ALLREDUCE           mppmin_int
544#     include "mpp_allreduce_generic.h90"
545#     undef ROUTINE_ALLREDUCE
546#  undef DIM_0d
547#  define DIM_1d
548#     define ROUTINE_ALLREDUCE           mppmin_a_int
549#     include "mpp_allreduce_generic.h90"
550#     undef ROUTINE_ALLREDUCE
551#  undef DIM_1d
552#  undef INTEGER_TYPE
553!
554#  define REAL_TYPE
555#  define DIM_0d
556#     define ROUTINE_ALLREDUCE           mppmin_real
557#     include "mpp_allreduce_generic.h90"
558#     undef ROUTINE_ALLREDUCE
559#  undef DIM_0d
560#  define DIM_1d
561#     define ROUTINE_ALLREDUCE           mppmin_a_real
562#     include "mpp_allreduce_generic.h90"
563#     undef ROUTINE_ALLREDUCE
564#  undef DIM_1d
565#  undef REAL_TYPE
566#  undef OPERATION_MIN
[869]567
[10425]568   !!----------------------------------------------------------------------
569   !!    ***  mppsum_a_int, mppsum_int, mppsum_a_real, mppsum_real  ***
570   !!   
571   !!   Global sum of 1D array or a variable (integer, real or complex)
572   !!----------------------------------------------------------------------
573   !!
574#  define OPERATION_SUM
575#  define INTEGER_TYPE
576#  define DIM_0d
577#     define ROUTINE_ALLREDUCE           mppsum_int
578#     include "mpp_allreduce_generic.h90"
579#     undef ROUTINE_ALLREDUCE
580#  undef DIM_0d
581#  define DIM_1d
582#     define ROUTINE_ALLREDUCE           mppsum_a_int
583#     include "mpp_allreduce_generic.h90"
584#     undef ROUTINE_ALLREDUCE
585#  undef DIM_1d
586#  undef INTEGER_TYPE
587!
588#  define REAL_TYPE
589#  define DIM_0d
590#     define ROUTINE_ALLREDUCE           mppsum_real
591#     include "mpp_allreduce_generic.h90"
592#     undef ROUTINE_ALLREDUCE
593#  undef DIM_0d
594#  define DIM_1d
595#     define ROUTINE_ALLREDUCE           mppsum_a_real
596#     include "mpp_allreduce_generic.h90"
597#     undef ROUTINE_ALLREDUCE
598#  undef DIM_1d
599#  undef REAL_TYPE
600#  undef OPERATION_SUM
601
602#  define OPERATION_SUM_DD
603#  define COMPLEX_TYPE
604#  define DIM_0d
605#     define ROUTINE_ALLREDUCE           mppsum_realdd
606#     include "mpp_allreduce_generic.h90"
607#     undef ROUTINE_ALLREDUCE
608#  undef DIM_0d
609#  define DIM_1d
610#     define ROUTINE_ALLREDUCE           mppsum_a_realdd
611#     include "mpp_allreduce_generic.h90"
612#     undef ROUTINE_ALLREDUCE
613#  undef DIM_1d
614#  undef COMPLEX_TYPE
615#  undef OPERATION_SUM_DD
616
617   !!----------------------------------------------------------------------
618   !!    ***  mpp_minloc2d, mpp_minloc3d, mpp_maxloc2d, mpp_maxloc3d
619   !!   
620   !!----------------------------------------------------------------------
621   !!
622#  define OPERATION_MINLOC
623#  define DIM_2d
624#     define ROUTINE_LOC           mpp_minloc2d
625#     include "mpp_loc_generic.h90"
626#     undef ROUTINE_LOC
627#  undef DIM_2d
628#  define DIM_3d
629#     define ROUTINE_LOC           mpp_minloc3d
630#     include "mpp_loc_generic.h90"
631#     undef ROUTINE_LOC
632#  undef DIM_3d
633#  undef OPERATION_MINLOC
634
635#  define OPERATION_MAXLOC
636#  define DIM_2d
637#     define ROUTINE_LOC           mpp_maxloc2d
638#     include "mpp_loc_generic.h90"
639#     undef ROUTINE_LOC
640#  undef DIM_2d
641#  define DIM_3d
642#     define ROUTINE_LOC           mpp_maxloc3d
643#     include "mpp_loc_generic.h90"
644#     undef ROUTINE_LOC
645#  undef DIM_3d
646#  undef OPERATION_MAXLOC
647
[1344]648   SUBROUTINE mppsync()
649      !!----------------------------------------------------------------------
650      !!                  ***  routine mppsync  ***
[3764]651      !!
[1344]652      !! ** Purpose :   Massively parallel processors, synchroneous
653      !!
654      !!-----------------------------------------------------------------------
655      INTEGER :: ierror
656      !!-----------------------------------------------------------------------
657      !
[11536]658#if defined key_mpp_mpi
[9570]659      CALL mpi_barrier( mpi_comm_oce, ierror )
[11536]660#endif
[1344]661      !
662   END SUBROUTINE mppsync
[3]663
664
[11536]665   SUBROUTINE mppstop( ld_abort ) 
[1344]666      !!----------------------------------------------------------------------
667      !!                  ***  routine mppstop  ***
[3764]668      !!
[3294]669      !! ** purpose :   Stop massively parallel processors method
[1344]670      !!
671      !!----------------------------------------------------------------------
[11536]672      LOGICAL, OPTIONAL, INTENT(in) :: ld_abort    ! source process number
673      LOGICAL ::   ll_abort
[1344]674      INTEGER ::   info
675      !!----------------------------------------------------------------------
[11536]676      ll_abort = .FALSE.
677      IF( PRESENT(ld_abort) ) ll_abort = ld_abort
[1344]678      !
[11536]679#if defined key_mpp_mpi
680      IF(ll_abort) THEN
[10425]681         CALL mpi_abort( MPI_COMM_WORLD )
682      ELSE
683         CALL mppsync
684         CALL mpi_finalize( info )
685      ENDIF
[11536]686#endif
687      IF( ll_abort ) STOP 123
[1344]688      !
689   END SUBROUTINE mppstop
[3]690
691
[1344]692   SUBROUTINE mpp_comm_free( kcom )
693      !!----------------------------------------------------------------------
694      INTEGER, INTENT(in) ::   kcom
695      !!
696      INTEGER :: ierr
697      !!----------------------------------------------------------------------
698      !
[11536]699#if defined key_mpp_mpi
[1344]700      CALL MPI_COMM_FREE(kcom, ierr)
[11536]701#endif
[1344]702      !
703   END SUBROUTINE mpp_comm_free
[3]704
[869]705
[2715]706   SUBROUTINE mpp_ini_znl( kumout )
[1345]707      !!----------------------------------------------------------------------
708      !!               ***  routine mpp_ini_znl  ***
709      !!
710      !! ** Purpose :   Initialize special communicator for computing zonal sum
711      !!
712      !! ** Method  : - Look for processors in the same row
713      !!              - Put their number in nrank_znl
714      !!              - Create group for the znl processors
715      !!              - Create a communicator for znl processors
716      !!              - Determine if processor should write znl files
717      !!
718      !! ** output
719      !!      ndim_rank_znl = number of processors on the same row
720      !!      ngrp_znl = group ID for the znl processors
721      !!      ncomm_znl = communicator for the ice procs.
722      !!      n_znl_root = number (in the world) of proc 0 in the ice comm.
723      !!
724      !!----------------------------------------------------------------------
[2715]725      INTEGER, INTENT(in) ::   kumout   ! ocean.output logical units
[1345]726      !
[2715]727      INTEGER :: jproc      ! dummy loop integer
728      INTEGER :: ierr, ii   ! local integer
729      INTEGER, ALLOCATABLE, DIMENSION(:) ::   kwork
730      !!----------------------------------------------------------------------
[11536]731#if defined key_mpp_mpi
[1345]732      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_world     : ', ngrp_world
733      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - mpi_comm_world : ', mpi_comm_world
[9570]734      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - mpi_comm_oce   : ', mpi_comm_oce
[1345]735      !
[2715]736      ALLOCATE( kwork(jpnij), STAT=ierr )
[11536]737      IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'mpp_ini_znl : failed to allocate 1D array of length jpnij')
[2715]738
739      IF( jpnj == 1 ) THEN
[1345]740         ngrp_znl  = ngrp_world
[9570]741         ncomm_znl = mpi_comm_oce
[1345]742      ELSE
743         !
[9570]744         CALL MPI_ALLGATHER ( njmpp, 1, mpi_integer, kwork, 1, mpi_integer, mpi_comm_oce, ierr )
[1345]745         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - kwork pour njmpp : ', kwork
746         !-$$        CALL flush(numout)
747         !
748         ! Count number of processors on the same row
749         ndim_rank_znl = 0
750         DO jproc=1,jpnij
751            IF ( kwork(jproc) == njmpp ) THEN
752               ndim_rank_znl = ndim_rank_znl + 1
753            ENDIF
754         END DO
755         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ndim_rank_znl : ', ndim_rank_znl
756         !-$$        CALL flush(numout)
757         ! Allocate the right size to nrank_znl
[1441]758         IF (ALLOCATED (nrank_znl)) DEALLOCATE(nrank_znl)
[1345]759         ALLOCATE(nrank_znl(ndim_rank_znl))
[3764]760         ii = 0
[1345]761         nrank_znl (:) = 0
762         DO jproc=1,jpnij
763            IF ( kwork(jproc) == njmpp) THEN
764               ii = ii + 1
[3764]765               nrank_znl(ii) = jproc -1
[1345]766            ENDIF
767         END DO
768         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - nrank_znl : ', nrank_znl
769         !-$$        CALL flush(numout)
770
771         ! Create the opa group
[9570]772         CALL MPI_COMM_GROUP(mpi_comm_oce,ngrp_opa,ierr)
[1345]773         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_opa : ', ngrp_opa
774         !-$$        CALL flush(numout)
775
776         ! Create the znl group from the opa group
777         CALL MPI_GROUP_INCL  ( ngrp_opa, ndim_rank_znl, nrank_znl, ngrp_znl, ierr )
778         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_znl ', ngrp_znl
779         !-$$        CALL flush(numout)
780
781         ! Create the znl communicator from the opa communicator, ie the pool of procs in the same row
[9570]782         CALL MPI_COMM_CREATE ( mpi_comm_oce, ngrp_znl, ncomm_znl, ierr )
[1345]783         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ncomm_znl ', ncomm_znl
784         !-$$        CALL flush(numout)
785         !
786      END IF
787
788      ! Determines if processor if the first (starting from i=1) on the row
[3764]789      IF ( jpni == 1 ) THEN
[1345]790         l_znl_root = .TRUE.
791      ELSE
792         l_znl_root = .FALSE.
793         kwork (1) = nimpp
[10425]794         CALL mpp_min ( 'lib_mpp', kwork(1), kcom = ncomm_znl)
[1345]795         IF ( nimpp == kwork(1)) l_znl_root = .TRUE.
796      END IF
797
[2715]798      DEALLOCATE(kwork)
[11536]799#endif
[2715]800
[1345]801   END SUBROUTINE mpp_ini_znl
802
803
[1344]804   SUBROUTINE mpp_ini_north
805      !!----------------------------------------------------------------------
806      !!               ***  routine mpp_ini_north  ***
807      !!
[3764]808      !! ** Purpose :   Initialize special communicator for north folding
[1344]809      !!      condition together with global variables needed in the mpp folding
810      !!
811      !! ** Method  : - Look for northern processors
812      !!              - Put their number in nrank_north
813      !!              - Create groups for the world processors and the north processors
814      !!              - Create a communicator for northern processors
815      !!
816      !! ** output
817      !!      njmppmax = njmpp for northern procs
818      !!      ndim_rank_north = number of processors in the northern line
819      !!      nrank_north (ndim_rank_north) = number  of the northern procs.
820      !!      ngrp_world = group ID for the world processors
821      !!      ngrp_north = group ID for the northern processors
822      !!      ncomm_north = communicator for the northern procs.
823      !!      north_root = number (in the world) of proc 0 in the northern comm.
824      !!
825      !!----------------------------------------------------------------------
826      INTEGER ::   ierr
827      INTEGER ::   jjproc
828      INTEGER ::   ii, ji
829      !!----------------------------------------------------------------------
830      !
[11536]831#if defined key_mpp_mpi
[1344]832      njmppmax = MAXVAL( njmppt )
833      !
834      ! Look for how many procs on the northern boundary
835      ndim_rank_north = 0
836      DO jjproc = 1, jpnij
837         IF( njmppt(jjproc) == njmppmax )   ndim_rank_north = ndim_rank_north + 1
838      END DO
839      !
840      ! Allocate the right size to nrank_north
[1441]841      IF (ALLOCATED (nrank_north)) DEALLOCATE(nrank_north)
[1344]842      ALLOCATE( nrank_north(ndim_rank_north) )
[869]843
[1344]844      ! Fill the nrank_north array with proc. number of northern procs.
845      ! Note : the rank start at 0 in MPI
846      ii = 0
847      DO ji = 1, jpnij
848         IF ( njmppt(ji) == njmppmax   ) THEN
849            ii=ii+1
850            nrank_north(ii)=ji-1
851         END IF
852      END DO
853      !
854      ! create the world group
[9570]855      CALL MPI_COMM_GROUP( mpi_comm_oce, ngrp_world, ierr )
[1344]856      !
857      ! Create the North group from the world group
858      CALL MPI_GROUP_INCL( ngrp_world, ndim_rank_north, nrank_north, ngrp_north, ierr )
859      !
860      ! Create the North communicator , ie the pool of procs in the north group
[9570]861      CALL MPI_COMM_CREATE( mpi_comm_oce, ngrp_north, ncomm_north, ierr )
[1344]862      !
[11536]863#endif
[1344]864   END SUBROUTINE mpp_ini_north
[869]865
866
[9019]867   SUBROUTINE DDPDD_MPI( ydda, yddb, ilen, itype )
[1976]868      !!---------------------------------------------------------------------
869      !!   Routine DDPDD_MPI: used by reduction operator MPI_SUMDD
870      !!
871      !!   Modification of original codes written by David H. Bailey
872      !!   This subroutine computes yddb(i) = ydda(i)+yddb(i)
873      !!---------------------------------------------------------------------
[9019]874      INTEGER                     , INTENT(in)    ::   ilen, itype
875      COMPLEX(wp), DIMENSION(ilen), INTENT(in)    ::   ydda
876      COMPLEX(wp), DIMENSION(ilen), INTENT(inout) ::   yddb
[1976]877      !
878      REAL(wp) :: zerr, zt1, zt2    ! local work variables
[9019]879      INTEGER  :: ji, ztmp           ! local scalar
880      !!---------------------------------------------------------------------
881      !
[1976]882      ztmp = itype   ! avoid compilation warning
[9019]883      !
[1976]884      DO ji=1,ilen
885      ! Compute ydda + yddb using Knuth's trick.
886         zt1  = real(ydda(ji)) + real(yddb(ji))
887         zerr = zt1 - real(ydda(ji))
888         zt2  = ((real(yddb(ji)) - zerr) + (real(ydda(ji)) - (zt1 - zerr))) &
889                + aimag(ydda(ji)) + aimag(yddb(ji))
890
891         ! The result is zt1 + zt2, after normalization.
892         yddb(ji) = cmplx ( zt1 + zt2, zt2 - ((zt1 + zt2) - zt1),wp )
893      END DO
[9019]894      !
[1976]895   END SUBROUTINE DDPDD_MPI
896
[6140]897
[10437]898   SUBROUTINE mpp_report( cdname, kpk, kpl, kpf, ld_lbc, ld_glb, ld_dlg )
[10425]899      !!----------------------------------------------------------------------
900      !!                  ***  routine mpp_report  ***
901      !!
902      !! ** Purpose :   report use of mpp routines per time-setp
903      !!
904      !!----------------------------------------------------------------------
905      CHARACTER(len=*),           INTENT(in   ) ::   cdname      ! name of the calling subroutine
906      INTEGER         , OPTIONAL, INTENT(in   ) ::   kpk, kpl, kpf
[10437]907      LOGICAL         , OPTIONAL, INTENT(in   ) ::   ld_lbc, ld_glb, ld_dlg
[10425]908      !!
[10982]909      CHARACTER(len=128)                        ::   ccountname  ! name of a subroutine to count communications
[10437]910      LOGICAL ::   ll_lbc, ll_glb, ll_dlg
[10982]911      INTEGER ::    ji,  jj,  jk,  jh, jf, jcount   ! dummy loop indices
[10425]912      !!----------------------------------------------------------------------
[11536]913#if defined key_mpp_mpi
[10425]914      !
915      ll_lbc = .FALSE.
916      IF( PRESENT(ld_lbc) ) ll_lbc = ld_lbc
917      ll_glb = .FALSE.
918      IF( PRESENT(ld_glb) ) ll_glb = ld_glb
[10437]919      ll_dlg = .FALSE.
920      IF( PRESENT(ld_dlg) ) ll_dlg = ld_dlg
[10425]921      !
922      ! find the smallest common frequency: default = frequency product, if multiple, choose the larger of the 2 frequency
923      IF( ncom_dttrc /= 1 )   CALL ctl_stop( 'STOP', 'mpp_report, ncom_dttrc /= 1 not coded...' ) 
924      ncom_freq = ncom_fsbc
925      !
926      IF ( ncom_stp == nit000+ncom_freq ) THEN   ! avoid to count extra communications in potential initializations at nit000
927         IF( ll_lbc ) THEN
928            IF( .NOT. ALLOCATED(ncomm_sequence) ) ALLOCATE( ncomm_sequence(ncom_rec_max,2) )
929            IF( .NOT. ALLOCATED(    crname_lbc) ) ALLOCATE(     crname_lbc(ncom_rec_max  ) )
930            n_sequence_lbc = n_sequence_lbc + 1
931            IF( n_sequence_lbc > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
932            crname_lbc(n_sequence_lbc) = cdname     ! keep the name of the calling routine
933            ncomm_sequence(n_sequence_lbc,1) = kpk*kpl   ! size of 3rd and 4th dimensions
934            ncomm_sequence(n_sequence_lbc,2) = kpf       ! number of arrays to be treated (multi)
935         ENDIF
936         IF( ll_glb ) THEN
937            IF( .NOT. ALLOCATED(crname_glb) ) ALLOCATE( crname_glb(ncom_rec_max) )
938            n_sequence_glb = n_sequence_glb + 1
939            IF( n_sequence_glb > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
940            crname_glb(n_sequence_glb) = cdname     ! keep the name of the calling routine
941         ENDIF
[10437]942         IF( ll_dlg ) THEN
943            IF( .NOT. ALLOCATED(crname_dlg) ) ALLOCATE( crname_dlg(ncom_rec_max) )
944            n_sequence_dlg = n_sequence_dlg + 1
945            IF( n_sequence_dlg > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
946            crname_dlg(n_sequence_dlg) = cdname     ! keep the name of the calling routine
947         ENDIF
[10425]948      ELSE IF ( ncom_stp == nit000+2*ncom_freq ) THEN
949         CALL ctl_opn( numcom, 'communication_report.txt', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., narea )
950         WRITE(numcom,*) ' '
951         WRITE(numcom,*) ' ------------------------------------------------------------'
952         WRITE(numcom,*) ' Communication pattern report (second oce+sbc+top time step):'
953         WRITE(numcom,*) ' ------------------------------------------------------------'
954         WRITE(numcom,*) ' '
955         WRITE(numcom,'(A,I4)') ' Exchanged halos : ', n_sequence_lbc
956         jj = 0; jk = 0; jf = 0; jh = 0
957         DO ji = 1, n_sequence_lbc
958            IF ( ncomm_sequence(ji,1) .GT. 1 ) jk = jk + 1
959            IF ( ncomm_sequence(ji,2) .GT. 1 ) jf = jf + 1
960            IF ( ncomm_sequence(ji,1) .GT. 1 .AND. ncomm_sequence(ji,2) .GT. 1 ) jj = jj + 1
961            jh = MAX (jh, ncomm_sequence(ji,1)*ncomm_sequence(ji,2))
962         END DO
963         WRITE(numcom,'(A,I3)') ' 3D Exchanged halos : ', jk
964         WRITE(numcom,'(A,I3)') ' Multi arrays exchanged halos : ', jf
965         WRITE(numcom,'(A,I3)') '   from which 3D : ', jj
966         WRITE(numcom,'(A,I10)') ' Array max size : ', jh*jpi*jpj
967         WRITE(numcom,*) ' '
968         WRITE(numcom,*) ' lbc_lnk called'
[10982]969         DO ji = 1, n_sequence_lbc - 1
970            IF ( crname_lbc(ji) /= 'already counted' ) THEN
971               ccountname = crname_lbc(ji)
972               crname_lbc(ji) = 'already counted'
973               jcount = 1
974               DO jj = ji + 1, n_sequence_lbc
975                  IF ( ccountname ==  crname_lbc(jj) ) THEN
976                     jcount = jcount + 1
977                     crname_lbc(jj) = 'already counted'
978                  END IF
979               END DO
980               WRITE(numcom,'(A, I4, A, A)') ' - ', jcount,' times by subroutine ', TRIM(ccountname)
[10425]981            END IF
982         END DO
[10982]983         IF ( crname_lbc(n_sequence_lbc) /= 'already counted' ) THEN
984            WRITE(numcom,'(A, I4, A, A)') ' - ', 1,' times by subroutine ', TRIM(crname_lbc(ncom_rec_max))
985         END IF
[10425]986         WRITE(numcom,*) ' '
987         IF ( n_sequence_glb > 0 ) THEN
988            WRITE(numcom,'(A,I4)') ' Global communications : ', n_sequence_glb
989            jj = 1
990            DO ji = 2, n_sequence_glb
991               IF( crname_glb(ji-1) /= crname_glb(ji) ) THEN
992                  WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_glb(ji-1))
993                  jj = 0
994               END IF
995               jj = jj + 1 
996            END DO
997            WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_glb(n_sequence_glb))
998            DEALLOCATE(crname_glb)
999         ELSE
1000            WRITE(numcom,*) ' No MPI global communication '
1001         ENDIF
1002         WRITE(numcom,*) ' '
[10437]1003         IF ( n_sequence_dlg > 0 ) THEN
1004            WRITE(numcom,'(A,I4)') ' Delayed global communications : ', n_sequence_dlg
1005            jj = 1
1006            DO ji = 2, n_sequence_dlg
1007               IF( crname_dlg(ji-1) /= crname_dlg(ji) ) THEN
1008                  WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_dlg(ji-1))
1009                  jj = 0
1010               END IF
1011               jj = jj + 1 
1012            END DO
1013            WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_dlg(n_sequence_dlg))
1014            DEALLOCATE(crname_dlg)
1015         ELSE
1016            WRITE(numcom,*) ' No MPI delayed global communication '
1017         ENDIF
1018         WRITE(numcom,*) ' '
[10425]1019         WRITE(numcom,*) ' -----------------------------------------------'
1020         WRITE(numcom,*) ' '
1021         DEALLOCATE(ncomm_sequence)
1022         DEALLOCATE(crname_lbc)
1023      ENDIF
[11536]1024#endif
[10425]1025   END SUBROUTINE mpp_report
1026
[6140]1027   
[10425]1028   SUBROUTINE tic_tac (ld_tic, ld_global)
1029
1030    LOGICAL,           INTENT(IN) :: ld_tic
1031    LOGICAL, OPTIONAL, INTENT(IN) :: ld_global
1032    REAL(wp), DIMENSION(2), SAVE :: tic_wt
1033    REAL(wp),               SAVE :: tic_ct = 0._wp
1034    INTEGER :: ii
[11536]1035#if defined key_mpp_mpi
[10425]1036
1037    IF( ncom_stp <= nit000 ) RETURN
1038    IF( ncom_stp == nitend ) RETURN
1039    ii = 1
1040    IF( PRESENT( ld_global ) ) THEN
1041       IF( ld_global ) ii = 2
1042    END IF
1043   
1044    IF ( ld_tic ) THEN
1045       tic_wt(ii) = MPI_Wtime()                                                    ! start count tic->tac (waiting time)
1046       IF ( tic_ct > 0.0_wp ) compute_time = compute_time + MPI_Wtime() - tic_ct   ! cumulate count tac->tic
1047    ELSE
1048       waiting_time(ii) = waiting_time(ii) + MPI_Wtime() - tic_wt(ii)              ! cumulate count tic->tac
1049       tic_ct = MPI_Wtime()                                                        ! start count tac->tic (waiting time)
1050    ENDIF
[11536]1051#endif
[10425]1052   
1053   END SUBROUTINE tic_tac
1054
[11536]1055#if ! defined key_mpp_mpi
1056   SUBROUTINE mpi_wait(request, status, ierror)
1057      INTEGER                            , INTENT(in   ) ::   request
1058      INTEGER, DIMENSION(MPI_STATUS_SIZE), INTENT(  out) ::   status
1059      INTEGER                            , INTENT(  out) ::   ierror
1060   END SUBROUTINE mpi_wait
[1976]1061
[10425]1062   
[11536]1063   FUNCTION MPI_Wtime()
1064      REAL(wp) ::  MPI_Wtime
1065      MPI_Wtime = -1.
1066   END FUNCTION MPI_Wtime
[3]1067#endif
[2715]1068
[13]1069   !!----------------------------------------------------------------------
[11536]1070   !!   ctl_stop, ctl_warn, get_unit, ctl_opn, ctl_nam   routines
[2715]1071   !!----------------------------------------------------------------------
1072
1073   SUBROUTINE ctl_stop( cd1, cd2, cd3, cd4, cd5 ,   &
1074      &                 cd6, cd7, cd8, cd9, cd10 )
1075      !!----------------------------------------------------------------------
1076      !!                  ***  ROUTINE  stop_opa  ***
1077      !!
[3764]1078      !! ** Purpose :   print in ocean.outpput file a error message and
[2715]1079      !!                increment the error number (nstop) by one.
1080      !!----------------------------------------------------------------------
[11536]1081      CHARACTER(len=*), INTENT(in   )           ::   cd1
1082      CHARACTER(len=*), INTENT(in   ), OPTIONAL ::        cd2, cd3, cd4, cd5
1083      CHARACTER(len=*), INTENT(in   ), OPTIONAL ::   cd6, cd7, cd8, cd9, cd10
[2715]1084      !!----------------------------------------------------------------------
1085      !
[3764]1086      nstop = nstop + 1
[11536]1087      !
1088      ! force to open ocean.output file if not already opened
[10425]1089      IF( numout == 6 ) CALL ctl_opn( numout, 'ocean.output', 'APPEND', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[11536]1090      !
1091                            WRITE(numout,*)
1092                            WRITE(numout,*) ' ===>>> : E R R O R'
1093                            WRITE(numout,*)
1094                            WRITE(numout,*) '         ==========='
1095                            WRITE(numout,*)
1096                            WRITE(numout,*) TRIM(cd1)
[10425]1097      IF( PRESENT(cd2 ) )   WRITE(numout,*) TRIM(cd2)
1098      IF( PRESENT(cd3 ) )   WRITE(numout,*) TRIM(cd3)
1099      IF( PRESENT(cd4 ) )   WRITE(numout,*) TRIM(cd4)
1100      IF( PRESENT(cd5 ) )   WRITE(numout,*) TRIM(cd5)
1101      IF( PRESENT(cd6 ) )   WRITE(numout,*) TRIM(cd6)
1102      IF( PRESENT(cd7 ) )   WRITE(numout,*) TRIM(cd7)
1103      IF( PRESENT(cd8 ) )   WRITE(numout,*) TRIM(cd8)
1104      IF( PRESENT(cd9 ) )   WRITE(numout,*) TRIM(cd9)
1105      IF( PRESENT(cd10) )   WRITE(numout,*) TRIM(cd10)
[11536]1106                            WRITE(numout,*)
1107      !
[2715]1108                               CALL FLUSH(numout    )
1109      IF( numstp     /= -1 )   CALL FLUSH(numstp    )
[9019]1110      IF( numrun     /= -1 )   CALL FLUSH(numrun    )
[2715]1111      IF( numevo_ice /= -1 )   CALL FLUSH(numevo_ice)
1112      !
1113      IF( cd1 == 'STOP' ) THEN
[11536]1114         WRITE(numout,*) 
[10425]1115         WRITE(numout,*)  'huge E-R-R-O-R : immediate stop'
[11536]1116         WRITE(numout,*) 
1117         CALL mppstop( ld_abort = .true. )
[2715]1118      ENDIF
1119      !
1120   END SUBROUTINE ctl_stop
1121
1122
1123   SUBROUTINE ctl_warn( cd1, cd2, cd3, cd4, cd5,   &
1124      &                 cd6, cd7, cd8, cd9, cd10 )
1125      !!----------------------------------------------------------------------
1126      !!                  ***  ROUTINE  stop_warn  ***
1127      !!
[3764]1128      !! ** Purpose :   print in ocean.outpput file a error message and
[2715]1129      !!                increment the warning number (nwarn) by one.
1130      !!----------------------------------------------------------------------
1131      CHARACTER(len=*), INTENT(in), OPTIONAL ::  cd1, cd2, cd3, cd4, cd5
1132      CHARACTER(len=*), INTENT(in), OPTIONAL ::  cd6, cd7, cd8, cd9, cd10
1133      !!----------------------------------------------------------------------
[3764]1134      !
1135      nwarn = nwarn + 1
[11536]1136      !
[2715]1137      IF(lwp) THEN
[11536]1138                               WRITE(numout,*)
1139                               WRITE(numout,*) ' ===>>> : W A R N I N G'
1140                               WRITE(numout,*)
1141                               WRITE(numout,*) '         ==============='
1142                               WRITE(numout,*)
1143         IF( PRESENT(cd1 ) )   WRITE(numout,*) TRIM(cd1)
1144         IF( PRESENT(cd2 ) )   WRITE(numout,*) TRIM(cd2)
1145         IF( PRESENT(cd3 ) )   WRITE(numout,*) TRIM(cd3)
1146         IF( PRESENT(cd4 ) )   WRITE(numout,*) TRIM(cd4)
1147         IF( PRESENT(cd5 ) )   WRITE(numout,*) TRIM(cd5)
1148         IF( PRESENT(cd6 ) )   WRITE(numout,*) TRIM(cd6)
1149         IF( PRESENT(cd7 ) )   WRITE(numout,*) TRIM(cd7)
1150         IF( PRESENT(cd8 ) )   WRITE(numout,*) TRIM(cd8)
1151         IF( PRESENT(cd9 ) )   WRITE(numout,*) TRIM(cd9)
1152         IF( PRESENT(cd10) )   WRITE(numout,*) TRIM(cd10)
1153                               WRITE(numout,*)
[2715]1154      ENDIF
1155      CALL FLUSH(numout)
1156      !
1157   END SUBROUTINE ctl_warn
1158
1159
1160   SUBROUTINE ctl_opn( knum, cdfile, cdstat, cdform, cdacce, klengh, kout, ldwp, karea )
1161      !!----------------------------------------------------------------------
1162      !!                  ***  ROUTINE ctl_opn  ***
1163      !!
1164      !! ** Purpose :   Open file and check if required file is available.
1165      !!
1166      !! ** Method  :   Fortan open
1167      !!----------------------------------------------------------------------
1168      INTEGER          , INTENT(  out) ::   knum      ! logical unit to open
1169      CHARACTER(len=*) , INTENT(in   ) ::   cdfile    ! file name to open
1170      CHARACTER(len=*) , INTENT(in   ) ::   cdstat    ! disposition specifier
1171      CHARACTER(len=*) , INTENT(in   ) ::   cdform    ! formatting specifier
1172      CHARACTER(len=*) , INTENT(in   ) ::   cdacce    ! access specifier
1173      INTEGER          , INTENT(in   ) ::   klengh    ! record length
1174      INTEGER          , INTENT(in   ) ::   kout      ! number of logical units for write
1175      LOGICAL          , INTENT(in   ) ::   ldwp      ! boolean term for print
1176      INTEGER, OPTIONAL, INTENT(in   ) ::   karea     ! proc number
[5836]1177      !
[2715]1178      CHARACTER(len=80) ::   clfile
1179      INTEGER           ::   iost
1180      !!----------------------------------------------------------------------
[5836]1181      !
[2715]1182      ! adapt filename
1183      ! ----------------
1184      clfile = TRIM(cdfile)
1185      IF( PRESENT( karea ) ) THEN
1186         IF( karea > 1 )   WRITE(clfile, "(a,'_',i4.4)") TRIM(clfile), karea-1
1187      ENDIF
1188#if defined key_agrif
1189      IF( .NOT. Agrif_Root() )   clfile = TRIM(Agrif_CFixed())//'_'//TRIM(clfile)
1190      knum=Agrif_Get_Unit()
1191#else
1192      knum=get_unit()
1193#endif
[10425]1194      IF( TRIM(cdfile) == '/dev/null' )   clfile = TRIM(cdfile)   ! force the use of /dev/null
[5836]1195      !
[11536]1196      IF(       cdacce(1:6) == 'DIRECT' )  THEN   ! cdacce has always more than 6 characters
[10425]1197         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS=cdstat, RECL=klengh         , ERR=100, IOSTAT=iost )
1198      ELSE IF( TRIM(cdstat) == 'APPEND' )  THEN   ! cdstat can have less than 6 characters
1199         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS='UNKNOWN', POSITION='APPEND', ERR=100, IOSTAT=iost )
[2715]1200      ELSE
[10425]1201         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS=cdstat                      , ERR=100, IOSTAT=iost )
[2715]1202      ENDIF
[10425]1203      IF( iost /= 0 .AND. TRIM(clfile) == '/dev/null' ) &   ! for windows
1204         &  OPEN(UNIT=knum,FILE='NUL', FORM=cdform, ACCESS=cdacce, STATUS=cdstat                      , ERR=100, IOSTAT=iost )   
[2715]1205      IF( iost == 0 ) THEN
1206         IF(ldwp) THEN
[10425]1207            WRITE(kout,*) '     file   : ', TRIM(clfile),' open ok'
[2715]1208            WRITE(kout,*) '     unit   = ', knum
1209            WRITE(kout,*) '     status = ', cdstat
1210            WRITE(kout,*) '     form   = ', cdform
1211            WRITE(kout,*) '     access = ', cdacce
1212            WRITE(kout,*)
1213         ENDIF
1214      ENDIF
1215100   CONTINUE
1216      IF( iost /= 0 ) THEN
[11536]1217         WRITE(ctmp1,*) ' ===>>>> : bad opening file: ', TRIM(clfile)
1218         WRITE(ctmp2,*) ' =======   ===  '
1219         WRITE(ctmp3,*) '           unit   = ', knum
1220         WRITE(ctmp4,*) '           status = ', cdstat
1221         WRITE(ctmp5,*) '           form   = ', cdform
1222         WRITE(ctmp6,*) '           access = ', cdacce
1223         WRITE(ctmp7,*) '           iostat = ', iost
1224         WRITE(ctmp8,*) '           we stop. verify the file '
1225         CALL ctl_stop( 'STOP', ctmp1, ctmp2, ctmp3, ctmp4, ctmp5, ctmp6, ctmp7, ctmp8 )
[2715]1226      ENDIF
[5836]1227      !
[2715]1228   END SUBROUTINE ctl_opn
1229
[5836]1230
[11536]1231   SUBROUTINE ctl_nam ( kios, cdnam )
[4147]1232      !!----------------------------------------------------------------------
1233      !!                  ***  ROUTINE ctl_nam  ***
1234      !!
1235      !! ** Purpose :   Informations when error while reading a namelist
1236      !!
1237      !! ** Method  :   Fortan open
1238      !!----------------------------------------------------------------------
[11536]1239      INTEGER                                , INTENT(inout) ::   kios    ! IO status after reading the namelist
1240      CHARACTER(len=*)                       , INTENT(in   ) ::   cdnam   ! group name of namelist for which error occurs
1241      !
1242      CHARACTER(len=5) ::   clios   ! string to convert iostat in character for print
[4147]1243      !!----------------------------------------------------------------------
[5836]1244      !
[7646]1245      WRITE (clios, '(I5.0)')   kios
[4147]1246      IF( kios < 0 ) THEN         
[5836]1247         CALL ctl_warn( 'end of record or file while reading namelist '   &
1248            &           // TRIM(cdnam) // ' iostat = ' // TRIM(clios) )
[4147]1249      ENDIF
[5836]1250      !
[4147]1251      IF( kios > 0 ) THEN
[5836]1252         CALL ctl_stop( 'misspelled variable in namelist '   &
1253            &           // TRIM(cdnam) // ' iostat = ' // TRIM(clios) )
[4147]1254      ENDIF
1255      kios = 0
[5836]1256      !
[4147]1257   END SUBROUTINE ctl_nam
1258
[5836]1259
[2715]1260   INTEGER FUNCTION get_unit()
1261      !!----------------------------------------------------------------------
1262      !!                  ***  FUNCTION  get_unit  ***
1263      !!
1264      !! ** Purpose :   return the index of an unused logical unit
1265      !!----------------------------------------------------------------------
[3764]1266      LOGICAL :: llopn
[2715]1267      !!----------------------------------------------------------------------
1268      !
1269      get_unit = 15   ! choose a unit that is big enough then it is not already used in NEMO
1270      llopn = .TRUE.
1271      DO WHILE( (get_unit < 998) .AND. llopn )
1272         get_unit = get_unit + 1
1273         INQUIRE( unit = get_unit, opened = llopn )
1274      END DO
1275      IF( (get_unit == 999) .AND. llopn ) THEN
[11536]1276         CALL ctl_stop( 'STOP', 'get_unit: All logical units until 999 are used...' )
[2715]1277      ENDIF
1278      !
1279   END FUNCTION get_unit
1280
1281   !!----------------------------------------------------------------------
[3]1282END MODULE lib_mpp
Note: See TracBrowser for help on using the repository browser.