source: branches/2017/dev_r8126_ROBUST08_no_ghost/NEMOGCM/NEMO/SAO_SRC/nemogcm.F90 @ 8314

Last change on this file since 8314 was 8314, checked in by acc, 3 years ago

Branch 2017/dev_r8126_ROBUST08_no_ghost. Merge in changes from branches/2017/dev_r8126_ROBUST10_MPPINI to combine mppini and mppini_2 functionalities into a single routine. SETTE-like test performed with ORCA2LIMPISCES using an 8x8 partition with 60 processors to confirm consistency of results when using land suppression. The dev_r8126_ROBUST10_MPPINI branch will not be needed in the 2017 merge if dev_r8126_ROBUST08_no_ghost is included.

  • Property svn:keywords set to Id
File size: 27.0 KB
Line 
1MODULE nemogcm
2   !!======================================================================
3   !!                       ***  MODULE nemogcm   ***
4   !! Ocean system   : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
5   !!======================================================================
6   !! History :  3.6  ! 2015-12  (A. Ryan) Original code   (from OPA_SRC/)
7   !!            4.0  ! 2016-11  (G. Madec, S. Flavoni)  domain configuration / user defined interface
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
12   !!   nemo_init     : initialization of the NEMO system
13   !!   nemo_ctl      : initialisation of the contol print
14   !!   nemo_closefile: close remaining open files
15   !!   nemo_alloc    : dynamical allocation
16   !!   nemo_partition: calculate MPP domain decomposition
17   !!   factorise     : calculate the factors of the no. of MPI processes
18   !!----------------------------------------------------------------------
19   USE step_oce       ! module used in the ocean time stepping module (step.F90)
20   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
21   USE istate         ! initial state setting          (istate_init routine)
22   USE phycst         ! physical constant                  (par_cst routine)
23   USE step           ! NEMO time-stepping                 (stp     routine)
24   USE cpl_oasis3     ! OASIS3 coupling
25   USE diaobs         ! Observation diagnostics       (dia_obs_init routine)
26#if defined key_nemocice_decomp
27   USE ice_domain_size, only: nx_global, ny_global
28#endif
29   !           ! Stand Alone Observation operator modules
30   USE sao_data
31   USE sao_intp
32   !
33   USE lib_mpp        ! distributed memory computing
34   USE mppini         ! shared/distributed memory setting (mpp_init routine)
35   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
36   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
37#if defined key_iomput
38   USE xios           ! xIOserver
39#endif
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   nemo_gcm    ! called by model.F90
45   PUBLIC   nemo_init   ! needed by AGRIF
46   PUBLIC   nemo_alloc  ! needed by TAM
47
48   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
49
50   !!----------------------------------------------------------------------
51   !! NEMO/OPA 4.0 , NEMO Consortium (2016)
52   !! $Id$
53   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
54   !!----------------------------------------------------------------------
55CONTAINS
56
57   SUBROUTINE nemo_gcm
58         !!----------------------------------------------------------------------
59         !!                    ***  SUBROUTINE offline_obs_oper ***
60         !!
61         !! ** Purpose : To use NEMO components to interpolate model fields
62         !!              to observation space.
63         !!
64         !! ** Method : 1. Initialise NEMO
65         !!             2. Initialise offline obs_oper
66         !!             3. Cycle through match ups
67         !!             4. Write results to file
68         !!----------------------------------------------------------------------
69         !
70         CALL nemo_init       ! Initialise NEMO
71         !
72         CALL sao_data_init   ! Initialise Stand Alone Observation operator data
73         !
74         CALL dia_obs_init    ! Initialise obs_operator
75         !
76         CALL sao_interp      ! Interpolate to observation space
77         !
78         CALL dia_obs_wri     ! Pipe to output files
79         !
80         CALL dia_obs_dealloc ! Reset the obs_oper between
81         !
82         IF(lk_mpp)   CALL mppstop  ! Safely stop MPI (end mpp communications)
83         !
84   END SUBROUTINE nemo_gcm
85
86
87   SUBROUTINE nemo_init
88      !!----------------------------------------------------------------------
89      !!                     ***  ROUTINE nemo_init  ***
90      !!
91      !! ** Purpose :   initialization of the NEMO GCM
92      !!----------------------------------------------------------------------
93      INTEGER ::   ji                 ! dummy loop indices
94      INTEGER ::   ios, ilocal_comm   ! local integer
95      CHARACTER(len=120), DIMENSION(30) ::   cltxt, cltxt2, clnam
96      !
97      NAMELIST/namctl/ ln_ctl   , nn_print, nn_ictls, nn_ictle,   &
98         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,   &
99         &             nn_timing, nn_diacfl
100      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_write_cfg, cn_domcfg_out, ln_use_jattr
101      !!----------------------------------------------------------------------
102      !
103      cltxt  = ''
104      cltxt2 = ''
105      clnam  = '' 
106      cxios_context = 'nemo'
107      !
108      !                             ! Open reference namelist and configuration namelist files
109      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
110      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
111      !
112      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints
113      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
114901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
115      !
116      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist
117      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
118902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
119      !
120      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist : Control prints
121      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
122903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
123
124      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist : Control prints & Benchmark
125      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
126904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
127
128      !                             !--------------------------!
129      !                             !  Set global domain size  !   (control print return in cltxt2)
130      !                             !--------------------------!
131      IF( ln_read_cfg ) THEN              ! Read sizes in domain configuration file
132         CALL domain_cfg ( cltxt2,        cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
133         !
134      ELSE                                ! user-defined namelist
135         CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
136      ENDIF
137      !
138      jpk = jpkglo
139      !
140#if defined key_agrif
141      IF( .NOT. Agrif_Root() ) THEN       ! AGRIF children: specific setting (cf. agrif_user.F90)
142         jpiglo  = nbcellsx + 2 + 2*nbghostcells
143         jpjglo  = nbcellsy + 2 + 2*nbghostcells
144         jpi     = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci
145         jpj     = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj
146         nperio  = 0
147         jperio  = 0
148         ln_use_jattr = .false.
149      ENDIF
150#endif
151      !
152      !                             !--------------------------------------------!
153      !                             !  set communicator & select the local node  !
154      !                             !  NB: mynode also opens output.namelist.dyn !
155      !                             !      on unit number numond on first proc   !
156      !                             !--------------------------------------------!
157#if defined key_iomput
158      IF( Agrif_Root() ) THEN
159         IF( lk_oasis ) THEN
160            CALL cpl_init( "oceanx", ilocal_comm )                     ! nemo local communicator given by oasis
161            CALL xios_initialize( "not used",local_comm=ilocal_comm )    ! send nemo communicator to xios
162         ELSE
163            CALL  xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )    ! nemo local communicator given by xios
164         ENDIF
165      ENDIF
166      ! Nodes selection (control print return in cltxt)
167      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
168#else
169      IF( lk_oasis ) THEN
170         IF( Agrif_Root() ) THEN
171            CALL cpl_init( "oceanx", ilocal_comm )                      ! nemo local communicator given by oasis
172         ENDIF
173         ! Nodes selection (control print return in cltxt)
174         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
175      ELSE
176         ilocal_comm = 0
177         ! Nodes selection (control print return in cltxt)
178         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
179      ENDIF
180#endif
181
182      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
183
184      lwm = (narea == 1)                                    ! control of output namelists
185      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
186
187      IF(lwm) THEN
188         ! write merged namelists from earlier to output namelist now that the
189         ! file has been opened in call to mynode. nammpp has already been
190         ! written in mynode (if lk_mpp_mpi)
191         WRITE( numond, namctl )
192         WRITE( numond, namcfg )
193         IF( .NOT.ln_read_cfg ) THEN
194            DO ji = 1, SIZE(clnam)
195               IF( TRIM(clnam(ji)) /= '' )   WRITE(numond, * ) clnam(ji)     ! namusr_def print
196            END DO
197         ENDIF
198      ENDIF
199
200      ! If dimensions of processor grid weren't specified in the namelist file
201      ! then we calculate them here now that we have our communicator size
202      IF( jpni < 1 .OR. jpnj < 1 ) THEN
203#if   defined key_mpp_mpi
204         IF( Agrif_Root() )   CALL nemo_partition( mppsize )
205#else
206         jpni  = 1
207         jpnj  = 1
208         jpnij = jpni*jpnj
209#endif
210      ENDIF
211
212      IF( Agrif_Root() ) THEN       ! AGRIF mother: specific setting from jpni and jpnj
213#if defined key_nemocice_decomp
214         jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci    ! first  dim.
215         jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj    ! second dim.
216#else
217         jpi = ( jpiglo     -2*jpreci + (jpni-1) ) / jpni + 2*jpreci    ! first  dim.
218         jpj = ( jpjglo     -2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj    ! second dim.
219#endif
220      ENDIF
221
222!!gm ???    why here  it has already been done in line 301 !
223      jpk = jpkglo                                             ! third dim
224!!gm end
225      jpim1 = jpi-1                                            ! inner domain indices
226      jpjm1 = jpj-1                                            !   "           "
227      jpkm1 = jpk-1                                            !   "           "
228      jpij  = jpi*jpj                                          !  jpi x j
229
230      IF(lwp) THEN                            ! open listing units
231         !
232         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
233         !
234         WRITE(numout,*)
235         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
236         WRITE(numout,*) '                       NEMO team'
237         WRITE(numout,*) '            Stand Alone Observation operator'
238         WRITE(numout,*) '                NEMO version 3.7  (2015) '
239         WRITE(numout,*)
240         WRITE(numout,*)
241         DO ji = 1, SIZE(cltxt)
242            IF( TRIM(cltxt (ji)) /= '' )   WRITE(numout,*) cltxt(ji)    ! control print of mynode
243         END DO
244         WRITE(numout,*)
245         WRITE(numout,*)
246         DO ji = 1, SIZE(cltxt2)
247            IF( TRIM(cltxt2(ji)) /= '' )   WRITE(numout,*) cltxt2(ji)   ! control print of domain size
248         END DO
249         !
250         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
251         !
252      ENDIF
253
254      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
255      CALL nemo_alloc()
256
257      !                             !-------------------------------!
258      !                             !  NEMO general initialization  !
259      !                             !-------------------------------!
260
261      CALL nemo_ctl                          ! Control prints & Benchmark
262
263      !                                      ! Domain decomposition
264      CALL mpp_init
265      !
266      IF( nn_timing == 1 )  CALL timing_init
267      !
268      !                                      ! General initialization
269                            CALL     phy_cst    ! Physical constants
270                            CALL     eos_init   ! Equation of state
271                            CALL     dom_init   ! Domain
272
273      IF( ln_nnogather )    CALL nemo_northcomms   ! Initialise the northfold neighbour lists (must be done after the masks are defined)
274
275      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
276
277                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
278   END SUBROUTINE nemo_init
279
280
281   SUBROUTINE nemo_ctl
282      !!----------------------------------------------------------------------
283      !!                     ***  ROUTINE nemo_ctl  ***
284      !!
285      !! ** Purpose :   control print setting
286      !!
287      !! ** Method  : - print namctl information and check some consistencies
288      !!----------------------------------------------------------------------
289      !
290      IF(lwp) THEN                  ! control print
291         WRITE(numout,*)
292         WRITE(numout,*) 'nemo_ctl: Control prints'
293         WRITE(numout,*) '~~~~~~~ '
294         WRITE(numout,*) '   Namelist namctl'
295         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
296         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
297         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
298         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
299         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
300         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
301         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
302         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
303         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
304      ENDIF
305      !
306      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
307      nictls    = nn_ictls
308      nictle    = nn_ictle
309      njctls    = nn_jctls
310      njctle    = nn_jctle
311      isplt     = nn_isplt
312      jsplt     = nn_jsplt
313
314      IF(lwp) THEN                  ! control print
315         WRITE(numout,*)
316         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
317         WRITE(numout,*) '~~~~~~~ '
318         WRITE(numout,*) '   Namelist namcfg'
319         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
320         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
321         WRITE(numout,*) '      write configuration definition file           ln_write_cfg     = ', ln_write_cfg
322         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
323         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
324      ENDIF
325      !                             ! Parameter control
326      !
327      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
328         IF( lk_mpp .AND. jpnij > 1 ) THEN
329            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
330         ELSE
331            IF( isplt == 1 .AND. jsplt == 1  ) THEN
332               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
333                  &           ' - the print control will be done over the whole domain' )
334            ENDIF
335            ijsplt = isplt * jsplt            ! total number of processors ijsplt
336         ENDIF
337         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
338         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
339         !
340         !                              ! indices used for the SUM control
341         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
342            lsp_area = .FALSE.
343         ELSE                                             ! print control done over a specific  area
344            lsp_area = .TRUE.
345            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
346               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
347               nictls = 1
348            ENDIF
349            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
350               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
351               nictle = jpiglo
352            ENDIF
353            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
354               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
355               njctls = 1
356            ENDIF
357            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
358               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
359               njctle = jpjglo
360            ENDIF
361         ENDIF
362      ENDIF
363      !
364      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
365         &                                               'f2003 standard. '                              ,  &
366         &                                               'Compile with key_nosignedzero enabled' )
367      !
368   END SUBROUTINE nemo_ctl
369
370
371   SUBROUTINE nemo_closefile
372      !!----------------------------------------------------------------------
373      !!                     ***  ROUTINE nemo_closefile  ***
374      !!
375      !! ** Purpose :   Close the files
376      !!----------------------------------------------------------------------
377      !
378      IF( lk_mpp )   CALL mppsync
379      !
380      CALL iom_close                                 ! close all input/output files managed by iom_*
381      !
382      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
383      IF( numsol          /= -1 )   CLOSE( numsol          )   ! solver file
384      IF( numnam_ref      /= -1 )   CLOSE( numnam_ref      )   ! oce reference namelist
385      IF( numnam_cfg      /= -1 )   CLOSE( numnam_cfg      )   ! oce configuration namelist
386      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
387      IF( numnam_ice_ref  /= -1 )   CLOSE( numnam_ice_ref  )   ! ice reference namelist
388      IF( numnam_ice_cfg  /= -1 )   CLOSE( numnam_ice_cfg  )   ! ice configuration namelist
389      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
390      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
391      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
392      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
393      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
394      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
395      !
396      numout = 6                                     ! redefine numout in case it is used after this point...
397      !
398   END SUBROUTINE nemo_closefile
399
400
401   SUBROUTINE nemo_alloc
402      !!----------------------------------------------------------------------
403      !!                     ***  ROUTINE nemo_alloc  ***
404      !!
405      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
406      !!
407      !! ** Method  :
408      !!----------------------------------------------------------------------
409      USE diawri    , ONLY: dia_wri_alloc
410      USE dom_oce   , ONLY: dom_oce_alloc
411      !
412      INTEGER :: ierr
413      !!----------------------------------------------------------------------
414      !
415      ierr =        oce_alloc       ()          ! ocean
416      ierr = ierr + dia_wri_alloc   ()
417      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
418      !
419      IF( lk_mpp    )   CALL mpp_sum( ierr )
420      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
421      !
422   END SUBROUTINE nemo_alloc
423
424
425   SUBROUTINE nemo_partition( num_pes )
426      !!----------------------------------------------------------------------
427      !!                 ***  ROUTINE nemo_partition  ***
428      !!
429      !! ** Purpose :
430      !!
431      !! ** Method  :
432      !!----------------------------------------------------------------------
433      INTEGER, INTENT(in) ::   num_pes   ! The number of MPI processes we have
434      !
435      INTEGER, PARAMETER :: nfactmax = 20
436      INTEGER :: nfact ! The no. of factors returned
437      INTEGER :: ierr  ! Error flag
438      INTEGER :: ji
439      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
440      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
441      !!----------------------------------------------------------------------
442      !
443      ierr = 0
444      !
445      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
446      !
447      IF( nfact <= 1 ) THEN
448         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
449         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
450         jpnj = 1
451         jpni = num_pes
452      ELSE
453         ! Search through factors for the pair that are closest in value
454         mindiff = 1000000
455         imin    = 1
456         DO ji = 1, nfact-1, 2
457            idiff = ABS( ifact(ji) - ifact(ji+1) )
458            IF( idiff < mindiff ) THEN
459               mindiff = idiff
460               imin = ji
461            ENDIF
462         END DO
463         jpnj = ifact(imin)
464         jpni = ifact(imin + 1)
465      ENDIF
466      !
467      jpnij = jpni*jpnj
468      !
469   END SUBROUTINE nemo_partition
470
471
472   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
473      !!----------------------------------------------------------------------
474      !!                     ***  ROUTINE factorise  ***
475      !!
476      !! ** Purpose :   return the prime factors of n.
477      !!                knfax factors are returned in array kfax which is of
478      !!                maximum dimension kmaxfax.
479      !! ** Method  :
480      !!----------------------------------------------------------------------
481      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
482      INTEGER                    , INTENT(  out) ::   kerr, knfax
483      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
484      !
485      INTEGER :: ifac, jl, inu
486      INTEGER, PARAMETER :: ntest = 14
487      INTEGER, DIMENSION(ntest) ::   ilfax
488      !!----------------------------------------------------------------------
489      !
490      ! lfax contains the set of allowed factors.
491      ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
492      !
493      ! Clear the error flag and initialise output vars
494      kerr  = 0
495      kfax  = 1
496      knfax = 0
497      !
498      ! Find the factors of n.
499      IF( kn == 1 )   GOTO 20
500
501      ! nu holds the unfactorised part of the number.
502      ! knfax holds the number of factors found.
503      ! l points to the allowed factor list.
504      ! ifac holds the current factor.
505      !
506      inu   = kn
507      knfax = 0
508      !
509      DO jl = ntest, 1, -1
510         !
511         ifac = ilfax(jl)
512         IF( ifac > inu )   CYCLE
513
514         ! Test whether the factor will divide.
515
516         IF( MOD(inu,ifac) == 0 ) THEN
517            !
518            knfax = knfax + 1            ! Add the factor to the list
519            IF( knfax > kmaxfax ) THEN
520               kerr = 6
521               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
522               return
523            ENDIF
524            kfax(knfax) = ifac
525            ! Store the other factor that goes with this one
526            knfax = knfax + 1
527            kfax(knfax) = inu / ifac
528            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
529         ENDIF
530         !
531      END DO
532      !
533   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
534      !
535   END SUBROUTINE factorise
536
537#if defined key_mpp_mpi
538
539   SUBROUTINE nemo_northcomms
540      !!----------------------------------------------------------------------
541      !!                     ***  ROUTINE  nemo_northcomms  ***
542      !! ** Purpose :   Setup for north fold exchanges with explicit
543      !!                point-to-point messaging
544      !!
545      !! ** Method :   Initialization of the northern neighbours lists.
546      !!----------------------------------------------------------------------
547      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
548      !!    2.0  ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
549      !!----------------------------------------------------------------------
550      INTEGER  ::   sxM, dxM, sxT, dxT, jn
551      INTEGER  ::   njmppmax
552      !!----------------------------------------------------------------------
553      !
554      njmppmax = MAXVAL( njmppt )
555      !
556      !initializes the north-fold communication variables
557      isendto(:) = 0
558      nsndto     = 0
559      !
560      !if I am a process in the north
561      IF ( njmpp == njmppmax ) THEN
562          !sxM is the first point (in the global domain) needed to compute the
563          !north-fold for the current process
564          sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
565          !dxM is the last point (in the global domain) needed to compute the
566          !north-fold for the current process
567          dxM = jpiglo - nimppt(narea) + 2
568
569          !loop over the other north-fold processes to find the processes
570          !managing the points belonging to the sxT-dxT range
571 
572          DO jn = 1, jpni
573                !sxT is the first point (in the global domain) of the jn
574                !process
575                sxT = nfiimpp(jn, jpnj)
576                !dxT is the last point (in the global domain) of the jn
577                !process
578                dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
579                IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
580                   nsndto = nsndto + 1
581                   isendto(nsndto) = jn
582                ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
583                   nsndto = nsndto + 1
584                   isendto(nsndto) = jn
585                ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
586                   nsndto = nsndto + 1
587                   isendto(nsndto) = jn
588                ENDIF
589          END DO
590          nfsloop = 1
591          nfeloop = nlci
592          DO jn = 2,jpni-1
593           IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
594              IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
595                 nfsloop = nldi
596              ENDIF
597              IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
598                 nfeloop = nlei
599              ENDIF
600           ENDIF
601        END DO
602
603      ENDIF
604      l_north_nogather = .TRUE.
605   END SUBROUTINE nemo_northcomms
606
607#else
608   SUBROUTINE nemo_northcomms      ! Dummy routine
609      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
610   END SUBROUTINE nemo_northcomms
611#endif
612
613   !!======================================================================
614END MODULE nemogcm
615
Note: See TracBrowser for help on using the repository browser.