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/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/TOOLS/DOMAINcfg/src – NEMO

source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/TOOLS/DOMAINcfg/src/nemogcm.f90 @ 6951

Last change on this file since 6951 was 6951, checked in by flavoni, 8 years ago

merge simplif-2 branches (TOOLS and NEMO); update DOMAINcfg TOOL: create domain_cfg.nc files to be used in new version of NEMO, SIMPLIF-2 branch
File size: 27.8 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 :  OPA  ! 1990-10  (C. Levy, G. Madec)  Original code
7   !!            7.0  ! 1991-11  (M. Imbard, C. Levy, G. Madec)
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
10   !!             -   ! 1992-06  (L.Terray)  coupling implementation
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,
13   !!                             P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
14   !!            8.1  ! 1997-06  (M. Imbard, G. Madec)
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
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
27   !!            3.3  ! 2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
28   !!             -   ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
29   !!            3.3.1! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
30   !!            3.4  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE) add nemo_northcomms
31   !!             -   ! 2011-11  (C. Harris) decomposition changes for running with CICE
32   !!            3.6  ! 2012-05  (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
33   !!             -   ! 2013-06  (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication
34   !!             -   ! 2014-12  (G. Madec) remove KPP scheme and cross-land advection (cla)
35   !!----------------------------------------------------------------------
36
37   !!----------------------------------------------------------------------
38   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
39   !!   nemo_init     : initialization of the NEMO system
40   !!   nemo_ctl      : initialisation of the contol print
41   !!   nemo_closefile: close remaining open files
42   !!   nemo_alloc    : dynamical allocation
43   !!   nemo_partition: calculate MPP domain decomposition
44   !!   factorise     : calculate the factors of the no. of MPI processes
45   !!----------------------------------------------------------------------
46   USE step_oce       ! module used in the ocean time stepping module (step.F90)
47   USE domcfg         ! domain configuration               (dom_cfg routine)
48   USE mppini         ! shared/distributed memory setting (mpp_init routine)
49   USE domain         ! domain initialization             (dom_init routine)
50   USE phycst         ! physical constant                  (par_cst routine)
51   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
52   USE lib_mpp        ! distributed memory computing
53
54   USE xios           ! xIOserver
55
56   USE lbcnfd , ONLY  : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
57
58   IMPLICIT NONE
59   PRIVATE
60
61   PUBLIC   nemo_gcm    ! called by model.F90
62   PUBLIC   nemo_init   ! needed by AGRIF
63   PUBLIC   nemo_alloc  ! needed by TAM
64
65   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
66
67   !!----------------------------------------------------------------------
68   !! NEMO/OPA 3.7 , NEMO Consortium (2015)
69   !! $Id: nemogcm.F90 6152 2015-12-21 22:33:57Z acc $
70   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
71   !!----------------------------------------------------------------------
72CONTAINS
73
74   SUBROUTINE nemo_gcm
75      !!----------------------------------------------------------------------
76      !!                     ***  ROUTINE nemo_gcm  ***
77      !!
78      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
79      !!              curvilinear mesh on the sphere.
80      !!
81      !! ** Method  : - model general initialization
82      !!              - launch the time-stepping (stp routine)
83      !!              - finalize the run by closing files and communications
84      !!
85      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
86      !!              Madec, 2008, internal report, IPSL.
87      !!----------------------------------------------------------------------
88      INTEGER ::   istp       ! time step index
89      !!----------------------------------------------------------------------
90      !
91
92
93
94
95      !                            !-----------------------!
96      CALL nemo_init               !==  Initialisations  ==!
97      !                            !-----------------------!
98
99
100
101
102      ! check that all process are still there... If some process have an error,
103      ! they will never enter in step and other processes will wait until the end of the cpu time!
104      IF( lk_mpp )   CALL mpp_max( nstop )
105
106      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
107
108      !                            !-----------------------!
109      !                            !==  finalize the run  ==!
110      !                            !------------------------!
111      !
112      IF( nstop /= 0 .AND. lwp ) THEN   ! error print
113         WRITE(numout,cform_err)
114         WRITE(numout,*) nstop, ' error have been found'
115      ENDIF
116      !
117
118
119
120
121
122
123
124      IF( nn_timing == 1 )   CALL timing_finalize
125      !
126      CALL nemo_closefile
127      !
128
129      CALL xios_finalize                  ! end mpp communications with xios
130
131
132
133      !
134   END SUBROUTINE nemo_gcm
135
136
137   SUBROUTINE nemo_init
138      !!----------------------------------------------------------------------
139      !!                     ***  ROUTINE nemo_init  ***
140      !!
141      !! ** Purpose :   initialization of the NEMO GCM
142      !!----------------------------------------------------------------------
143      INTEGER ::   ji            ! dummy loop indices
144      INTEGER ::   ilocal_comm   ! local integer
145      INTEGER ::   ios
146      CHARACTER(len=80), DIMENSION(16) ::   cltxt
147      !
148      NAMELIST/namctl/ ln_ctl  , nn_print, nn_ictls, nn_ictle,   &
149         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
150         &             nn_bench, nn_timing, nn_diacfl
151      NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, &
152         &             jpizoom, jpjzoom, jperio, ln_use_jattr
153      !!----------------------------------------------------------------------
154      !
155      cltxt = ''
156      cxios_context = 'nemo'
157      !
158      !                             ! Open reference namelist and configuration namelist files
159      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
160      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
161      !
162      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints & Benchmark
163      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
164901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
165
166      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist : Control prints & Benchmark
167      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
168902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
169
170      !
171      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist : Control prints & Benchmark
172      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
173903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
174
175      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist : Control prints & Benchmark
176      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
177904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
178
179! Force values for AGRIF zoom (cf. agrif_user.F90)
180      !
181      !                             !--------------------------------------------!
182      !                             !  set communicator & select the local node  !
183      !                             !  NB: mynode also opens output.namelist.dyn !
184      !                             !      on unit number numond on first proc   !
185      !                             !--------------------------------------------!
186      IF( Agrif_Root() ) THEN
187            CALL  xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )    ! nemo local communicator given by xios
188      ENDIF
189      ! Nodes selection (control print return in cltxt)
190      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
191      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
192
193      lwm = (narea == 1)                                    ! control of output namelists
194      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
195
196      IF(lwm) THEN
197         ! write merged namelists from earlier to output namelist now that the
198         ! file has been opened in call to mynode. nammpp has already been
199         ! written in mynode (if lk_mpp_mpi)
200         WRITE( numond, namctl )
201         WRITE( numond, namcfg )
202      ENDIF
203
204      ! If dimensions of processor grid weren't specified in the namelist file
205      ! then we calculate them here now that we have our communicator size
206      IF( jpni < 1 .OR. jpnj < 1 ) THEN
207         IF( Agrif_Root() )   CALL nemo_partition( mppsize )
208      ENDIF
209
210      ! Calculate domain dimensions given calculated jpni and jpnj
211      ! This used to be done in par_oce.F90 when they were parameters rather than variables
212      IF( Agrif_Root() ) THEN
213         jpi = ( jpiglo     -2*jpreci + (jpni-1) ) / jpni + 2*jpreci    ! first  dim.
214         jpj = ( jpjglo     -2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj    ! second dim.
215      ENDIF         
216         jpk = jpkdta                                             ! third dim
217         jpim1 = jpi-1                                            ! inner domain indices
218         jpjm1 = jpj-1                                            !   "           "
219         jpkm1 = jpk-1                                            !   "           "
220         jpij  = jpi*jpj                                          !  jpi x j
221
222      IF(lwp) THEN                            ! open listing units
223         !
224         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
225         !
226         WRITE(numout,*)
227         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
228         WRITE(numout,*) '                       NEMO team'
229         WRITE(numout,*) '            Ocean General Circulation Model'
230         WRITE(numout,*) '                  version 3.7  (2015) '
231         WRITE(numout,*)
232         WRITE(numout,*)
233         DO ji = 1, SIZE(cltxt)
234            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
235         END DO
236         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
237         !
238      ENDIF
239
240      ! Now we know the dimensions of the grid and numout has been set we can
241      ! allocate arrays
242      CALL nemo_alloc()
243
244      !                             !-------------------------------!
245      !                             !  NEMO general initialization  !
246      !                             !-------------------------------!
247
248      CALL nemo_ctl                          ! Control prints & Benchmark
249
250      !                                      ! Domain decomposition
251      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
252      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
253      ENDIF
254      !
255      IF( nn_timing == 1 )  CALL timing_init
256      !
257      !                                      ! General initialization
258                            CALL     phy_cst    ! Physical constants
259                            CALL     eos_init   ! Equation of state
260                            CALL     dom_cfg    ! Domain configuration
261                            CALL     dom_init   ! Domain
262      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
263      !
264   END SUBROUTINE nemo_init
265
266
267   SUBROUTINE nemo_ctl
268      !!----------------------------------------------------------------------
269      !!                     ***  ROUTINE nemo_ctl  ***
270      !!
271      !! ** Purpose :   control print setting
272      !!
273      !! ** Method  : - print namctl information and check some consistencies
274      !!----------------------------------------------------------------------
275      !
276      IF(lwp) THEN                  ! control print
277         WRITE(numout,*)
278         WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
279         WRITE(numout,*) '~~~~~~~ '
280         WRITE(numout,*) '   Namelist namctl'
281         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
282         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
283         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
284         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
285         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
286         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
287         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
288         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
289         WRITE(numout,*) '      benchmark parameter (0/1)       nn_bench   = ', nn_bench
290         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
291      ENDIF
292      !
293      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
294      nictls    = nn_ictls
295      nictle    = nn_ictle
296      njctls    = nn_jctls
297      njctle    = nn_jctle
298      isplt     = nn_isplt
299      jsplt     = nn_jsplt
300      nbench    = nn_bench
301
302      IF(lwp) THEN                  ! control print
303         WRITE(numout,*)
304         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
305         WRITE(numout,*) '~~~~~~~ '
306         WRITE(numout,*) '   Namelist namcfg'
307         WRITE(numout,*) '      configuration name                               cp_cfg  = ', TRIM(cp_cfg)
308         WRITE(numout,*) '      configuration zoom name                          cp_cfz  = ', TRIM(cp_cfz)
309         WRITE(numout,*) '      configuration resolution                         jp_cfg  = ', jp_cfg
310         WRITE(numout,*) '      1st lateral dimension ( >= jpiglo )              jpidta  = ', jpidta
311         WRITE(numout,*) '      2nd    "         "    ( >= jpjglo )              jpjdta  = ', jpjdta
312         WRITE(numout,*) '      3nd    "         "                               jpkdta  = ', jpkdta
313         WRITE(numout,*) '      1st dimension of global domain in i              jpiglo  = ', jpiglo
314         WRITE(numout,*) '      2nd    -                  -    in j              jpjglo  = ', jpjglo
315         WRITE(numout,*) '      left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom
316         WRITE(numout,*) '      left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom
317         WRITE(numout,*) '      lateral cond. type (between 0 and 6)             jperio  = ', jperio   
318         WRITE(numout,*) '      use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
319      ENDIF
320      !                             ! Parameter control
321      !
322      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
323         IF( lk_mpp .AND. jpnij > 1 ) THEN
324            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
325         ELSE
326            IF( isplt == 1 .AND. jsplt == 1  ) THEN
327               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
328                  &           ' - the print control will be done over the whole domain' )
329            ENDIF
330            ijsplt = isplt * jsplt            ! total number of processors ijsplt
331         ENDIF
332         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
333         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
334         !
335         !                              ! indices used for the SUM control
336         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
337            lsp_area = .FALSE.
338         ELSE                                             ! print control done over a specific  area
339            lsp_area = .TRUE.
340            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
341               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
342               nictls = 1
343            ENDIF
344            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
345               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
346               nictle = jpiglo
347            ENDIF
348            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
349               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
350               njctls = 1
351            ENDIF
352            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
353               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
354               njctle = jpjglo
355            ENDIF
356         ENDIF
357      ENDIF
358      !
359      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
360         &                                               'f2003 standard. '                              ,  &
361         &                                               'Compile with key_nosignedzero enabled' )
362      !
363   END SUBROUTINE nemo_ctl
364
365
366   SUBROUTINE nemo_closefile
367      !!----------------------------------------------------------------------
368      !!                     ***  ROUTINE nemo_closefile  ***
369      !!
370      !! ** Purpose :   Close the files
371      !!----------------------------------------------------------------------
372      !
373      IF( lk_mpp )   CALL mppsync
374      !
375      CALL iom_close                                 ! close all input/output files managed by iom_*
376      !
377      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
378      IF( numsol          /= -1 )   CLOSE( numsol          )   ! solver file
379      IF( numnam_ref      /= -1 )   CLOSE( numnam_ref      )   ! oce reference namelist
380      IF( numnam_cfg      /= -1 )   CLOSE( numnam_cfg      )   ! oce configuration namelist
381      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
382      IF( numnam_ice_ref  /= -1 )   CLOSE( numnam_ice_ref  )   ! ice reference namelist
383      IF( numnam_ice_cfg  /= -1 )   CLOSE( numnam_ice_cfg  )   ! ice configuration namelist
384      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
385      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
386      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
387      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
388      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
389      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
390      !
391      numout = 6                                     ! redefine numout in case it is used after this point...
392      !
393   END SUBROUTINE nemo_closefile
394
395
396   SUBROUTINE nemo_alloc
397      !!----------------------------------------------------------------------
398      !!                     ***  ROUTINE nemo_alloc  ***
399      !!
400      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
401      !!
402      !! ** Method  :
403      !!----------------------------------------------------------------------
404      USE dom_oce   , ONLY: dom_oce_alloc
405      !
406      INTEGER :: ierr
407      !!----------------------------------------------------------------------
408      !
409      ierr =        oce_alloc       ()          ! ocean
410      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
411      !
412      IF( lk_mpp    )   CALL mpp_sum( ierr )
413      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
414      !
415   END SUBROUTINE nemo_alloc
416
417
418   SUBROUTINE nemo_partition( num_pes )
419      !!----------------------------------------------------------------------
420      !!                 ***  ROUTINE nemo_partition  ***
421      !!
422      !! ** Purpose :
423      !!
424      !! ** Method  :
425      !!----------------------------------------------------------------------
426      INTEGER, INTENT(in) ::   num_pes   ! The number of MPI processes we have
427      !
428      INTEGER, PARAMETER :: nfactmax = 20
429      INTEGER :: nfact ! The no. of factors returned
430      INTEGER :: ierr  ! Error flag
431      INTEGER :: ji
432      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
433      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
434      !!----------------------------------------------------------------------
435      !
436      ierr = 0
437      !
438      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
439      !
440      IF( nfact <= 1 ) THEN
441         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
442         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
443         jpnj = 1
444         jpni = num_pes
445      ELSE
446         ! Search through factors for the pair that are closest in value
447         mindiff = 1000000
448         imin    = 1
449         DO ji = 1, nfact-1, 2
450            idiff = ABS( ifact(ji) - ifact(ji+1) )
451            IF( idiff < mindiff ) THEN
452               mindiff = idiff
453               imin = ji
454            ENDIF
455         END DO
456         jpnj = ifact(imin)
457         jpni = ifact(imin + 1)
458      ENDIF
459      !
460      jpnij = jpni*jpnj
461      !
462   END SUBROUTINE nemo_partition
463
464
465   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
466      !!----------------------------------------------------------------------
467      !!                     ***  ROUTINE factorise  ***
468      !!
469      !! ** Purpose :   return the prime factors of n.
470      !!                knfax factors are returned in array kfax which is of
471      !!                maximum dimension kmaxfax.
472      !! ** Method  :
473      !!----------------------------------------------------------------------
474      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
475      INTEGER                    , INTENT(  out) ::   kerr, knfax
476      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
477      !
478      INTEGER :: ifac, jl, inu
479      INTEGER, PARAMETER :: ntest = 14
480      INTEGER, DIMENSION(ntest) ::   ilfax
481      !!----------------------------------------------------------------------
482      !
483      ! lfax contains the set of allowed factors.
484      ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
485      !
486      ! Clear the error flag and initialise output vars
487      kerr  = 0
488      kfax  = 1
489      knfax = 0
490      !
491      ! Find the factors of n.
492      IF( kn == 1 )   GOTO 20
493
494      ! nu holds the unfactorised part of the number.
495      ! knfax holds the number of factors found.
496      ! l points to the allowed factor list.
497      ! ifac holds the current factor.
498      !
499      inu   = kn
500      knfax = 0
501      !
502      DO jl = ntest, 1, -1
503         !
504         ifac = ilfax(jl)
505         IF( ifac > inu )   CYCLE
506
507         ! Test whether the factor will divide.
508
509         IF( MOD(inu,ifac) == 0 ) THEN
510            !
511            knfax = knfax + 1            ! Add the factor to the list
512            IF( knfax > kmaxfax ) THEN
513               kerr = 6
514               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
515               return
516            ENDIF
517            kfax(knfax) = ifac
518            ! Store the other factor that goes with this one
519            knfax = knfax + 1
520            kfax(knfax) = inu / ifac
521            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
522         ENDIF
523         !
524      END DO
525      !
526   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
527      !
528   END SUBROUTINE factorise
529
530
531   SUBROUTINE nemo_northcomms
532      !!----------------------------------------------------------------------
533      !!                     ***  ROUTINE  nemo_northcomms  ***
534      !! ** Purpose :   Setup for north fold exchanges with explicit
535      !!                point-to-point messaging
536      !!
537      !! ** Method :   Initialization of the northern neighbours lists.
538      !!----------------------------------------------------------------------
539      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
540      !!    2.0  ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
541      !!----------------------------------------------------------------------
542      INTEGER  ::   sxM, dxM, sxT, dxT, jn
543      INTEGER  ::   njmppmax
544      !!----------------------------------------------------------------------
545      !
546      njmppmax = MAXVAL( njmppt )
547      !
548      !initializes the north-fold communication variables
549      isendto(:) = 0
550      nsndto     = 0
551      !
552      !if I am a process in the north
553      IF ( njmpp == njmppmax ) THEN
554          !sxM is the first point (in the global domain) needed to compute the
555          !north-fold for the current process
556          sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
557          !dxM is the last point (in the global domain) needed to compute the
558          !north-fold for the current process
559          dxM = jpiglo - nimppt(narea) + 2
560
561          !loop over the other north-fold processes to find the processes
562          !managing the points belonging to the sxT-dxT range
563 
564          DO jn = 1, jpni
565                !sxT is the first point (in the global domain) of the jn
566                !process
567                sxT = nfiimpp(jn, jpnj)
568                !dxT is the last point (in the global domain) of the jn
569                !process
570                dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
571                IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
572                   nsndto = nsndto + 1
573                     isendto(nsndto) = jn
574                ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
575                   nsndto = nsndto + 1
576                     isendto(nsndto) = jn
577                ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
578                   nsndto = nsndto + 1
579                     isendto(nsndto) = jn
580                END IF
581          END DO
582          nfsloop = 1
583          nfeloop = nlci
584          DO jn = 2,jpni-1
585           IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
586              IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
587                 nfsloop = nldi
588              ENDIF
589              IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
590                 nfeloop = nlei
591              ENDIF
592           ENDIF
593        END DO
594
595      ENDIF
596      l_north_nogather = .TRUE.
597   END SUBROUTINE nemo_northcomms
598
599
600   !!======================================================================
601END MODULE nemogcm
602
Note: See TracBrowser for help on using the repository browser.