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.
nemogcm.F90 in branches/UKMO/dev_r5518_GO6_starthour_obsoper/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/UKMO/dev_r5518_GO6_starthour_obsoper/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 15690

Last change on this file since 15690 was 15690, checked in by mattmartin, 2 years ago

Fixed minor typos from Jonah's review in ticket https://code.metoffice.gov.uk/trac/nwpscience/ticket/1125

File size: 44.4 KB
RevLine 
[2496]1MODULE nemogcm
[2442]2   !!======================================================================
[2496]3   !!                       ***  MODULE nemogcm   ***
4   !! Ocean system   : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
[2442]5   !!======================================================================
[1593]6   !! History :  OPA  ! 1990-10  (C. Levy, G. Madec)  Original code
7   !!            7.0  ! 1991-11  (M. Imbard, C. Levy, G. Madec)
[3764]8   !!            7.1  ! 1993-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
9   !!                             P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
[1593]10   !!             -   ! 1992-06  (L.Terray)  coupling implementation
[3764]11   !!             -   ! 1993-11  (M.A. Filiberti) IGLOO sea-ice
12   !!            8.0  ! 1996-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
[2104]13   !!                             P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
[1593]14   !!            8.1  ! 1997-06  (M. Imbard, G. Madec)
[3764]15   !!            8.2  ! 1999-11  (M. Imbard, H. Goosse)  LIM sea-ice model
16   !!                 ! 1999-12  (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols)  OPEN-MP
[1593]17   !!                 ! 2000-07  (J-M Molines, M. Imbard)  Open Boundary Conditions  (CLIPPER)
18   !!   NEMO     1.0  ! 2002-08  (G. Madec)  F90: Free form and modules
19   !!             -   ! 2004-06  (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
20   !!             -   ! 2004-08  (C. Talandier) New trends organization
21   !!             -   ! 2005-06  (C. Ethe) Add the 1D configuration possibility
22   !!             -   ! 2005-11  (V. Garnier) Surface pressure gradient organization
23   !!             -   ! 2006-03  (L. Debreu, C. Mazauric)  Agrif implementation
24   !!             -   ! 2006-04  (G. Madec, R. Benshila)  Step reorganization
25   !!             -   ! 2007-07  (J. Chanut, A. Sellar) Unstructured open boundaries (BDY)
26   !!            3.2  ! 2009-08  (S. Masson)  open/write in the listing file in mpp
[3764]27   !!            3.3  ! 2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
[2236]28   !!             -   ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
[3294]29   !!            3.3.1! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
30   !!            3.4  ! 2011-11  (C. Harris) decomposition changes for running with CICE
[4152]31   !!                 ! 2012-05  (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
[1593]32   !!----------------------------------------------------------------------
[3]33
34   !!----------------------------------------------------------------------
[2496]35   !!   nemo_gcm       : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
36   !!   nemo_init      : initialization of the NEMO system
[3764]37   !!   nemo_ctl       : initialisation of the contol print
[2496]38   !!   nemo_closefile : close remaining open files
[2715]39   !!   nemo_alloc     : dynamical allocation
40   !!   nemo_partition : calculate MPP domain decomposition
41   !!   factorise      : calculate the factors of the no. of MPI processes
[3]42   !!----------------------------------------------------------------------
[2382]43   USE step_oce        ! module used in the ocean time stepping module
[2392]44   USE cla             ! cross land advection               (tra_cla routine)
[3]45   USE domcfg          ! domain configuration               (dom_cfg routine)
46   USE mppini          ! shared/distributed memory setting (mpp_init routine)
47   USE domain          ! domain initialization             (dom_init routine)
[3625]48#if defined key_nemocice_decomp
49   USE ice_domain_size, only: nx_global, ny_global
50#endif
[3651]51   USE tideini         ! tidal components initialization   (tide_ini routine)
[4990]52   USE bdyini          ! open boundary cond. setting       (bdy_init routine)
53   USE bdydta          ! open boundary cond. setting   (bdy_dta_init routine)
54   USE bdytides        ! open boundary cond. setting   (bdytide_init routine)
[3]55   USE istate          ! initial state setting          (istate_init routine)
56   USE ldfdyn          ! lateral viscosity setting      (ldfdyn_init routine)
57   USE ldftra          ! lateral diffusivity setting    (ldftra_init routine)
[2392]58   USE zdfini          ! vertical physics setting          (zdf_init routine)
[3]59   USE phycst          ! physical constant                  (par_cst routine)
[4990]60   USE trdini          ! dyn/tra trends initialization     (trd_init routine)
[3768]61   USE asminc          ! assimilation increments     
62   USE asmbkg          ! writing out state trajectory
[2236]63   USE diaptr          ! poleward transports           (dia_ptr_init routine)
[3294]64   USE diadct          ! sections transports           (dia_dct_init routine)
[2236]65   USE diaobs          ! Observation diagnostics       (dia_obs_init routine)
[3764]66   USE lib_fortran     ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[2496]67   USE step            ! NEMO time-stepping                 (stp     routine)
[3609]68   USE icbini          ! handle bergs, initialisation
69   USE icbstp          ! handle bergs, calving, themodynamics and transport
[8280]70   USE sbccpl 
[1359]71   USE cpl_oasis3      ! OASIS3 coupling
[900]72   USE c1d             ! 1D configuration
73   USE step_c1d        ! Time stepping loop for the 1D configuration
[4245]74   USE dyndmp          ! Momentum damping
[1594]75#if defined key_top
[1593]76   USE trcini          ! passive tracer initialisation
[8280]77   USE trc, ONLY: numstr  ! tracer stats unit number
[1594]78#endif
[1593]79   USE lib_mpp         ! distributed memory computing
[1412]80#if defined key_iomput
[3701]81   USE xios
[1359]82#endif
[3651]83   USE sbctide, ONLY: lk_tide
[4152]84   USE crsini          ! initialise grid coarsening utility
[4671]85   USE lbcnfd, ONLY: isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
[5407]86   USE sbc_oce, ONLY: lk_oasis
[15603]87   USE stopack
[5329]88   USE stopar
89   USE stopts
[268]90
[2715]91   IMPLICIT NONE
[3]92   PRIVATE
93
[2496]94   PUBLIC   nemo_gcm    ! called by model.F90
95   PUBLIC   nemo_init   ! needed by AGRIF
[3764]96   PUBLIC   nemo_alloc  ! needed by TAM
[467]97
[2498]98   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
[1593]99
[3]100   !!----------------------------------------------------------------------
[2715]101   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
[2392]102   !! $Id$
[2329]103   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
[3]104   !!----------------------------------------------------------------------
105CONTAINS
106
[2496]107   SUBROUTINE nemo_gcm
[3]108      !!----------------------------------------------------------------------
[2496]109      !!                     ***  ROUTINE nemo_gcm  ***
[3]110      !!
[3764]111      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
[1593]112      !!              curvilinear mesh on the sphere.
[3]113      !!
114      !! ** Method  : - model general initialization
115      !!              - launch the time-stepping (stp routine)
[1593]116      !!              - finalize the run by closing files and communications
[3]117      !!
[2715]118      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
[1593]119      !!              Madec, 2008, internal report, IPSL.
[3]120      !!----------------------------------------------------------------------
121      INTEGER ::   istp       ! time step index
[389]122      !!----------------------------------------------------------------------
[2382]123      !
[392]124#if defined key_agrif
[1593]125      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
[389]126#endif
127
[1593]128      !                            !-----------------------!
[2496]129      CALL nemo_init               !==  Initialisations  ==!
[1593]130      !                            !-----------------------!
[2715]131#if defined key_agrif
[3680]132      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
133      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
[2715]134# if defined key_top
[3680]135      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
[2715]136# endif
[3680]137# if defined key_lim2
138      CALL Agrif_Declare_Var_lim2  !  "      "   "   "      "  LIM
139# endif
[2715]140#endif
[682]141      ! check that all process are still there... If some process have an error,
142      ! they will never enter in step and other processes will wait until the end of the cpu time!
[900]143      IF( lk_mpp )   CALL mpp_max( nstop )
[682]144
[1593]145      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
146
147      !                            !-----------------------!
148      !                            !==   time stepping   ==!
149      !                            !-----------------------!
[900]150      istp = nit000
[2236]151#if defined key_c1d
[389]152         DO WHILE ( istp <= nitend .AND. nstop == 0 )
[900]153            CALL stp_c1d( istp )
[389]154            istp = istp + 1
155         END DO
[2236]156#else
157          IF( lk_asminc ) THEN
158             IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 )    ! Output background fields
159             IF( ln_asmdin ) THEN                        ! Direct initialization
160                IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 )    ! Tracers
[3764]161                IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 )    ! Dynamics
[2236]162                IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 )    ! SSH
163             ENDIF
164          ENDIF
[3764]165
[6487]166#if defined key_agrif
167          CALL Agrif_Regrid()
168#endif
169
[389]170         DO WHILE ( istp <= nitend .AND. nstop == 0 )
[392]171#if defined key_agrif
[6487]172            CALL stp                         ! AGRIF: time stepping
[389]173#else
[8280]174            IF (lk_oasis) CALL sbc_cpl_snd( istp )  ! Coupling to atmos
175       CALL stp( istp )
176            ! We don't couple on the final timestep because
177            ! our restart file has already been written
178            ! and contains all the necessary data for a
179            ! restart. sbc_cpl_snd could be called here
180            ! but it would require
181            ! a) A test to ensure it was not performed
182            !    on the very last time-step
183            ! b) the presence of another call to
184            !    sbc_cpl_snd call prior to the main DO loop
185            ! This solution produces identical results
186            ! with fewer lines of code.
[389]187#endif
188            istp = istp + 1
[900]189            IF( lk_mpp )   CALL mpp_max( nstop )
[389]190         END DO
[2236]191#endif
192
[3609]193      IF( lk_diaobs   )   CALL dia_obs_wri
194      !
195      IF( ln_icebergs )   CALL icb_end( nitend )
[3764]196
[1593]197      !                            !------------------------!
198      !                            !==  finalize the run  ==!
199      !                            !------------------------!
200      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
201      !
202      IF( nstop /= 0 .AND. lwp ) THEN   ! error print
[682]203         WRITE(numout,cform_err)
[3764]204         WRITE(numout,*) nstop, ' error have been found'
[389]205      ENDIF
[1593]206      !
[3294]207#if defined key_agrif
[6487]208      IF( .NOT. Agrif_Root() ) THEN
209         CALL Agrif_ParentGrid_To_ChildGrid()
210         IF( lk_diaobs ) CALL dia_obs_wri
[9321]211         IF( nn_timing > 0 )   CALL timing_finalize
[6487]212         CALL Agrif_ChildGrid_To_ParentGrid()
213      ENDIF
[3294]214#endif
[9321]215      IF( nn_timing > 0 )   CALL timing_finalize
[3294]216      !
[2496]217      CALL nemo_closefile
[4990]218      !
[3769]219#if defined key_iomput
220      CALL xios_finalize                ! end mpp communications with xios
[5407]221      IF( lk_oasis ) CALL cpl_finalize    ! end coupling and mpp communications with OASIS
[532]222#else
[5407]223      IF( lk_oasis ) THEN
[4990]224         CALL cpl_finalize              ! end coupling and mpp communications with OASIS
225      ELSE
226         IF( lk_mpp )   CALL mppstop    ! end mpp communications
227      ENDIF
[532]228#endif
[900]229      !
[8400]230      ! Met Office addition: if failed, return non-zero exit code
231      IF( nstop /= 0 )  CALL exit( 9 ) 
232      !
[2496]233   END SUBROUTINE nemo_gcm
[389]234
235
[2496]236   SUBROUTINE nemo_init
[389]237      !!----------------------------------------------------------------------
[2496]238      !!                     ***  ROUTINE nemo_init  ***
[389]239      !!
[2496]240      !! ** Purpose :   initialization of the NEMO GCM
[389]241      !!----------------------------------------------------------------------
[2715]242      INTEGER ::   ji            ! dummy loop indices
243      INTEGER ::   ilocal_comm   ! local integer
[4147]244      INTEGER ::   ios
[2715]245      CHARACTER(len=80), DIMENSION(16) ::   cltxt
[4990]246      !
[12555]247      NAMELIST/namctl/ ln_ctl  ,sn_cfctl, nn_print, nn_ictls, nn_ictle,   &
[3294]248         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
[12555]249         &             nn_bench, nn_timing, ln_flush
[4147]250      NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, &
[5118]251         &             jpizoom, jpjzoom, jperio, ln_use_jattr
[3]252      !!----------------------------------------------------------------------
[1593]253      !
[2496]254      cltxt = ''
[5407]255      cxios_context = 'nemo'
[2496]256      !
[4147]257      !                             ! Open reference namelist and configuration namelist files
258      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
259      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]260      !
[4147]261      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints & Benchmark
262      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
[4289]263901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
[4147]264
265      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist : Control prints & Benchmark
266      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
[4289]267902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
[4147]268
[1593]269      !
[4147]270      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist : Control prints & Benchmark
271      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
[4289]272903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
[4147]273
274      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist : Control prints & Benchmark
275      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
[4289]276904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
[4309]277
[4147]278! Force values for AGRIF zoom (cf. agrif_user.F90)
279#if defined key_agrif
280   IF( .NOT. Agrif_Root() ) THEN
281      jpiglo  = nbcellsx + 2 + 2*nbghostcells
282      jpjglo  = nbcellsy + 2 + 2*nbghostcells
283      jpi     = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci
284      jpj     = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj
285      jpidta  = jpiglo
286      jpjdta  = jpjglo
287      jpizoom = 1
288      jpjzoom = 1
289      nperio  = 0
290      jperio  = 0
[5118]291      ln_use_jattr = .false.
[4147]292   ENDIF
293#endif
[12555]294      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
295      lflush    = ln_flush          ! convert namelist variable to model variable
[4147]296      !
[1593]297      !                             !--------------------------------------------!
298      !                             !  set communicator & select the local node  !
[4624]299      !                             !  NB: mynode also opens output.namelist.dyn !
300      !                             !      on unit number numond on first proc   !
[1593]301      !                             !--------------------------------------------!
[1412]302#if defined key_iomput
[2200]303      IF( Agrif_Root() ) THEN
[5407]304         IF( lk_oasis ) THEN
[8280]305            CALL cpl_init( "toyoce", ilocal_comm )                     ! nemo local communicator given by oasis
[5407]306            CALL xios_initialize( "not used",local_comm=ilocal_comm )    ! send nemo communicator to xios
[4990]307         ELSE
[5407]308            CALL  xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )    ! nemo local communicator given by xios
[4990]309         ENDIF
[2200]310      ENDIF
[5407]311      ! Nodes selection (control print return in cltxt)
312      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[532]313#else
[5407]314      IF( lk_oasis ) THEN
[4990]315         IF( Agrif_Root() ) THEN
[8280]316            CALL cpl_init( "toyoce", ilocal_comm )                      ! nemo local communicator given by oasis
[4990]317         ENDIF
[5407]318         ! Nodes selection (control print return in cltxt)
319         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[4990]320      ELSE
321         ilocal_comm = 0
[5407]322         ! Nodes selection (control print return in cltxt)
323         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
[2236]324      ENDIF
[532]325#endif
[2715]326      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
[3]327
[12555]328      IF( sn_cfctl%l_config ) THEN
329         ! Activate finer control of report outputs
330         ! optionally switch off output from selected areas (note this only
331         ! applies to output which does not involve global communications)
332         IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax  ) .OR. &
333           & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) )    &
334           &   CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
335      ELSE
336         ! Use ln_ctl to turn on or off all options.
337         CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. )
338      ENDIF
339
[4624]340      lwm = (narea == 1)                                    ! control of output namelists
[2715]341      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
[1579]342
[12555]343      IF(lwm .AND. nprint > 2) THEN
[4624]344         ! write merged namelists from earlier to output namelist now that the
345         ! file has been opened in call to mynode. nammpp has already been
346         ! written in mynode (if lk_mpp_mpi)
347         WRITE( numond, namctl )
348         WRITE( numond, namcfg )
349      ENDIF
350
[3764]351      ! If dimensions of processor grid weren't specified in the namelist file
[2715]352      ! then we calculate them here now that we have our communicator size
353      IF( (jpni < 1) .OR. (jpnj < 1) )THEN
354#if   defined key_mpp_mpi
355         IF( Agrif_Root() ) CALL nemo_partition(mppsize)
356#else
357         jpni  = 1
358         jpnj  = 1
359         jpnij = jpni*jpnj
360#endif
361      END IF
362
363      ! Calculate domain dimensions given calculated jpni and jpnj
364      ! This used to be done in par_oce.F90 when they were parameters rather
365      ! than variables
366      IF( Agrif_Root() ) THEN
[3294]367#if defined key_nemocice_decomp
[3625]368         jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first  dim.
369         jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim.
[3294]370#else
[3625]371         jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   ! first  dim.
[2715]372         jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   ! second dim.
[3294]373#endif
[6487]374      ENDIF         
[2715]375         jpk = jpkdta                                             ! third dim
[6487]376#if defined key_agrif
377         ! simple trick to use same vertical grid as parent
378         ! but different number of levels:
379         ! Save maximum number of levels in jpkdta, then define all vertical grids
380         ! with this number.
381         ! Suppress once vertical online interpolation is ok
382         IF(.NOT.Agrif_Root()) jpkdta = Agrif_Parent(jpkdta)
383#endif
[2715]384         jpim1 = jpi-1                                            ! inner domain indices
385         jpjm1 = jpj-1                                            !   "           "
386         jpkm1 = jpk-1                                            !   "           "
387         jpij  = jpi*jpj                                          !  jpi x j
388
[1593]389      IF(lwp) THEN                            ! open listing units
390         !
[1581]391         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]392         !
[1579]393         WRITE(numout,*)
[3294]394         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]395         WRITE(numout,*) '                       NEMO team'
[1579]396         WRITE(numout,*) '            Ocean General Circulation Model'
[5120]397         WRITE(numout,*) '                  version 3.6  (2015) '
[1579]398         WRITE(numout,*)
399         WRITE(numout,*)
[3764]400         DO ji = 1, SIZE(cltxt)
[1593]401            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
[1579]402         END DO
[1593]403         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
[12555]404         IF(lflush) CALL flush(numout)
[1593]405         !
[473]406      ENDIF
[2715]407
[3764]408      ! Now we know the dimensions of the grid and numout has been set we can
[2715]409      ! allocate arrays
410      CALL nemo_alloc()
411
[2496]412      !                             !-------------------------------!
413      !                             !  NEMO general initialization  !
414      !                             !-------------------------------!
[473]415
[2496]416      CALL nemo_ctl                          ! Control prints & Benchmark
[531]417
[2082]418      !                                      ! Domain decomposition
[1593]419      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
420      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
[3]421      ENDIF
[2382]422      !
[9321]423      IF( nn_timing > 0 )  CALL timing_init
[3294]424      !
[2082]425      !                                      ! General initialization
[2027]426                            CALL     phy_cst    ! Physical constants
427                            CALL     eos_init   ! Equation of state
[4245]428      IF( lk_c1d        )   CALL     c1d_init   ! 1D column configuration
[2027]429                            CALL     dom_cfg    ! Domain configuration
430                            CALL     dom_init   ! Domain
[413]431
[3294]432      IF( ln_nnogather )    CALL nemo_northcomms   ! Initialise the northfold neighbour lists (must be done after the masks are defined)
433
[2027]434      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
435
[3651]436                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
437
[4292]438      IF( lk_tide       )   CALL    tide_init( nit000 )    ! Initialisation of the tidal harmonics
[3651]439
[5123]440                            CALL     sbc_init   ! Forcings : surface module (clem: moved here for bdy purpose)
441
[4990]442      IF( lk_bdy        )   CALL     bdy_init   ! Open boundaries initialisation
443      IF( lk_bdy        )   CALL bdy_dta_init   ! Open boundaries initialisation of external data arrays
[4292]444      IF( lk_bdy .AND. lk_tide )   &
[4990]445         &                  CALL bdytide_init   ! Open boundaries initialisation of tidal harmonic forcing
[2027]446
[3294]447                            CALL dyn_nept_init  ! simplified form of Neptune effect
[4152]448      !     
449      IF( ln_crs        )   CALL     crs_init   ! Domain initialization of coarsened grid
450      !
451                                ! Ocean physics
[2082]452      !                                         ! Vertical physics
453                            CALL     zdf_init      ! namelist read
454                            CALL zdf_bfr_init      ! bottom friction
455      IF( lk_zdfric     )   CALL zdf_ric_init      ! Richardson number dependent Kz
[2329]456      IF( lk_zdftke     )   CALL zdf_tke_init      ! TKE closure scheme
457      IF( lk_zdfgls     )   CALL zdf_gls_init      ! GLS closure scheme
458      IF( lk_zdfkpp     )   CALL zdf_kpp_init      ! KPP closure scheme
[2082]459      IF( lk_zdftmx     )   CALL zdf_tmx_init      ! tidal vertical mixing
[3764]460      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
[2082]461         &                  CALL zdf_ddm_init      ! double diffusive mixing
462      !                                         ! Lateral physics
463                            CALL ldf_tra_init      ! Lateral ocean tracer physics
464                            CALL ldf_dyn_init      ! Lateral ocean momentum physics
[2392]465      IF( lk_ldfslp     )   CALL ldf_slp_init      ! slope of lateral mixing
[2082]466
[2027]467      !                                     ! Active tracers
468                            CALL tra_qsr_init   ! penetrative solar radiation qsr
[2325]469                            CALL tra_bbc_init   ! bottom heat flux
[2027]470      IF( lk_trabbl     )   CALL tra_bbl_init   ! advective (and/or diffusive) bottom boundary layer scheme
[4245]471                            CALL tra_dmp_init   ! internal damping trends- tracers
[2027]472                            CALL tra_adv_init   ! horizontal & vertical advection
473                            CALL tra_ldf_init   ! lateral mixing
474                            CALL tra_zdf_init   ! vertical mixing and after tracer fields
475
476      !                                     ! Dynamics
[4245]477      IF( lk_c1d        )   CALL dyn_dmp_init   ! internal damping trends- momentum
[2027]478                            CALL dyn_adv_init   ! advection (vector or flux form)
[2104]479                            CALL dyn_vor_init   ! vorticity term including Coriolis
[2027]480                            CALL dyn_ldf_init   ! lateral mixing
[2104]481                            CALL dyn_hpg_init   ! horizontal gradient of Hydrostatic pressure
[2027]482                            CALL dyn_zdf_init   ! vertical diffusion
483                            CALL dyn_spg_init   ! surface pressure gradient
[3764]484
[2392]485      !                                     ! Misc. options
[4147]486      IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 )   CALL cla_init       ! Cross Land Advection
[3609]487                            CALL icb_init( rdt, nit000)   ! initialise icebergs instance
[5329]488                            CALL sto_par_init   ! Stochastic parametrization
489      IF( ln_sto_eos     )  CALL sto_pts_init   ! RRandom T/S fluctuations
[4147]490     
[1594]491#if defined key_top
[2027]492      !                                     ! Passive tracers
[2082]493                            CALL     trc_init
[1594]494#endif
[4990]495      !                                     ! Diagnostics
[3294]496      IF( lk_floats     )   CALL     flo_init   ! drifting Floats
[2027]497                            CALL dia_ptr_init   ! Poleward TRansports initialization
[3294]498      IF( lk_diadct     )   CALL dia_dct_init   ! Sections tranports
[2148]499                            CALL dia_hsb_init   ! heat content, salt content and volume budgets
[4990]500                            CALL     trd_init   ! Mixed-layer/Vorticity/Integral constraints trends
[15690]501                            CALL stopack_init   ! STOPACK scheme                           
[15603]502                            CALL    bias_init   ! Pressure correction bias
[2392]503      IF( lk_diaobs     ) THEN                  ! Observation & model comparison
[2382]504                            CALL dia_obs_init            ! Initialize observational data
505                            CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
[3764]506      ENDIF
[4990]507
[2382]508      !                                     ! Assimilation increments
[2392]509      IF( lk_asminc     )   CALL asm_inc_init   ! Initialize assimilation increments
[2382]510      IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
[12555]511      IF(lwp .AND. lflush) CALL flush(numout)
[8280]512     
513      IF (nstop > 0) THEN
514        CALL CTL_STOP('STOP','Critical errors in NEMO initialisation')
515      END IF
516
[1593]517      !
[2496]518   END SUBROUTINE nemo_init
[467]519
520
[2496]521   SUBROUTINE nemo_ctl
[467]522      !!----------------------------------------------------------------------
[2496]523      !!                     ***  ROUTINE nemo_ctl  ***
[467]524      !!
[3764]525      !! ** Purpose :   control print setting
[467]526      !!
[2442]527      !! ** Method  : - print namctl information and check some consistencies
[467]528      !!----------------------------------------------------------------------
[2442]529      !
[2496]530      IF(lwp) THEN                  ! control print
[531]531         WRITE(numout,*)
[2496]532         WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
[531]533         WRITE(numout,*) '~~~~~~~ '
[1593]534         WRITE(numout,*) '   Namelist namctl'
[1601]535         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
[12555]536         WRITE(numout,*) '       finer control over o/p sn_cfctl%l_config  = ', sn_cfctl%l_config
537         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
538         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
539         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
[13070]540         WRITE(numout,*) '                              sn_cfctl%l_sbcisf  = ', sn_cfctl%l_sbcisf
[12555]541         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
542         WRITE(numout,*) '                              sn_cfctl%l_mppout  = ', sn_cfctl%l_mppout
543         WRITE(numout,*) '                              sn_cfctl%l_mpptop  = ', sn_cfctl%l_mpptop
544         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin 
545         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax 
546         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr 
547         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr 
[1601]548         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
[12555]549         WRITE(numout,*) '      flush numout/stat               ln_flush   = ', ln_flush
[1601]550         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
551         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
552         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
553         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
554         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
555         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
556         WRITE(numout,*) '      benchmark parameter (0/1)       nn_bench   = ', nn_bench
[3610]557         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
[12555]558         IF(lflush) CALL flush(numout)
[531]559      ENDIF
[2442]560      !
[1601]561      nictls    = nn_ictls
562      nictle    = nn_ictle
563      njctls    = nn_jctls
564      njctle    = nn_jctle
565      isplt     = nn_isplt
566      jsplt     = nn_jsplt
567      nbench    = nn_bench
[4147]568
569      IF(lwp) THEN                  ! control print
570         WRITE(numout,*)
571         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
572         WRITE(numout,*) '~~~~~~~ '
573         WRITE(numout,*) '   Namelist namcfg'
574         WRITE(numout,*) '      configuration name              cp_cfg      = ', TRIM(cp_cfg)
575         WRITE(numout,*) '      configuration zoom name         cp_cfz      = ', TRIM(cp_cfz)
576         WRITE(numout,*) '      configuration resolution        jp_cfg      = ', jp_cfg
577         WRITE(numout,*) '      1st lateral dimension ( >= jpi ) jpidta     = ', jpidta
578         WRITE(numout,*) '      2nd    "         "    ( >= jpj ) jpjdta     = ', jpjdta
579         WRITE(numout,*) '      3nd    "         "               jpkdta     = ', jpkdta
580         WRITE(numout,*) '      1st dimension of global domain in i jpiglo  = ', jpiglo
581         WRITE(numout,*) '      2nd    -                  -    in j jpjglo  = ', jpjglo
582         WRITE(numout,*) '      left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom
583         WRITE(numout,*) '      left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom
584         WRITE(numout,*) '      lateral cond. type (between 0 and 6) jperio = ', jperio   
[5118]585         WRITE(numout,*) '      use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[12555]586         IF(lflush) CALL flush(numout)
[4147]587      ENDIF
[2442]588      !                             ! Parameter control
[1593]589      !
590      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
[3294]591         IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]592            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
[531]593         ELSE
594            IF( isplt == 1 .AND. jsplt == 1  ) THEN
[1593]595               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
596                  &           ' - the print control will be done over the whole domain' )
[531]597            ENDIF
[1593]598            ijsplt = isplt * jsplt            ! total number of processors ijsplt
[531]599         ENDIF
600         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
601         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
[12555]602         IF(lwp .AND. lflush) CALL flush(numout)
[1593]603         !
604         !                              ! indices used for the SUM control
605         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
[3764]606            lsp_area = .FALSE.
[1593]607         ELSE                                             ! print control done over a specific  area
[531]608            lsp_area = .TRUE.
609            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
610               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
611               nictls = 1
612            ENDIF
613            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
614               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
615               nictle = jpiglo
616            ENDIF
617            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
618               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
619               njctls = 1
620            ENDIF
621            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
622               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
623               njctle = jpjglo
624            ENDIF
[1593]625         ENDIF
626      ENDIF
[2442]627      !
[3764]628      IF( nbench == 1 ) THEN              ! Benchmark
[531]629         SELECT CASE ( cp_cfg )
[1593]630         CASE ( 'gyre' )   ;   CALL ctl_warn( ' The Benchmark is activated ' )
631         CASE DEFAULT      ;   CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:',   &
[4147]632            &                                 ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' )
[531]633         END SELECT
634      ENDIF
[1593]635      !
[3764]636      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
637         &                                               'f2003 standard. '                              ,  &
638         &                                               'Compile with key_nosignedzero enabled' )
639      !
[2496]640   END SUBROUTINE nemo_ctl
[467]641
642
[2496]643   SUBROUTINE nemo_closefile
[467]644      !!----------------------------------------------------------------------
[2496]645      !!                     ***  ROUTINE nemo_closefile  ***
[467]646      !!
647      !! ** Purpose :   Close the files
648      !!----------------------------------------------------------------------
[1593]649      !
650      IF( lk_mpp )   CALL mppsync
651      !
[1685]652      CALL iom_close                                 ! close all input/output files managed by iom_*
[1593]653      !
[4147]654      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
655      IF( numsol          /= -1 )   CLOSE( numsol          )   ! solver file
656      IF( numnam_ref      /= -1 )   CLOSE( numnam_ref      )   ! oce reference namelist
657      IF( numnam_cfg      /= -1 )   CLOSE( numnam_cfg      )   ! oce configuration namelist
[4624]658      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
[4147]659      IF( numnam_ice_ref  /= -1 )   CLOSE( numnam_ice_ref  )   ! ice reference namelist
660      IF( numnam_ice_cfg  /= -1 )   CLOSE( numnam_ice_cfg  )   ! ice configuration namelist
[4624]661      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
[4147]662      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
663      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
664      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
665      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
666      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
[8280]667#if defined key_top
668      IF( numstr          /= -1 )   CLOSE( numstr          )   ! tracer statistics
669#endif
[1593]670      !
[2442]671      numout = 6                                     ! redefine numout in case it is used after this point...
672      !
[2496]673   END SUBROUTINE nemo_closefile
[467]674
[2715]675
676   SUBROUTINE nemo_alloc
677      !!----------------------------------------------------------------------
678      !!                     ***  ROUTINE nemo_alloc  ***
679      !!
680      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
681      !!
682      !! ** Method  :
683      !!----------------------------------------------------------------------
684      USE diawri    , ONLY: dia_wri_alloc
[8400]685      USE insitu_tem, ONLY: insitu_tem_alloc
[2715]686      USE dom_oce   , ONLY: dom_oce_alloc
687      USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc
688      USE ldftra_oce, ONLY: ldftra_oce_alloc
689      USE trc_oce   , ONLY: trc_oce_alloc
[3680]690#if defined key_diadct 
691      USE diadct    , ONLY: diadct_alloc 
692#endif 
[4354]693#if defined key_bdy
694      USE bdy_oce   , ONLY: bdy_oce_alloc
695#endif
[2715]696      !
697      INTEGER :: ierr
698      !!----------------------------------------------------------------------
699      !
[3764]700      ierr =        oce_alloc       ()          ! ocean
[2715]701      ierr = ierr + dia_wri_alloc   ()
[8400]702      ierr = ierr + insitu_tem_alloc()
[2715]703      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
704      ierr = ierr + ldfdyn_oce_alloc()          ! ocean lateral  physics : dynamics
705      ierr = ierr + ldftra_oce_alloc()          ! ocean lateral  physics : tracers
706      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
707      !
708      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
709      !
[3680]710#if defined key_diadct 
711      ierr = ierr + diadct_alloc    ()          !
712#endif 
[4354]713#if defined key_bdy
714      ierr = ierr + bdy_oce_alloc   ()          ! bdy masks (incl. initialization)
715#endif
[3680]716      !
[2715]717      IF( lk_mpp    )   CALL mpp_sum( ierr )
718      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
719      !
720   END SUBROUTINE nemo_alloc
721
[12555]722   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
723      !!----------------------------------------------------------------------
724      !!                     ***  ROUTINE nemo_set_cfctl  ***
725      !!
726      !! ** Purpose :   Set elements of the output control structure to setto.
727      !!                for_all should be .false. unless all areas are to be
728      !!                treated identically.
729      !!
730      !! ** Method  :   Note this routine can be used to switch on/off some
731      !!                types of output for selected areas but any output types
732      !!                that involve global communications (e.g. mpp_max, glob_sum)
733      !!                should be protected from selective switching by the
734      !!                for_all argument
735      !!----------------------------------------------------------------------
736      LOGICAL :: setto, for_all
737      TYPE(sn_ctl) :: sn_cfctl
738      !!----------------------------------------------------------------------
739      IF( for_all ) THEN
740         sn_cfctl%l_runstat = setto
741         sn_cfctl%l_trcstat = setto
742      ENDIF
[13070]743      sn_cfctl%l_sbcisf  = setto
[12555]744      sn_cfctl%l_oceout  = setto
745      sn_cfctl%l_layout  = setto
746      sn_cfctl%l_mppout  = setto
747      sn_cfctl%l_mpptop  = setto
748   END SUBROUTINE nemo_set_cfctl
[2715]749
750   SUBROUTINE nemo_partition( num_pes )
751      !!----------------------------------------------------------------------
752      !!                 ***  ROUTINE nemo_partition  ***
753      !!
[3764]754      !! ** Purpose :
[2715]755      !!
756      !! ** Method  :
757      !!----------------------------------------------------------------------
[4990]758      INTEGER, INTENT(in) ::   num_pes   ! The number of MPI processes we have
[2715]759      !
760      INTEGER, PARAMETER :: nfactmax = 20
761      INTEGER :: nfact ! The no. of factors returned
762      INTEGER :: ierr  ! Error flag
763      INTEGER :: ji
764      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
765      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
766      !!----------------------------------------------------------------------
[4990]767      !
[2715]768      ierr = 0
[4990]769      !
[2715]770      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
[4990]771      !
[2715]772      IF( nfact <= 1 ) THEN
773         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
774         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
[12555]775         IF(lflush) CALL flush(numout)
[2715]776         jpnj = 1
777         jpni = num_pes
778      ELSE
779         ! Search through factors for the pair that are closest in value
780         mindiff = 1000000
781         imin    = 1
782         DO ji = 1, nfact-1, 2
783            idiff = ABS( ifact(ji) - ifact(ji+1) )
784            IF( idiff < mindiff ) THEN
785               mindiff = idiff
786               imin = ji
787            ENDIF
788         END DO
789         jpnj = ifact(imin)
790         jpni = ifact(imin + 1)
791      ENDIF
792      !
793      jpnij = jpni*jpnj
794      !
795   END SUBROUTINE nemo_partition
796
797
798   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
799      !!----------------------------------------------------------------------
800      !!                     ***  ROUTINE factorise  ***
801      !!
802      !! ** Purpose :   return the prime factors of n.
[3764]803      !!                knfax factors are returned in array kfax which is of
[2715]804      !!                maximum dimension kmaxfax.
805      !! ** Method  :
806      !!----------------------------------------------------------------------
807      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
808      INTEGER                    , INTENT(  out) ::   kerr, knfax
809      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
810      !
811      INTEGER :: ifac, jl, inu
812      INTEGER, PARAMETER :: ntest = 14
[6487]813      INTEGER, DIMENSION(ntest) :: ilfax
[4990]814      !
[6487]815      ! ilfax contains the set of allowed factors.
816      ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
[2715]817      !!----------------------------------------------------------------------
[6487]818      ! ilfax contains the set of allowed factors.
819      ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
[2715]820
821      ! Clear the error flag and initialise output vars
822      kerr = 0
823      kfax = 1
824      knfax = 0
825
826      ! Find the factors of n.
827      IF( kn == 1 )   GOTO 20
828
829      ! nu holds the unfactorised part of the number.
830      ! knfax holds the number of factors found.
831      ! l points to the allowed factor list.
832      ! ifac holds the current factor.
833
834      inu   = kn
835      knfax = 0
836
837      DO jl = ntest, 1, -1
838         !
839         ifac = ilfax(jl)
840         IF( ifac > inu )   CYCLE
841
842         ! Test whether the factor will divide.
843
844         IF( MOD(inu,ifac) == 0 ) THEN
845            !
846            knfax = knfax + 1            ! Add the factor to the list
847            IF( knfax > kmaxfax ) THEN
848               kerr = 6
849               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
850               return
851            ENDIF
852            kfax(knfax) = ifac
853            ! Store the other factor that goes with this one
854            knfax = knfax + 1
855            kfax(knfax) = inu / ifac
856            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
857         ENDIF
858         !
859      END DO
860
861   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
862      !
863   END SUBROUTINE factorise
864
[3294]865#if defined key_mpp_mpi
[4990]866
[3294]867   SUBROUTINE nemo_northcomms
868      !!======================================================================
869      !!                     ***  ROUTINE  nemo_northcomms  ***
[4230]870      !! nemo_northcomms    :  Setup for north fold exchanges with explicit
871      !!                       point-to-point messaging
[3294]872      !!=====================================================================
873      !!----------------------------------------------------------------------
[3764]874      !!
[3294]875      !! ** Purpose :   Initialization of the northern neighbours lists.
876      !!----------------------------------------------------------------------
[3764]877      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
[4230]878      !!    2.0  ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
[3294]879      !!----------------------------------------------------------------------
880
[4230]881      INTEGER  ::   sxM, dxM, sxT, dxT, jn
882      INTEGER  ::   njmppmax
[3294]883
[4230]884      njmppmax = MAXVAL( njmppt )
885   
886      !initializes the north-fold communication variables
887      isendto(:) = 0
[3294]888      nsndto = 0
889
[4230]890      !if I am a process in the north
891      IF ( njmpp == njmppmax ) THEN
892          !sxM is the first point (in the global domain) needed to compute the
893          !north-fold for the current process
894          sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
895          !dxM is the last point (in the global domain) needed to compute the
896          !north-fold for the current process
897          dxM = jpiglo - nimppt(narea) + 2
[3294]898
[4230]899          !loop over the other north-fold processes to find the processes
900          !managing the points belonging to the sxT-dxT range
[4671]901 
902          DO jn = 1, jpni
[4230]903                !sxT is the first point (in the global domain) of the jn
904                !process
[4671]905                sxT = nfiimpp(jn, jpnj)
[4230]906                !dxT is the last point (in the global domain) of the jn
907                !process
[4671]908                dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
[4230]909                IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
910                   nsndto = nsndto + 1
[4671]911                     isendto(nsndto) = jn
[4645]912                ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
[4230]913                   nsndto = nsndto + 1
[4671]914                     isendto(nsndto) = jn
[4230]915                ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
916                   nsndto = nsndto + 1
[4671]917                     isendto(nsndto) = jn
[4230]918                END IF
919          END DO
[4671]920          nfsloop = 1
921          nfeloop = nlci
922          DO jn = 2,jpni-1
923           IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
924              IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
925                 nfsloop = nldi
926              ENDIF
927              IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
928                 nfeloop = nlei
929              ENDIF
930           ENDIF
931        END DO
932
[3294]933      ENDIF
[4230]934      l_north_nogather = .TRUE.
[3294]935   END SUBROUTINE nemo_northcomms
936#else
937   SUBROUTINE nemo_northcomms      ! Dummy routine
938      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
939   END SUBROUTINE nemo_northcomms
940#endif
[4990]941
[3]942   !!======================================================================
[2496]943END MODULE nemogcm
[4354]944
945
Note: See TracBrowser for help on using the repository browser.