source: branches/2013/dev_LOCEAN_CMCC_INGV_2013/NEMOGCM/NEMO/SAS_SRC/nemogcm.F90 @ 4232

Last change on this file since 4232 was 4232, checked in by cetlod, 7 years ago

dev_LOCEAN_CMCC_INGV_2013 : minor bug corrections, see ticket #1182

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