source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/NEMO/OFF_SRC/nemogcm.F90 @ 6979

Last change on this file since 6979 was 6979, checked in by cetlod, 5 years ago

SIMPLIF_2_usrdef : make it work for standard Offline configuration

  • Property svn:keywords set to Id
File size: 31.9 KB
Line 
1MODULE nemogcm
2   !!======================================================================
3   !!                       ***  MODULE nemogcm   ***
4   !! Off-line Ocean   : passive tracer evolution, dynamics read in files
5   !!======================================================================
6   !! History :  3.3  ! 2010-05  (C. Ethe)  Full reorganization of the off-line: phasing with the on-line
7   !!            4.0  ! 2011-01  (C. Ethe, A. R. Porter, STFC Daresbury) dynamical allocation
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   nemo_gcm        : off-line: solve ocean tracer only
12   !!   nemo_init       : initialization of the nemo model
13   !!   nemo_ctl        : initialisation of algorithm flag
14   !!   nemo_closefile  : close remaining files
15   !!----------------------------------------------------------------------
16   USE dom_oce         ! ocean space domain variables
17   USE oce             ! dynamics and tracers variables
18   USE c1d             ! 1D configuration
19   USE domcfg          ! domain configuration               (dom_cfg routine)
20   USE domain          ! domain initialization from coordinate & bathymetry (dom_init routine)
21!   USE domrea          ! domain initialization from mesh_mask            (dom_init routine)
22   USE eosbn2          ! equation of state            (eos bn2 routine)
23   !              ! ocean physics
24   USE ldftra          ! lateral diffusivity setting    (ldf_tra_init routine)
25   USE ldfslp          ! slopes of neutral surfaces     (ldf_slp_init routine)
26   USE traqsr          ! solar radiation penetration    (tra_qsr_init routine)
27   USE trabbl          ! bottom boundary layer          (tra_bbl_init routine)
28   USE traldf          ! lateral physics                (tra_ldf_init routine)
29   USE zdfini          ! vertical physics: initialization
30   USE sbcmod          ! surface boundary condition       (sbc_init     routine)
31   USE phycst          ! physical constant                  (par_cst routine)
32   USE dtadyn          ! Lecture and Interpolation of the dynamical fields
33   USE trcini          ! Initilization of the passive tracers
34   USE daymod          ! calendar                         (day     routine)
35   USE trcstp          ! passive tracer time-stepping      (trc_stp routine)
36   USE dtadyn          ! Lecture and interpolation of the dynamical fields
37   !              ! I/O & MPP
38   USE iom             ! I/O library
39   USE in_out_manager  ! I/O manager
40   USE mppini          ! shared/distributed memory setting (mpp_init routine)
41   USE lib_mpp         ! distributed memory computing
42#if defined key_iomput
43   USE xios
44#endif
45   USE prtctl          ! Print control                    (prt_ctl_init routine)
46   USE timing          ! Timing
47   USE lib_fortran     ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
48   USE lbcnfd, ONLY: isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
49
50   USE trc
51   USE trcnam
52   USE trcrst
53   USE diaptr         ! Need to initialise this as some variables are used in if statements later
54   USE sbc_oce, ONLY: ln_rnf
55   USE sbcrnf
56   USE usrdef_nam     ! user defined configuration
57
58
59   IMPLICIT NONE
60   PRIVATE
61   
62   PUBLIC   nemo_gcm   ! called by nemo.F90
63
64   CHARACTER (len=64) ::   cform_aaa="( /, 'AAAAAAAA', / ) "   ! flag for output listing
65
66   !!----------------------------------------------------------------------
67   !! NEMO/OFF 3.3 , NEMO Consortium (2010)
68   !! $Id$
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 (dta_dyn and trc_stp)
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, indic       ! time step index
88      !!----------------------------------------------------------------------
89
90      CALL nemo_init  ! Initializations
91
92      ! check that all process are still there... If some process have an error,
93      ! they will never enter in step and other processes will wait until the end of the cpu time!
94      IF( lk_mpp )   CALL mpp_max( nstop )
95
96      !                            !-----------------------!
97      !                            !==   time stepping   ==!
98      !                            !-----------------------!
99      istp = nit000
100      !
101      ! Initialize arrays of runoffs structures and read data from the namelist
102      IF ( ln_rnf ) CALL sbc_rnf(istp)
103      !
104      CALL iom_init( cxios_context )            ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
105      !
106      DO WHILE ( istp <= nitend .AND. nstop == 0 )    ! time stepping
107         !
108         IF( istp /= nit000 )   CALL day      ( istp )         ! Calendar (day was already called at nit000 in day_init)
109                                CALL iom_setkt( istp - nit000 + 1, "nemo" )   ! say to iom that we are at time step kstp
110                                CALL dta_dyn  ( istp )         ! Interpolation of the dynamical fields
111                                CALL trc_stp  ( istp )         ! time-stepping
112                                CALL stp_ctl  ( istp, indic )  ! Time loop: control and print
113         istp = istp + 1
114         IF( lk_mpp )   CALL mpp_max( nstop )
115      END DO
116#if defined key_iomput
117      CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF
118#endif
119
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( nn_timing == 1 )   CALL timing_finalize
131      !
132      CALL nemo_closefile
133      !
134# if defined key_iomput
135      CALL xios_finalize             ! end mpp communications
136# else
137      IF( lk_mpp )   CALL mppstop       ! end mpp communications
138# endif
139      !
140   END SUBROUTINE nemo_gcm
141
142
143   SUBROUTINE nemo_init
144      !!----------------------------------------------------------------------
145      !!                     ***  ROUTINE nemo_init ***
146      !!
147      !! ** Purpose :   initialization of the nemo model in off-line mode
148      !!----------------------------------------------------------------------
149      INTEGER ::   ji            ! dummy loop indices
150      INTEGER ::   ilocal_comm   ! local integer
151      INTEGER ::   ios, inum
152      REAL(wp) ::   ziglo, zjglo, zkglo, zperio   ! local scalars
153      CHARACTER(len=120), DIMENSION(30) ::   cltxt, cltxt2, clnam
154      !!
155      NAMELIST/namctl/ ln_ctl  , nn_print, nn_ictls, nn_ictle,   &
156         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
157         &             nn_timing, nn_diacfl
158
159      NAMELIST/namcfg/ ln_read_cfg, ln_write_cfg, cp_cfg, jp_cfg, ln_use_jattr
160      !!----------------------------------------------------------------------
161      cltxt  = ''
162      cltxt2 = ''
163      clnam  = '' 
164      cxios_context = 'nemo'
165      !
166      !                             ! Open reference namelist and configuration namelist files
167      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
168      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
169      !
170      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints & Benchmark
171      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
172901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
173
174      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist : Control prints & Benchmark
175      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
176902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
177
178      !
179      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist : Control prints & Benchmark
180      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
181903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
182
183      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist : Control prints & Benchmark
184      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
185904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
186
187
188      !                             !--------------------------!
189      !                             !  Set global domain size  !   (control print return in cltxt2)
190      !                             !--------------------------!
191      IF( ln_read_cfg ) THEN              ! Read sizes in configuration "mesh_mask" file
192         CALL iom_open( 'domain_cfg', inum )
193         CALL iom_get( inum, 'jpiglo', ziglo  )   ;   jpiglo = INT( ziglo )
194         CALL iom_get( inum, 'jpjglo', zjglo  )   ;   jpjglo = INT( zjglo )
195         CALL iom_get( inum, 'jpkglo', zkglo  )   ;   jpkglo = INT( zkglo )
196         CALL iom_get( inum, 'jperio', zperio )   ;   jperio = INT( zperio )
197         CALL iom_close( inum )
198         WRITE(cltxt2(1),*) '~~~~~~~~~~   '     
199         WRITE(cltxt2(2),*) 'domain_cfg : domain size read in "domain_cfg" file : jp(i,j,k)glo = '
200         WRITE(cltxt2(3),*) '            ', jpiglo, jpjglo, jpkglo       
201         WRITE(cltxt2(1),*) '~~~~~~~~~~   lateral boudary type of the global domain jperio= ', jperio
202         !       
203      ELSE                                ! user-defined namelist
204         CALL usr_def_nam( cltxt2, clnam, jpiglo, jpjglo, jpkglo, jperio )
205      ENDIF
206      jpk    = jpkglo
207      !
208      !                             !--------------------------------------------!
209      !                             !  set communicator & select the local node  !
210      !                             !  NB: mynode also opens output.namelist.dyn !
211      !                             !      on unit number numond on first proc   !
212      !                             !--------------------------------------------!
213#if defined key_iomput
214      CALL  xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )
215      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )   ! Nodes selection
216#else
217      ilocal_comm = 0
218      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )                ! Nodes selection (control print return in cltxt)
219#endif
220
221      narea = narea + 1                       ! mynode return the rank of proc (0 --> jpnij -1 )
222
223      lwm = (narea == 1)                      ! control of output namelists
224      lwp = (narea == 1) .OR. ln_ctl          ! control of all listing output print
225
226      IF(lwm) THEN
227         ! write merged namelists from earlier to output namelist now that the
228         ! file has been opened in call to mynode. nammpp has already been
229         ! written in mynode (if lk_mpp_mpi)
230         WRITE( numond, namctl )
231         WRITE( numond, namcfg )
232         IF( .NOT.ln_read_cfg ) THEN
233            DO ji = 1, SIZE(clnam)
234               IF( TRIM(clnam (ji)) /= '' )   WRITE(numond, * ) clnam(ji)    ! namusr_def print
235            END DO
236         ENDIF
237      ENDIF
238
239      ! If dimensions of processor grid weren't specified in the namelist file
240      ! then we calculate them here now that we have our communicator size
241      IF( (jpni < 1) .OR. (jpnj < 1) )THEN
242#if   defined key_mpp_mpi
243         CALL nemo_partition(mppsize)
244#else
245         jpni = 1
246         jpnj = 1
247         jpnij = jpni*jpnj
248#endif
249      END IF
250
251      ! Calculate domain dimensions given calculated jpni and jpnj
252      ! This used to be done in par_oce.F90 when they were parameters rather
253      ! than variables
254      jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   ! first  dim.
255      jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   ! second dim.
256      jpim1 = jpi-1                                            ! inner domain indices
257      jpjm1 = jpj-1                                            !   "           "
258      jpkm1 = jpk-1                                            !   "           "
259      jpij  = jpi*jpj                                          !  jpi x j
260
261
262      IF(lwp) THEN                            ! open listing units
263         !
264         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
265         !
266         WRITE(numout,*)
267         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
268         WRITE(numout,*) '                       NEMO team'
269         WRITE(numout,*) '            Ocean General Circulation Model'
270         WRITE(numout,*) '                  version 3.6  (2015) '
271         WRITE(numout,*)
272         WRITE(numout,*)
273         DO ji = 1, SIZE(cltxt) 
274            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
275         END DO
276         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
277         !
278      ENDIF
279
280      ! Now we know the dimensions of the grid and numout has been set we can
281      ! allocate arrays
282      CALL nemo_alloc()
283
284      !                             !--------------------------------!
285      !                             !  Model general initialization  !
286      !                             !--------------------------------!
287
288      CALL nemo_ctl                           ! Control prints & Benchmark
289
290      !                                      ! Domain decomposition
291      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
292      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
293      ENDIF
294      !
295      IF( nn_timing == 1 )  CALL timing_init
296      !
297
298      !                                      ! General initialization
299      IF( nn_timing == 1 )  CALL timing_start( 'nemo_init')
300      !
301                            CALL     phy_cst    ! Physical constants
302                            CALL     eos_init   ! Equation of state
303      IF( lk_c1d        )   CALL     c1d_init   ! 1D column configuration
304
305                            CALL     dom_cfg    ! Domain configuration
306                            CALL     dom_init   ! Domain
307
308                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
309
310      IF( ln_nnogather )    CALL nemo_northcomms   ! Initialise the northfold neighbour lists (must be done after the masks are defined)
311
312      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
313
314                            CALL     sbc_init   ! Forcings : surface module
315
316                            CALL ldf_tra_init   ! Lateral ocean tracer physics
317                            CALL ldf_eiv_init   ! Eddy induced velocity param
318                            CALL tra_ldf_init   ! lateral mixing
319      IF( l_ldfslp )        CALL ldf_slp_init   ! slope of lateral mixing
320
321                            CALL tra_qsr_init   ! penetrative solar radiation qsr
322      IF( lk_trabbl     )   CALL tra_bbl_init   ! advective (and/or diffusive) bottom boundary layer scheme
323
324                            CALL trc_nam_run    ! Needed to get restart parameters for passive tracers
325                            CALL trc_rst_cal( nit000, 'READ' )   ! calendar
326                            CALL dta_dyn_init   ! Initialization for the dynamics
327
328                            CALL     trc_init   ! Passive tracers initialization
329                            CALL dia_ptr_init   ! Initialise diaptr as some variables are used
330      !                                         ! in various advection and diffusion routines
331      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
332      !
333      IF( nn_timing == 1 )  CALL timing_stop( 'nemo_init')
334      !
335   END SUBROUTINE nemo_init
336
337
338   SUBROUTINE nemo_ctl
339      !!----------------------------------------------------------------------
340      !!                     ***  ROUTINE nemo_ctl  ***
341      !!
342      !! ** Purpose :   control print setting
343      !!
344      !! ** Method  : - print namctl information and check some consistencies
345      !!----------------------------------------------------------------------
346      !
347      IF(lwp) THEN                  ! control print
348         WRITE(numout,*)
349         WRITE(numout,*) 'nemo_ctl: Control prints'
350         WRITE(numout,*) '~~~~~~~ '
351         WRITE(numout,*) '   Namelist namctl'
352         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
353         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
354         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
355         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
356         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
357         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
358         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
359         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
360         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
361      ENDIF
362      !
363      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
364      nictls    = nn_ictls
365      nictle    = nn_ictle
366      njctls    = nn_jctls
367      njctle    = nn_jctle
368      isplt     = nn_isplt
369      jsplt     = nn_jsplt
370
371      IF(lwp) THEN                  ! control print
372         WRITE(numout,*)
373         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
374         WRITE(numout,*) '~~~~~~~ '
375         WRITE(numout,*) '   Namelist namcfg'
376         WRITE(numout,*) '      read configuration definition files          ln_read_cfg = ', ln_read_cfg
377         WRITE(numout,*) '      configuration name                               cp_cfg  = ', TRIM(cp_cfg)
378         WRITE(numout,*) '      configuration resolution                         jp_cfg  = ', jp_cfg
379         WRITE(numout,*) '      use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
380      ENDIF
381      !                             ! Parameter control
382      !
383      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
384         IF( lk_mpp .AND. jpnij > 1 ) THEN
385            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
386         ELSE
387            IF( isplt == 1 .AND. jsplt == 1  ) THEN
388               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
389                  &           ' - the print control will be done over the whole domain' )
390            ENDIF
391            ijsplt = isplt * jsplt            ! total number of processors ijsplt
392         ENDIF
393         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
394         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
395         !
396         !                              ! indices used for the SUM control
397         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
398            lsp_area = .FALSE.
399         ELSE                                             ! print control done over a specific  area
400            lsp_area = .TRUE.
401            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
402               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
403               nictls = 1
404            ENDIF
405            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
406               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
407               nictle = jpiglo
408            ENDIF
409            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
410               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
411               njctls = 1
412            ENDIF
413            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
414               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
415               njctle = jpjglo
416            ENDIF
417         ENDIF
418      ENDIF
419      !
420      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
421         &                                               'f2003 standard. '                              ,  &
422         &                                               'Compile with key_nosignedzero enabled' )
423      !
424   END SUBROUTINE nemo_ctl
425
426
427   SUBROUTINE nemo_closefile
428      !!----------------------------------------------------------------------
429      !!                     ***  ROUTINE nemo_closefile  ***
430      !!
431      !! ** Purpose :   Close the files
432      !!----------------------------------------------------------------------
433      !
434      IF ( lk_mpp ) CALL mppsync
435      !
436      CALL iom_close                                 ! close all input/output files managed by iom_*
437      !
438      IF( numstp     /= -1 )   CLOSE( numstp     )   ! time-step file
439      IF( numnam_ref /= -1 )   CLOSE( numnam_ref )   ! oce reference namelist
440      IF( numnam_cfg /= -1 )   CLOSE( numnam_cfg )   ! oce configuration namelist
441      IF( numout     /=  6 )   CLOSE( numout     )   ! standard model output file
442      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
443
444      numout = 6                                     ! redefine numout in case it is used after this point...
445      !
446   END SUBROUTINE nemo_closefile
447
448
449   SUBROUTINE nemo_alloc
450      !!----------------------------------------------------------------------
451      !!                     ***  ROUTINE nemo_alloc  ***
452      !!
453      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
454      !!
455      !! ** Method  :
456      !!----------------------------------------------------------------------
457      USE diawri,       ONLY: dia_wri_alloc
458      USE dom_oce,      ONLY: dom_oce_alloc
459      USE zdf_oce,      ONLY: zdf_oce_alloc
460      USE trc_oce,      ONLY: trc_oce_alloc
461      !
462      INTEGER :: ierr
463      !!----------------------------------------------------------------------
464      !
465      ierr =        oce_alloc       ()          ! ocean
466      ierr = ierr + dia_wri_alloc   ()
467      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
468      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
469      !
470      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
471      !
472      IF( lk_mpp    )   CALL mpp_sum( ierr )
473      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
474      !
475   END SUBROUTINE nemo_alloc
476
477
478   SUBROUTINE nemo_partition( num_pes )
479      !!----------------------------------------------------------------------
480      !!                 ***  ROUTINE nemo_partition  ***
481      !!
482      !! ** Purpose :   
483      !!
484      !! ** Method  :
485      !!----------------------------------------------------------------------
486      INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
487      !
488      INTEGER, PARAMETER :: nfactmax = 20
489      INTEGER :: nfact ! The no. of factors returned
490      INTEGER :: ierr  ! Error flag
491      INTEGER :: ji
492      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
493      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
494      !!----------------------------------------------------------------------
495
496      ierr = 0
497
498      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
499
500      IF( nfact <= 1 ) THEN
501         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
502         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
503         jpnj = 1
504         jpni = num_pes
505      ELSE
506         ! Search through factors for the pair that are closest in value
507         mindiff = 1000000
508         imin    = 1
509         DO ji = 1, nfact-1, 2
510            idiff = ABS( ifact(ji) - ifact(ji+1) )
511            IF( idiff < mindiff ) THEN
512               mindiff = idiff
513               imin = ji
514            ENDIF
515         END DO
516         jpnj = ifact(imin)
517         jpni = ifact(imin + 1)
518      ENDIF
519      !
520      jpnij = jpni*jpnj
521      !
522   END SUBROUTINE nemo_partition
523
524
525   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
526      !!----------------------------------------------------------------------
527      !!                     ***  ROUTINE factorise  ***
528      !!
529      !! ** Purpose :   return the prime factors of n.
530      !!                knfax factors are returned in array kfax which is of
531      !!                maximum dimension kmaxfax.
532      !! ** Method  :
533      !!----------------------------------------------------------------------
534      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
535      INTEGER                    , INTENT(  out) ::   kerr, knfax
536      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
537      !
538      INTEGER :: ifac, jl, inu
539      INTEGER, PARAMETER :: ntest = 14
540      INTEGER :: ilfax(ntest)
541      !
542      ! lfax contains the set of allowed factors.
543      data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256,  &
544         &                            128,   64,   32,   16,    8,   4,   2  /
545      !!----------------------------------------------------------------------
546
547      ! Clear the error flag and initialise output vars
548      kerr = 0
549      kfax = 1
550      knfax = 0
551
552      ! Find the factors of n.
553      IF( kn == 1 )   GOTO 20
554
555      ! nu holds the unfactorised part of the number.
556      ! knfax holds the number of factors found.
557      ! l points to the allowed factor list.
558      ! ifac holds the current factor.
559
560      inu   = kn
561      knfax = 0
562
563      DO jl = ntest, 1, -1
564         !
565         ifac = ilfax(jl)
566         IF( ifac > inu )   CYCLE
567
568         ! Test whether the factor will divide.
569
570         IF( MOD(inu,ifac) == 0 ) THEN
571            !
572            knfax = knfax + 1            ! Add the factor to the list
573            IF( knfax > kmaxfax ) THEN
574               kerr = 6
575               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
576               return
577            ENDIF
578            kfax(knfax) = ifac
579            ! Store the other factor that goes with this one
580            knfax = knfax + 1
581            kfax(knfax) = inu / ifac
582            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
583         ENDIF
584         !
585      END DO
586
587   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
588      !
589   END SUBROUTINE factorise
590
591#if defined key_mpp_mpi
592   SUBROUTINE nemo_northcomms
593      !!======================================================================
594      !!                     ***  ROUTINE  nemo_northcomms  ***
595      !! nemo_northcomms    :  Setup for north fold exchanges with explicit
596      !!                       point-to-point messaging
597      !!=====================================================================
598      !!----------------------------------------------------------------------
599      !!
600      !! ** Purpose :   Initialization of the northern neighbours lists.
601      !!----------------------------------------------------------------------
602      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
603      !!    2.0  ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S.
604      !Mocavero, CMCC)
605      !!----------------------------------------------------------------------
606
607      INTEGER  ::   sxM, dxM, sxT, dxT, jn
608      INTEGER  ::   njmppmax
609
610      njmppmax = MAXVAL( njmppt )
611
612      !initializes the north-fold communication variables
613      isendto(:) = 0
614      nsndto = 0
615
616      !if I am a process in the north
617      IF ( njmpp == njmppmax ) THEN
618          !sxM is the first point (in the global domain) needed to compute the
619          !north-fold for the current process
620          sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
621          !dxM is the last point (in the global domain) needed to compute the
622          !north-fold for the current process
623          dxM = jpiglo - nimppt(narea) + 2
624
625          !loop over the other north-fold processes to find the processes
626          !managing the points belonging to the sxT-dxT range
627
628          DO jn = 1, jpni
629                !sxT is the first point (in the global domain) of the jn
630                !process
631                sxT = nfiimpp(jn, jpnj)
632                !dxT is the last point (in the global domain) of the jn
633                !process
634                dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
635                IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
636                   nsndto = nsndto + 1
637                     isendto(nsndto) = jn
638                ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
639                   nsndto = nsndto + 1
640                     isendto(nsndto) = jn
641                ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
642                   nsndto = nsndto + 1
643                     isendto(nsndto) = jn
644                END IF
645          END DO
646          nfsloop = 1
647          nfeloop = nlci
648          DO jn = 2,jpni-1
649           IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
650              IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
651                 nfsloop = nldi
652              ENDIF
653              IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
654                 nfeloop = nlei
655              ENDIF
656           ENDIF
657        END DO
658
659      ENDIF
660      l_north_nogather = .TRUE.
661   END SUBROUTINE nemo_northcomms
662#else
663   SUBROUTINE nemo_northcomms      ! Dummy routine
664      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
665   END SUBROUTINE nemo_northcomms
666#endif
667
668   SUBROUTINE istate_init
669      !!----------------------------------------------------------------------
670      !!                   ***  ROUTINE istate_init  ***
671      !!
672      !! ** Purpose :   Initialization to zero of the dynamics and tracers.
673      !!----------------------------------------------------------------------
674      !
675      !     now fields         !     after fields      !
676      un   (:,:,:)   = 0._wp   ;   ua(:,:,:) = 0._wp   !
677      vn   (:,:,:)   = 0._wp   ;   va(:,:,:) = 0._wp   !
678      wn   (:,:,:)   = 0._wp   !                       !
679      hdivn(:,:,:)   = 0._wp   !                       !
680      tsn  (:,:,:,:) = 0._wp   !                       !
681      !
682      rhd  (:,:,:) = 0.e0
683      rhop (:,:,:) = 0.e0
684      rn2  (:,:,:) = 0.e0
685      !
686   END SUBROUTINE istate_init
687
688   SUBROUTINE stp_ctl( kt, kindic )
689      !!----------------------------------------------------------------------
690      !!                    ***  ROUTINE stp_ctl  ***
691      !!
692      !! ** Purpose :   Control the run
693      !!
694      !! ** Method  : - Save the time step in numstp
695      !!
696      !! ** Actions :   'time.step' file containing the last ocean time-step
697      !!----------------------------------------------------------------------
698      INTEGER, INTENT(in   ) ::   kt      ! ocean time-step index
699      INTEGER, INTENT(inout) ::   kindic  ! indicator of solver convergence
700      !!----------------------------------------------------------------------
701      !
702      IF( kt == nit000 .AND. lwp ) THEN
703         WRITE(numout,*)
704         WRITE(numout,*) 'stp_ctl : time-stepping control'
705         WRITE(numout,*) '~~~~~~~'
706         ! open time.step file
707         CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
708      ENDIF
709      !
710      IF(lwp) WRITE ( numstp, '(1x, i8)' )   kt      !* save the current time step in numstp
711      IF(lwp) REWIND( numstp )                       ! --------------------------
712      !
713   END SUBROUTINE stp_ctl
714   !!======================================================================
715END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.