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/branches/2019/dev_r10984_HPC-13_IRRMANN_DYN_optimization/src/OCE/LBC – NEMO

source: NEMO/branches/2019/dev_r10984_HPC-13_IRRMANN_DYN_optimization/src/OCE/LBC/lib_mpp.F90 @ 11722

Last change on this file since 11722 was 11390, checked in by girrmann, 5 years ago

dev_r10984_HPC-13 : merge DYN with BDY @11389, see #2308

  • Property svn:keywords set to Id
File size: 56.4 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   !!----------------------------------------------------------------------
[11317]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   !
[11317]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
[11192]67   PUBLIC   mpp_report
68   PUBLIC   tic_tac
[11390]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   !! ========================= !!
[11192]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
[11192]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
[11192]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
[11317]179   SUBROUTINE mpp_start( localComm )
[2715]180      !!----------------------------------------------------------------------
[11317]181      !!                  ***  routine mpp_start  ***
[3764]182      !!
[11317]183      !! ** Purpose :   get mpi_comm_oce, mpprank and mppsize
[51]184      !!----------------------------------------------------------------------
[6140]185      INTEGER         , OPTIONAL   , INTENT(in   ) ::   localComm    !
[2715]186      !
[11317]187      INTEGER ::   ierr
188      LOGICAL ::   llmpi_init
[51]189      !!----------------------------------------------------------------------
[11192]190#if defined key_mpp_mpi
[1344]191      !
[11317]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
[11317]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
[11317]204       
[3764]205      IF( PRESENT(localComm) ) THEN
[2480]206         IF( Agrif_Root() ) THEN
[9570]207            mpi_comm_oce = localComm
[2480]208         ENDIF
209      ELSE
[11317]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
[11192]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
[11192]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      !
[11192]227#else
228      IF( PRESENT( localComm ) ) mpi_comm_oce = localComm
[11317]229      mppsize = 1
230      mpprank = 0
[11192]231#endif
[11317]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      !
[11192]251#if defined key_mpp_mpi
[11317]252      CALL mpi_isend( pmess, kbytes, mpi_double_precision, kdest , ktyp, mpi_comm_oce, md_req, iflag )
[11192]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      !
[11192]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 )
[11192]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
[11192]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 )
[11192]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      !
[11192]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 )
[11192]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      !!----------------------------------------------------------------------
[11192]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
[11192]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.)
[11192]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
[11192]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      !!----------------------------------------------------------------------
[11192]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
[11192]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.)
[11192]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
[11192]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      !!----------------------------------------------------------------------
[11192]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
[11192]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      !
[11192]658#if defined key_mpp_mpi
[9570]659      CALL mpi_barrier( mpi_comm_oce, ierror )
[11192]660#endif
[1344]661      !
662   END SUBROUTINE mppsync
[3]663
664
[10425]665   SUBROUTINE mppstop( ldfinal, ld_force_abort ) 
[1344]666      !!----------------------------------------------------------------------
667      !!                  ***  routine mppstop  ***
[3764]668      !!
[3294]669      !! ** purpose :   Stop massively parallel processors method
[1344]670      !!
671      !!----------------------------------------------------------------------
[10425]672      LOGICAL, OPTIONAL, INTENT(in) :: ldfinal    ! source process number
673      LOGICAL, OPTIONAL, INTENT(in) :: ld_force_abort    ! source process number
674      LOGICAL ::   llfinal, ll_force_abort
[1344]675      INTEGER ::   info
676      !!----------------------------------------------------------------------
[10425]677      llfinal = .FALSE.
678      IF( PRESENT(ldfinal) ) llfinal = ldfinal
679      ll_force_abort = .FALSE.
680      IF( PRESENT(ld_force_abort) ) ll_force_abort = ld_force_abort
[1344]681      !
[11192]682#if defined key_mpp_mpi
[10425]683      IF(ll_force_abort) THEN
684         CALL mpi_abort( MPI_COMM_WORLD )
685      ELSE
686         CALL mppsync
687         CALL mpi_finalize( info )
688      ENDIF
[11192]689#endif
[10817]690      IF( .NOT. llfinal ) STOP 123
[1344]691      !
692   END SUBROUTINE mppstop
[3]693
694
[1344]695   SUBROUTINE mpp_comm_free( kcom )
696      !!----------------------------------------------------------------------
697      INTEGER, INTENT(in) ::   kcom
698      !!
699      INTEGER :: ierr
700      !!----------------------------------------------------------------------
701      !
[11192]702#if defined key_mpp_mpi
[1344]703      CALL MPI_COMM_FREE(kcom, ierr)
[11192]704#endif
[1344]705      !
706   END SUBROUTINE mpp_comm_free
[3]707
[869]708
[2715]709   SUBROUTINE mpp_ini_znl( kumout )
[1345]710      !!----------------------------------------------------------------------
711      !!               ***  routine mpp_ini_znl  ***
712      !!
713      !! ** Purpose :   Initialize special communicator for computing zonal sum
714      !!
715      !! ** Method  : - Look for processors in the same row
716      !!              - Put their number in nrank_znl
717      !!              - Create group for the znl processors
718      !!              - Create a communicator for znl processors
719      !!              - Determine if processor should write znl files
720      !!
721      !! ** output
722      !!      ndim_rank_znl = number of processors on the same row
723      !!      ngrp_znl = group ID for the znl processors
724      !!      ncomm_znl = communicator for the ice procs.
725      !!      n_znl_root = number (in the world) of proc 0 in the ice comm.
726      !!
727      !!----------------------------------------------------------------------
[2715]728      INTEGER, INTENT(in) ::   kumout   ! ocean.output logical units
[1345]729      !
[2715]730      INTEGER :: jproc      ! dummy loop integer
731      INTEGER :: ierr, ii   ! local integer
732      INTEGER, ALLOCATABLE, DIMENSION(:) ::   kwork
733      !!----------------------------------------------------------------------
[11192]734#if defined key_mpp_mpi
[1345]735      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_world     : ', ngrp_world
736      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - mpi_comm_world : ', mpi_comm_world
[9570]737      !-$$     WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - mpi_comm_oce   : ', mpi_comm_oce
[1345]738      !
[2715]739      ALLOCATE( kwork(jpnij), STAT=ierr )
[11317]740      IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'mpp_ini_znl : failed to allocate 1D array of length jpnij')
[2715]741
742      IF( jpnj == 1 ) THEN
[1345]743         ngrp_znl  = ngrp_world
[9570]744         ncomm_znl = mpi_comm_oce
[1345]745      ELSE
746         !
[9570]747         CALL MPI_ALLGATHER ( njmpp, 1, mpi_integer, kwork, 1, mpi_integer, mpi_comm_oce, ierr )
[1345]748         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - kwork pour njmpp : ', kwork
749         !-$$        CALL flush(numout)
750         !
751         ! Count number of processors on the same row
752         ndim_rank_znl = 0
753         DO jproc=1,jpnij
754            IF ( kwork(jproc) == njmpp ) THEN
755               ndim_rank_znl = ndim_rank_znl + 1
756            ENDIF
757         END DO
758         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ndim_rank_znl : ', ndim_rank_znl
759         !-$$        CALL flush(numout)
760         ! Allocate the right size to nrank_znl
[1441]761         IF (ALLOCATED (nrank_znl)) DEALLOCATE(nrank_znl)
[1345]762         ALLOCATE(nrank_znl(ndim_rank_znl))
[3764]763         ii = 0
[1345]764         nrank_znl (:) = 0
765         DO jproc=1,jpnij
766            IF ( kwork(jproc) == njmpp) THEN
767               ii = ii + 1
[3764]768               nrank_znl(ii) = jproc -1
[1345]769            ENDIF
770         END DO
771         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - nrank_znl : ', nrank_znl
772         !-$$        CALL flush(numout)
773
774         ! Create the opa group
[9570]775         CALL MPI_COMM_GROUP(mpi_comm_oce,ngrp_opa,ierr)
[1345]776         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_opa : ', ngrp_opa
777         !-$$        CALL flush(numout)
778
779         ! Create the znl group from the opa group
780         CALL MPI_GROUP_INCL  ( ngrp_opa, ndim_rank_znl, nrank_znl, ngrp_znl, ierr )
781         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ngrp_znl ', ngrp_znl
782         !-$$        CALL flush(numout)
783
784         ! Create the znl communicator from the opa communicator, ie the pool of procs in the same row
[9570]785         CALL MPI_COMM_CREATE ( mpi_comm_oce, ngrp_znl, ncomm_znl, ierr )
[1345]786         !-$$        WRITE (numout,*) 'mpp_ini_znl ', nproc, ' - ncomm_znl ', ncomm_znl
787         !-$$        CALL flush(numout)
788         !
789      END IF
790
791      ! Determines if processor if the first (starting from i=1) on the row
[3764]792      IF ( jpni == 1 ) THEN
[1345]793         l_znl_root = .TRUE.
794      ELSE
795         l_znl_root = .FALSE.
796         kwork (1) = nimpp
[10425]797         CALL mpp_min ( 'lib_mpp', kwork(1), kcom = ncomm_znl)
[1345]798         IF ( nimpp == kwork(1)) l_znl_root = .TRUE.
799      END IF
800
[2715]801      DEALLOCATE(kwork)
[11192]802#endif
[2715]803
[1345]804   END SUBROUTINE mpp_ini_znl
805
806
[1344]807   SUBROUTINE mpp_ini_north
808      !!----------------------------------------------------------------------
809      !!               ***  routine mpp_ini_north  ***
810      !!
[3764]811      !! ** Purpose :   Initialize special communicator for north folding
[1344]812      !!      condition together with global variables needed in the mpp folding
813      !!
814      !! ** Method  : - Look for northern processors
815      !!              - Put their number in nrank_north
816      !!              - Create groups for the world processors and the north processors
817      !!              - Create a communicator for northern processors
818      !!
819      !! ** output
820      !!      njmppmax = njmpp for northern procs
821      !!      ndim_rank_north = number of processors in the northern line
822      !!      nrank_north (ndim_rank_north) = number  of the northern procs.
823      !!      ngrp_world = group ID for the world processors
824      !!      ngrp_north = group ID for the northern processors
825      !!      ncomm_north = communicator for the northern procs.
826      !!      north_root = number (in the world) of proc 0 in the northern comm.
827      !!
828      !!----------------------------------------------------------------------
829      INTEGER ::   ierr
830      INTEGER ::   jjproc
831      INTEGER ::   ii, ji
832      !!----------------------------------------------------------------------
833      !
[11192]834#if defined key_mpp_mpi
[1344]835      njmppmax = MAXVAL( njmppt )
836      !
837      ! Look for how many procs on the northern boundary
838      ndim_rank_north = 0
839      DO jjproc = 1, jpnij
840         IF( njmppt(jjproc) == njmppmax )   ndim_rank_north = ndim_rank_north + 1
841      END DO
842      !
843      ! Allocate the right size to nrank_north
[1441]844      IF (ALLOCATED (nrank_north)) DEALLOCATE(nrank_north)
[1344]845      ALLOCATE( nrank_north(ndim_rank_north) )
[869]846
[1344]847      ! Fill the nrank_north array with proc. number of northern procs.
848      ! Note : the rank start at 0 in MPI
849      ii = 0
850      DO ji = 1, jpnij
851         IF ( njmppt(ji) == njmppmax   ) THEN
852            ii=ii+1
853            nrank_north(ii)=ji-1
854         END IF
855      END DO
856      !
857      ! create the world group
[9570]858      CALL MPI_COMM_GROUP( mpi_comm_oce, ngrp_world, ierr )
[1344]859      !
860      ! Create the North group from the world group
861      CALL MPI_GROUP_INCL( ngrp_world, ndim_rank_north, nrank_north, ngrp_north, ierr )
862      !
863      ! Create the North communicator , ie the pool of procs in the north group
[9570]864      CALL MPI_COMM_CREATE( mpi_comm_oce, ngrp_north, ncomm_north, ierr )
[1344]865      !
[11192]866#endif
[1344]867   END SUBROUTINE mpp_ini_north
[869]868
869
[9019]870   SUBROUTINE DDPDD_MPI( ydda, yddb, ilen, itype )
[1976]871      !!---------------------------------------------------------------------
872      !!   Routine DDPDD_MPI: used by reduction operator MPI_SUMDD
873      !!
874      !!   Modification of original codes written by David H. Bailey
875      !!   This subroutine computes yddb(i) = ydda(i)+yddb(i)
876      !!---------------------------------------------------------------------
[9019]877      INTEGER                     , INTENT(in)    ::   ilen, itype
878      COMPLEX(wp), DIMENSION(ilen), INTENT(in)    ::   ydda
879      COMPLEX(wp), DIMENSION(ilen), INTENT(inout) ::   yddb
[1976]880      !
881      REAL(wp) :: zerr, zt1, zt2    ! local work variables
[9019]882      INTEGER  :: ji, ztmp           ! local scalar
883      !!---------------------------------------------------------------------
884      !
[1976]885      ztmp = itype   ! avoid compilation warning
[9019]886      !
[1976]887      DO ji=1,ilen
888      ! Compute ydda + yddb using Knuth's trick.
889         zt1  = real(ydda(ji)) + real(yddb(ji))
890         zerr = zt1 - real(ydda(ji))
891         zt2  = ((real(yddb(ji)) - zerr) + (real(ydda(ji)) - (zt1 - zerr))) &
892                + aimag(ydda(ji)) + aimag(yddb(ji))
893
894         ! The result is zt1 + zt2, after normalization.
895         yddb(ji) = cmplx ( zt1 + zt2, zt2 - ((zt1 + zt2) - zt1),wp )
896      END DO
[9019]897      !
[1976]898   END SUBROUTINE DDPDD_MPI
899
[6140]900
[10437]901   SUBROUTINE mpp_report( cdname, kpk, kpl, kpf, ld_lbc, ld_glb, ld_dlg )
[10425]902      !!----------------------------------------------------------------------
903      !!                  ***  routine mpp_report  ***
904      !!
905      !! ** Purpose :   report use of mpp routines per time-setp
906      !!
907      !!----------------------------------------------------------------------
908      CHARACTER(len=*),           INTENT(in   ) ::   cdname      ! name of the calling subroutine
909      INTEGER         , OPTIONAL, INTENT(in   ) ::   kpk, kpl, kpf
[10437]910      LOGICAL         , OPTIONAL, INTENT(in   ) ::   ld_lbc, ld_glb, ld_dlg
[10425]911      !!
[10982]912      CHARACTER(len=128)                        ::   ccountname  ! name of a subroutine to count communications
[10437]913      LOGICAL ::   ll_lbc, ll_glb, ll_dlg
[10982]914      INTEGER ::    ji,  jj,  jk,  jh, jf, jcount   ! dummy loop indices
[10425]915      !!----------------------------------------------------------------------
[11192]916#if defined key_mpp_mpi
[10425]917      !
918      ll_lbc = .FALSE.
919      IF( PRESENT(ld_lbc) ) ll_lbc = ld_lbc
920      ll_glb = .FALSE.
921      IF( PRESENT(ld_glb) ) ll_glb = ld_glb
[10437]922      ll_dlg = .FALSE.
923      IF( PRESENT(ld_dlg) ) ll_dlg = ld_dlg
[10425]924      !
925      ! find the smallest common frequency: default = frequency product, if multiple, choose the larger of the 2 frequency
926      IF( ncom_dttrc /= 1 )   CALL ctl_stop( 'STOP', 'mpp_report, ncom_dttrc /= 1 not coded...' ) 
927      ncom_freq = ncom_fsbc
928      !
929      IF ( ncom_stp == nit000+ncom_freq ) THEN   ! avoid to count extra communications in potential initializations at nit000
930         IF( ll_lbc ) THEN
931            IF( .NOT. ALLOCATED(ncomm_sequence) ) ALLOCATE( ncomm_sequence(ncom_rec_max,2) )
932            IF( .NOT. ALLOCATED(    crname_lbc) ) ALLOCATE(     crname_lbc(ncom_rec_max  ) )
933            n_sequence_lbc = n_sequence_lbc + 1
934            IF( n_sequence_lbc > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
935            crname_lbc(n_sequence_lbc) = cdname     ! keep the name of the calling routine
936            ncomm_sequence(n_sequence_lbc,1) = kpk*kpl   ! size of 3rd and 4th dimensions
937            ncomm_sequence(n_sequence_lbc,2) = kpf       ! number of arrays to be treated (multi)
938         ENDIF
939         IF( ll_glb ) THEN
940            IF( .NOT. ALLOCATED(crname_glb) ) ALLOCATE( crname_glb(ncom_rec_max) )
941            n_sequence_glb = n_sequence_glb + 1
942            IF( n_sequence_glb > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
943            crname_glb(n_sequence_glb) = cdname     ! keep the name of the calling routine
944         ENDIF
[10437]945         IF( ll_dlg ) THEN
946            IF( .NOT. ALLOCATED(crname_dlg) ) ALLOCATE( crname_dlg(ncom_rec_max) )
947            n_sequence_dlg = n_sequence_dlg + 1
948            IF( n_sequence_dlg > ncom_rec_max ) CALL ctl_stop( 'STOP', 'lib_mpp, increase ncom_rec_max' )   ! deadlock
949            crname_dlg(n_sequence_dlg) = cdname     ! keep the name of the calling routine
950         ENDIF
[10425]951      ELSE IF ( ncom_stp == nit000+2*ncom_freq ) THEN
952         CALL ctl_opn( numcom, 'communication_report.txt', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., narea )
953         WRITE(numcom,*) ' '
954         WRITE(numcom,*) ' ------------------------------------------------------------'
955         WRITE(numcom,*) ' Communication pattern report (second oce+sbc+top time step):'
956         WRITE(numcom,*) ' ------------------------------------------------------------'
957         WRITE(numcom,*) ' '
958         WRITE(numcom,'(A,I4)') ' Exchanged halos : ', n_sequence_lbc
959         jj = 0; jk = 0; jf = 0; jh = 0
960         DO ji = 1, n_sequence_lbc
961            IF ( ncomm_sequence(ji,1) .GT. 1 ) jk = jk + 1
962            IF ( ncomm_sequence(ji,2) .GT. 1 ) jf = jf + 1
963            IF ( ncomm_sequence(ji,1) .GT. 1 .AND. ncomm_sequence(ji,2) .GT. 1 ) jj = jj + 1
964            jh = MAX (jh, ncomm_sequence(ji,1)*ncomm_sequence(ji,2))
965         END DO
966         WRITE(numcom,'(A,I3)') ' 3D Exchanged halos : ', jk
967         WRITE(numcom,'(A,I3)') ' Multi arrays exchanged halos : ', jf
968         WRITE(numcom,'(A,I3)') '   from which 3D : ', jj
969         WRITE(numcom,'(A,I10)') ' Array max size : ', jh*jpi*jpj
970         WRITE(numcom,*) ' '
971         WRITE(numcom,*) ' lbc_lnk called'
[10982]972         DO ji = 1, n_sequence_lbc - 1
973            IF ( crname_lbc(ji) /= 'already counted' ) THEN
974               ccountname = crname_lbc(ji)
975               crname_lbc(ji) = 'already counted'
976               jcount = 1
977               DO jj = ji + 1, n_sequence_lbc
978                  IF ( ccountname ==  crname_lbc(jj) ) THEN
979                     jcount = jcount + 1
980                     crname_lbc(jj) = 'already counted'
981                  END IF
982               END DO
983               WRITE(numcom,'(A, I4, A, A)') ' - ', jcount,' times by subroutine ', TRIM(ccountname)
[10425]984            END IF
985         END DO
[10982]986         IF ( crname_lbc(n_sequence_lbc) /= 'already counted' ) THEN
987            WRITE(numcom,'(A, I4, A, A)') ' - ', 1,' times by subroutine ', TRIM(crname_lbc(ncom_rec_max))
988         END IF
[10425]989         WRITE(numcom,*) ' '
990         IF ( n_sequence_glb > 0 ) THEN
991            WRITE(numcom,'(A,I4)') ' Global communications : ', n_sequence_glb
992            jj = 1
993            DO ji = 2, n_sequence_glb
994               IF( crname_glb(ji-1) /= crname_glb(ji) ) THEN
995                  WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_glb(ji-1))
996                  jj = 0
997               END IF
998               jj = jj + 1 
999            END DO
1000            WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_glb(n_sequence_glb))
1001            DEALLOCATE(crname_glb)
1002         ELSE
1003            WRITE(numcom,*) ' No MPI global communication '
1004         ENDIF
1005         WRITE(numcom,*) ' '
[10437]1006         IF ( n_sequence_dlg > 0 ) THEN
1007            WRITE(numcom,'(A,I4)') ' Delayed global communications : ', n_sequence_dlg
1008            jj = 1
1009            DO ji = 2, n_sequence_dlg
1010               IF( crname_dlg(ji-1) /= crname_dlg(ji) ) THEN
1011                  WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_dlg(ji-1))
1012                  jj = 0
1013               END IF
1014               jj = jj + 1 
1015            END DO
1016            WRITE(numcom,'(A, I4, A, A)') ' - ', jj,' times by subroutine ', TRIM(crname_dlg(n_sequence_dlg))
1017            DEALLOCATE(crname_dlg)
1018         ELSE
1019            WRITE(numcom,*) ' No MPI delayed global communication '
1020         ENDIF
1021         WRITE(numcom,*) ' '
[10425]1022         WRITE(numcom,*) ' -----------------------------------------------'
1023         WRITE(numcom,*) ' '
1024         DEALLOCATE(ncomm_sequence)
1025         DEALLOCATE(crname_lbc)
1026      ENDIF
[11192]1027#endif
[10425]1028   END SUBROUTINE mpp_report
1029
[6140]1030   
[10425]1031   SUBROUTINE tic_tac (ld_tic, ld_global)
1032
1033    LOGICAL,           INTENT(IN) :: ld_tic
1034    LOGICAL, OPTIONAL, INTENT(IN) :: ld_global
1035    REAL(wp), DIMENSION(2), SAVE :: tic_wt
1036    REAL(wp),               SAVE :: tic_ct = 0._wp
1037    INTEGER :: ii
[11192]1038#if defined key_mpp_mpi
[10425]1039
1040    IF( ncom_stp <= nit000 ) RETURN
1041    IF( ncom_stp == nitend ) RETURN
1042    ii = 1
1043    IF( PRESENT( ld_global ) ) THEN
1044       IF( ld_global ) ii = 2
1045    END IF
1046   
1047    IF ( ld_tic ) THEN
1048       tic_wt(ii) = MPI_Wtime()                                                    ! start count tic->tac (waiting time)
1049       IF ( tic_ct > 0.0_wp ) compute_time = compute_time + MPI_Wtime() - tic_ct   ! cumulate count tac->tic
1050    ELSE
1051       waiting_time(ii) = waiting_time(ii) + MPI_Wtime() - tic_wt(ii)              ! cumulate count tic->tac
1052       tic_ct = MPI_Wtime()                                                        ! start count tac->tic (waiting time)
1053    ENDIF
[11192]1054#endif
[10425]1055   
1056   END SUBROUTINE tic_tac
1057
[11192]1058#if ! defined key_mpp_mpi
1059   SUBROUTINE mpi_wait(request, status, ierror)
1060      INTEGER                            , INTENT(in   ) ::   request
1061      INTEGER, DIMENSION(MPI_STATUS_SIZE), INTENT(  out) ::   status
1062      INTEGER                            , INTENT(  out) ::   ierror
1063   END SUBROUTINE mpi_wait
[11390]1064
1065   
1066   FUNCTION MPI_Wtime()
1067      REAL(wp) ::  MPI_Wtime
1068      MPI_Wtime = -1.
1069   END FUNCTION MPI_Wtime
[3]1070#endif
[2715]1071
[13]1072   !!----------------------------------------------------------------------
[11192]1073   !!   ctl_stop, ctl_warn, get_unit, ctl_opn, ctl_nam   routines
[2715]1074   !!----------------------------------------------------------------------
1075
1076   SUBROUTINE ctl_stop( cd1, cd2, cd3, cd4, cd5 ,   &
1077      &                 cd6, cd7, cd8, cd9, cd10 )
1078      !!----------------------------------------------------------------------
1079      !!                  ***  ROUTINE  stop_opa  ***
1080      !!
[3764]1081      !! ** Purpose :   print in ocean.outpput file a error message and
[2715]1082      !!                increment the error number (nstop) by one.
1083      !!----------------------------------------------------------------------
[11317]1084      CHARACTER(len=*), INTENT(in   )           ::   cd1
1085      CHARACTER(len=*), INTENT(in   ), OPTIONAL ::        cd2, cd3, cd4, cd5
1086      CHARACTER(len=*), INTENT(in   ), OPTIONAL ::   cd6, cd7, cd8, cd9, cd10
[2715]1087      !!----------------------------------------------------------------------
1088      !
[3764]1089      nstop = nstop + 1
[11317]1090      !
1091      ! force to open ocean.output file if not already opened
[10425]1092      IF( numout == 6 ) CALL ctl_opn( numout, 'ocean.output', 'APPEND', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[11317]1093      !
1094                            WRITE(numout,*)
1095                            WRITE(numout,*) ' ===>>> : E R R O R'
1096                            WRITE(numout,*)
1097                            WRITE(numout,*) '         ==========='
1098                            WRITE(numout,*)
1099                            WRITE(numout,*) TRIM(cd1)
[10425]1100      IF( PRESENT(cd2 ) )   WRITE(numout,*) TRIM(cd2)
1101      IF( PRESENT(cd3 ) )   WRITE(numout,*) TRIM(cd3)
1102      IF( PRESENT(cd4 ) )   WRITE(numout,*) TRIM(cd4)
1103      IF( PRESENT(cd5 ) )   WRITE(numout,*) TRIM(cd5)
1104      IF( PRESENT(cd6 ) )   WRITE(numout,*) TRIM(cd6)
1105      IF( PRESENT(cd7 ) )   WRITE(numout,*) TRIM(cd7)
1106      IF( PRESENT(cd8 ) )   WRITE(numout,*) TRIM(cd8)
1107      IF( PRESENT(cd9 ) )   WRITE(numout,*) TRIM(cd9)
1108      IF( PRESENT(cd10) )   WRITE(numout,*) TRIM(cd10)
[11317]1109                            WRITE(numout,*)
1110      !
[2715]1111                               CALL FLUSH(numout    )
1112      IF( numstp     /= -1 )   CALL FLUSH(numstp    )
[9019]1113      IF( numrun     /= -1 )   CALL FLUSH(numrun    )
[2715]1114      IF( numevo_ice /= -1 )   CALL FLUSH(numevo_ice)
1115      !
1116      IF( cd1 == 'STOP' ) THEN
[11317]1117         WRITE(numout,*) 
[10425]1118         WRITE(numout,*)  'huge E-R-R-O-R : immediate stop'
[11317]1119         WRITE(numout,*) 
1120         CALL mppstop( ld_force_abort = .true. )
[2715]1121      ENDIF
1122      !
1123   END SUBROUTINE ctl_stop
1124
1125
1126   SUBROUTINE ctl_warn( cd1, cd2, cd3, cd4, cd5,   &
1127      &                 cd6, cd7, cd8, cd9, cd10 )
1128      !!----------------------------------------------------------------------
1129      !!                  ***  ROUTINE  stop_warn  ***
1130      !!
[3764]1131      !! ** Purpose :   print in ocean.outpput file a error message and
[2715]1132      !!                increment the warning number (nwarn) by one.
1133      !!----------------------------------------------------------------------
1134      CHARACTER(len=*), INTENT(in), OPTIONAL ::  cd1, cd2, cd3, cd4, cd5
1135      CHARACTER(len=*), INTENT(in), OPTIONAL ::  cd6, cd7, cd8, cd9, cd10
1136      !!----------------------------------------------------------------------
[3764]1137      !
1138      nwarn = nwarn + 1
[11317]1139      !
[2715]1140      IF(lwp) THEN
[11317]1141                               WRITE(numout,*)
1142                               WRITE(numout,*) ' ===>>> : W A R N I N G'
1143                               WRITE(numout,*)
1144                               WRITE(numout,*) '         ==============='
1145                               WRITE(numout,*)
1146         IF( PRESENT(cd1 ) )   WRITE(numout,*) TRIM(cd1)
1147         IF( PRESENT(cd2 ) )   WRITE(numout,*) TRIM(cd2)
1148         IF( PRESENT(cd3 ) )   WRITE(numout,*) TRIM(cd3)
1149         IF( PRESENT(cd4 ) )   WRITE(numout,*) TRIM(cd4)
1150         IF( PRESENT(cd5 ) )   WRITE(numout,*) TRIM(cd5)
1151         IF( PRESENT(cd6 ) )   WRITE(numout,*) TRIM(cd6)
1152         IF( PRESENT(cd7 ) )   WRITE(numout,*) TRIM(cd7)
1153         IF( PRESENT(cd8 ) )   WRITE(numout,*) TRIM(cd8)
1154         IF( PRESENT(cd9 ) )   WRITE(numout,*) TRIM(cd9)
1155         IF( PRESENT(cd10) )   WRITE(numout,*) TRIM(cd10)
1156                               WRITE(numout,*)
[2715]1157      ENDIF
1158      CALL FLUSH(numout)
1159      !
1160   END SUBROUTINE ctl_warn
1161
1162
1163   SUBROUTINE ctl_opn( knum, cdfile, cdstat, cdform, cdacce, klengh, kout, ldwp, karea )
1164      !!----------------------------------------------------------------------
1165      !!                  ***  ROUTINE ctl_opn  ***
1166      !!
1167      !! ** Purpose :   Open file and check if required file is available.
1168      !!
1169      !! ** Method  :   Fortan open
1170      !!----------------------------------------------------------------------
1171      INTEGER          , INTENT(  out) ::   knum      ! logical unit to open
1172      CHARACTER(len=*) , INTENT(in   ) ::   cdfile    ! file name to open
1173      CHARACTER(len=*) , INTENT(in   ) ::   cdstat    ! disposition specifier
1174      CHARACTER(len=*) , INTENT(in   ) ::   cdform    ! formatting specifier
1175      CHARACTER(len=*) , INTENT(in   ) ::   cdacce    ! access specifier
1176      INTEGER          , INTENT(in   ) ::   klengh    ! record length
1177      INTEGER          , INTENT(in   ) ::   kout      ! number of logical units for write
1178      LOGICAL          , INTENT(in   ) ::   ldwp      ! boolean term for print
1179      INTEGER, OPTIONAL, INTENT(in   ) ::   karea     ! proc number
[5836]1180      !
[2715]1181      CHARACTER(len=80) ::   clfile
1182      INTEGER           ::   iost
1183      !!----------------------------------------------------------------------
[5836]1184      !
[2715]1185      ! adapt filename
1186      ! ----------------
1187      clfile = TRIM(cdfile)
1188      IF( PRESENT( karea ) ) THEN
1189         IF( karea > 1 )   WRITE(clfile, "(a,'_',i4.4)") TRIM(clfile), karea-1
1190      ENDIF
1191#if defined key_agrif
1192      IF( .NOT. Agrif_Root() )   clfile = TRIM(Agrif_CFixed())//'_'//TRIM(clfile)
1193      knum=Agrif_Get_Unit()
1194#else
1195      knum=get_unit()
1196#endif
[10425]1197      IF( TRIM(cdfile) == '/dev/null' )   clfile = TRIM(cdfile)   ! force the use of /dev/null
[5836]1198      !
[11317]1199      IF(       cdacce(1:6) == 'DIRECT' )  THEN   ! cdacce has always more than 6 characters
[10425]1200         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS=cdstat, RECL=klengh         , ERR=100, IOSTAT=iost )
1201      ELSE IF( TRIM(cdstat) == 'APPEND' )  THEN   ! cdstat can have less than 6 characters
1202         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS='UNKNOWN', POSITION='APPEND', ERR=100, IOSTAT=iost )
[2715]1203      ELSE
[10425]1204         OPEN( UNIT=knum, FILE=clfile, FORM=cdform, ACCESS=cdacce, STATUS=cdstat                      , ERR=100, IOSTAT=iost )
[2715]1205      ENDIF
[10425]1206      IF( iost /= 0 .AND. TRIM(clfile) == '/dev/null' ) &   ! for windows
1207         &  OPEN(UNIT=knum,FILE='NUL', FORM=cdform, ACCESS=cdacce, STATUS=cdstat                      , ERR=100, IOSTAT=iost )   
[2715]1208      IF( iost == 0 ) THEN
1209         IF(ldwp) THEN
[10425]1210            WRITE(kout,*) '     file   : ', TRIM(clfile),' open ok'
[2715]1211            WRITE(kout,*) '     unit   = ', knum
1212            WRITE(kout,*) '     status = ', cdstat
1213            WRITE(kout,*) '     form   = ', cdform
1214            WRITE(kout,*) '     access = ', cdacce
1215            WRITE(kout,*)
1216         ENDIF
1217      ENDIF
1218100   CONTINUE
1219      IF( iost /= 0 ) THEN
[11317]1220         WRITE(ctmp1,*) ' ===>>>> : bad opening file: ', TRIM(clfile)
1221         WRITE(ctmp2,*) ' =======   ===  '
1222         WRITE(ctmp3,*) '           unit   = ', knum
1223         WRITE(ctmp4,*) '           status = ', cdstat
1224         WRITE(ctmp5,*) '           form   = ', cdform
1225         WRITE(ctmp6,*) '           access = ', cdacce
1226         WRITE(ctmp7,*) '           iostat = ', iost
1227         WRITE(ctmp8,*) '           we stop. verify the file '
1228         CALL ctl_stop( 'STOP', ctmp1, ctmp2, ctmp3, ctmp4, ctmp5, ctmp6, ctmp7, ctmp8 )
[2715]1229      ENDIF
[5836]1230      !
[2715]1231   END SUBROUTINE ctl_opn
1232
[5836]1233
[11317]1234   SUBROUTINE ctl_nam ( kios, cdnam )
[4147]1235      !!----------------------------------------------------------------------
1236      !!                  ***  ROUTINE ctl_nam  ***
1237      !!
1238      !! ** Purpose :   Informations when error while reading a namelist
1239      !!
1240      !! ** Method  :   Fortan open
1241      !!----------------------------------------------------------------------
[11317]1242      INTEGER                                , INTENT(inout) ::   kios    ! IO status after reading the namelist
1243      CHARACTER(len=*)                       , INTENT(in   ) ::   cdnam   ! group name of namelist for which error occurs
1244      !
1245      CHARACTER(len=5) ::   clios   ! string to convert iostat in character for print
[4147]1246      !!----------------------------------------------------------------------
[5836]1247      !
[7646]1248      WRITE (clios, '(I5.0)')   kios
[4147]1249      IF( kios < 0 ) THEN         
[5836]1250         CALL ctl_warn( 'end of record or file while reading namelist '   &
1251            &           // TRIM(cdnam) // ' iostat = ' // TRIM(clios) )
[4147]1252      ENDIF
[5836]1253      !
[4147]1254      IF( kios > 0 ) THEN
[5836]1255         CALL ctl_stop( 'misspelled variable in namelist '   &
1256            &           // TRIM(cdnam) // ' iostat = ' // TRIM(clios) )
[4147]1257      ENDIF
1258      kios = 0
[5836]1259      !
[4147]1260   END SUBROUTINE ctl_nam
1261
[5836]1262
[2715]1263   INTEGER FUNCTION get_unit()
1264      !!----------------------------------------------------------------------
1265      !!                  ***  FUNCTION  get_unit  ***
1266      !!
1267      !! ** Purpose :   return the index of an unused logical unit
1268      !!----------------------------------------------------------------------
[3764]1269      LOGICAL :: llopn
[2715]1270      !!----------------------------------------------------------------------
1271      !
1272      get_unit = 15   ! choose a unit that is big enough then it is not already used in NEMO
1273      llopn = .TRUE.
1274      DO WHILE( (get_unit < 998) .AND. llopn )
1275         get_unit = get_unit + 1
1276         INQUIRE( unit = get_unit, opened = llopn )
1277      END DO
1278      IF( (get_unit == 999) .AND. llopn ) THEN
[11317]1279         CALL ctl_stop( 'STOP', 'get_unit: All logical units until 999 are used...' )
[2715]1280      ENDIF
1281      !
1282   END FUNCTION get_unit
1283
1284   !!----------------------------------------------------------------------
[3]1285END MODULE lib_mpp
Note: See TracBrowser for help on using the repository browser.