source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 7110

Last change on this file since 7110 was 7110, checked in by flavoni, 4 years ago

#1692 and ROBUST-3, updates

  • Property svn:keywords set to Id
File size: 42.2 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   !!            4.0  ! 2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
36   !!----------------------------------------------------------------------
37
38   !!----------------------------------------------------------------------
39   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
40   !!   nemo_init     : initialization of the NEMO system
41   !!   nemo_ctl      : initialisation of the contol print
42   !!   nemo_closefile: close remaining open files
43   !!   nemo_alloc    : dynamical allocation
44   !!   nemo_partition: calculate MPP domain decomposition
45   !!   factorise     : calculate the factors of the no. of MPI processes
46   !!----------------------------------------------------------------------
47   USE step_oce       ! module used in the ocean time stepping module (step.F90)
48   USE mppini         ! shared/distributed memory setting (mpp_init routine)
49   USE domain         ! domain initialization             (dom_init routine)
50#if defined key_nemocice_decomp
51   USE ice_domain_size, only: nx_global, ny_global
52#endif
53   USE tideini        ! tidal components initialization   (tide_ini routine)
54   USE bdyini         ! open boundary cond. setting       (bdy_init routine)
55   USE bdydta         ! open boundary cond. setting   (bdy_dta_init routine)
56   USE bdytides       ! open boundary cond. setting   (bdytide_init routine)
57   USE sbctide, ONLY  : lk_tide
58   USE istate         ! initial state setting          (istate_init routine)
59   USE ldfdyn         ! lateral viscosity setting      (ldfdyn_init routine)
60   USE ldftra         ! lateral diffusivity setting    (ldftra_init routine)
61   USE zdfini         ! vertical physics setting          (zdf_init routine)
62   USE phycst         ! physical constant                  (par_cst routine)
63   USE trdini         ! dyn/tra trends initialization     (trd_init routine)
64   USE asminc         ! assimilation increments     
65   USE asmbkg         ! writing out state trajectory
66   USE diaptr         ! poleward transports           (dia_ptr_init routine)
67   USE diadct         ! sections transports           (dia_dct_init routine)
68   USE diaobs         ! Observation diagnostics       (dia_obs_init routine)
69   USE diacfl         ! CFL diagnostics               (dia_cfl_init routine)
70   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
71   USE step           ! NEMO time-stepping                 (stp     routine)
72   USE icbini         ! handle bergs, initialisation
73   USE icbstp         ! handle bergs, calving, themodynamics and transport
74   USE cpl_oasis3     ! OASIS3 coupling
75   USE c1d            ! 1D configuration
76   USE step_c1d       ! Time stepping loop for the 1D configuration
77   USE dyndmp         ! Momentum damping
78   USE stopar         ! Stochastic param.: ???
79   USE stopts         ! Stochastic param.: ???
80#if defined key_top
81   USE trcini         ! passive tracer initialisation
82#endif
83   USE lib_mpp        ! distributed memory computing
84   USE diurnal_bulk   ! diurnal bulk SST
85   USE step_diu       ! diurnal bulk SST timestepping (called from here if run offline)
86#if defined key_iomput
87   USE xios           ! xIOserver
88#endif
89   USE crsini         ! initialise grid coarsening utility
90   USE lbcnfd , ONLY  : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
91   USE sbc_oce, ONLY  : lk_oasis
92   USE diatmb         ! Top,middle,bottom output
93   USE dia25h         ! 25h mean output
94   USE wet_dry        ! Wetting and drying setting   (wad_init routine)
95   USE usrdef_nam     ! user defined configuration
96
97   IMPLICIT NONE
98   PRIVATE
99
100   PUBLIC   nemo_gcm    ! called by model.F90
101   PUBLIC   nemo_init   ! needed by AGRIF
102   PUBLIC   nemo_alloc  ! needed by TAM
103
104   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
105
106   !!----------------------------------------------------------------------
107   !! NEMO/OPA 4.0 , NEMO Consortium (2016)
108   !! $Id$
109   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
110   !!----------------------------------------------------------------------
111CONTAINS
112
113   SUBROUTINE nemo_gcm
114      !!----------------------------------------------------------------------
115      !!                     ***  ROUTINE nemo_gcm  ***
116      !!
117      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
118      !!              curvilinear mesh on the sphere.
119      !!
120      !! ** Method  : - model general initialization
121      !!              - launch the time-stepping (stp routine)
122      !!              - finalize the run by closing files and communications
123      !!
124      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
125      !!              Madec, 2008, internal report, IPSL.
126      !!----------------------------------------------------------------------
127      INTEGER ::   istp       ! time step index
128      !!----------------------------------------------------------------------
129      !
130#if defined key_agrif
131      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
132#endif
133      !
134      !                            !-----------------------!
135      CALL nemo_init               !==  Initialisations  ==!
136      !                            !-----------------------!
137#if defined key_agrif
138      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
139      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
140# if defined key_top
141      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
142# endif
143# if defined key_lim2
144      CALL Agrif_Declare_Var_lim2  !  "      "   "   "      "  LIM
145# endif
146#endif
147      ! check that all process are still there... If some process have an error,
148      ! they will never enter in step and other processes will wait until the end of the cpu time!
149      IF( lk_mpp )   CALL mpp_max( nstop )
150
151      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
152
153      !                            !-----------------------!
154      !                            !==   time stepping   ==!
155      !                            !-----------------------!
156      istp = nit000
157#if defined key_c1d
158         DO WHILE ( istp <= nitend .AND. nstop == 0 )
159            CALL stp_c1d( istp )
160            istp = istp + 1
161         END DO
162#else
163          IF( lk_asminc ) THEN
164             IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 )    ! Output background fields
165             IF( ln_asmdin ) THEN                        ! Direct initialization
166                IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 )    ! Tracers
167                IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 )    ! Dynamics
168                IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 )    ! SSH
169             ENDIF
170          ENDIF
171
172#if defined key_agrif
173          CALL Agrif_Regrid()
174#endif
175
176         DO WHILE ( istp <= nitend .AND. nstop == 0 )
177#if defined key_agrif
178            CALL stp                         ! AGRIF: time stepping
179#else
180            IF ( .NOT. ln_diurnal_only ) THEN
181               CALL stp( istp )                 ! standard time stepping
182            ELSE
183               CALL stp_diurnal( istp )        ! time step only the diurnal SST
184            ENDIF 
185#endif
186            istp = istp + 1
187            IF( lk_mpp )   CALL mpp_max( nstop )
188         END DO
189#endif
190
191      IF( ln_diaobs   )   CALL dia_obs_wri
192      !
193      IF( ln_icebergs )   CALL icb_end( nitend )
194
195      !                            !------------------------!
196      !                            !==  finalize the run  ==!
197      !                            !------------------------!
198      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
199      !
200      IF( nstop /= 0 .AND. lwp ) THEN   ! error print
201         WRITE(numout,cform_err)
202         WRITE(numout,*) nstop, ' error have been found'
203      ENDIF
204      !
205#if defined key_agrif
206      IF( .NOT. Agrif_Root() ) THEN
207                         CALL Agrif_ParentGrid_To_ChildGrid()
208         IF( ln_diaobs ) CALL dia_obs_wri
209         IF( nn_timing == 1 )   CALL timing_finalize
210                                CALL Agrif_ChildGrid_To_ParentGrid()
211      ENDIF
212#endif
213      IF( nn_timing == 1 )   CALL timing_finalize
214      !
215      CALL nemo_closefile
216      !
217#if defined key_iomput
218      CALL xios_finalize                  ! end mpp communications with xios
219      IF( lk_oasis )   CALL cpl_finalize  ! end coupling and mpp communications with OASIS
220#else
221      IF( lk_oasis ) THEN
222         CALL cpl_finalize              ! end coupling and mpp communications with OASIS
223      ELSE
224         IF( lk_mpp )   CALL mppstop    ! end mpp communications
225      ENDIF
226#endif
227      !
228   END SUBROUTINE nemo_gcm
229
230
231   SUBROUTINE nemo_init
232      !!----------------------------------------------------------------------
233      !!                     ***  ROUTINE nemo_init  ***
234      !!
235      !! ** Purpose :   initialization of the NEMO GCM
236      !!----------------------------------------------------------------------
237      INTEGER  ::   ji            ! dummy loop indices
238      INTEGER  ::   ilocal_comm   ! local integer
239      INTEGER  ::   ios, inum     !   -      -
240      REAL(wp) ::   ziglo, zjglo, zkglo, zperio   ! local scalars
241      CHARACTER(len=120), DIMENSION(30) ::   cltxt, cltxt2, clnam, clbug
242      !
243      NAMELIST/namctl/ ln_ctl  , nn_print, nn_ictls, nn_ictle,   &
244         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
245         &             nn_timing, nn_diacfl
246      NAMELIST/namcfg/ ln_read_cfg, ln_write_cfg, cp_cfg, jp_cfg, ln_use_jattr
247      !!----------------------------------------------------------------------
248      !
249      cltxt  = ''
250      cltxt2 = ''
251      clnam  = '' 
252      clbug  = ''
253      cxios_context = 'nemo'
254      !
255      !                             ! Open reference namelist and configuration namelist files
256      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
257      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
258      !
259
260!!gm      WRITE(clbug(1),*) ' before namelist / namctl read    nstop', nstop     
261
262      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints
263      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
264901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
265
266      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist : Control prints
267      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
268902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
269
270
271!!gm      WRITE(clbug(2),*) ' before namelist namcfg read    nstop', nstop     
272
273      !
274      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist
275      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
276903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
277
278      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist
279      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
280904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
281
282!!gm      WRITE(clbug(3),*) ' after namelist namcfg read    nstop', nstop
283
284      !                             !--------------------------!
285      !                             !  Set global domain size  !   (control print return in cltxt2)
286      !                             !--------------------------!
287      IF( ln_read_cfg ) THEN              ! Read sizes in configuration "mesh_mask" file
288         CALL iom_open( 'domain_cfg', inum )
289         CALL iom_get( inum, 'jpiglo', ziglo  )   ;   jpiglo = INT( ziglo )
290         CALL iom_get( inum, 'jpjglo', zjglo  )   ;   jpjglo = INT( zjglo )
291         CALL iom_get( inum, 'jpkglo', zkglo  )   ;   jpkglo = INT( zkglo )
292         CALL iom_get( inum, 'jperio', zperio )   ;   jperio = INT( zperio )
293         CALL iom_close( inum )
294         WRITE(cltxt2(1),*) '~~~~~~~~~~   '     
295         WRITE(cltxt2(2),*) 'domain_cfg : domain size read in "domain_cfg" file : jp(i,j,k)glo = '
296         WRITE(cltxt2(3),*) '            ', jpiglo, jpjglo, jpkglo       
297         WRITE(cltxt2(1),*) '~~~~~~~~~~   lateral boudary type of the global domain jperio= ', jperio
298         !       
299      ELSE                                ! user-defined namelist
300         CALL usr_def_nam( cltxt2, clnam, jpiglo, jpjglo, jpkglo, jperio )
301      ENDIF
302      jpk    = jpkglo
303      !
304#if defined key_agrif
305      IF( .NOT. Agrif_Root() ) THEN       ! AGRIF children: specific setting (cf. agrif_user.F90)
306         jpiglo  = nbcellsx + 2 + 2*nbghostcells
307         jpjglo  = nbcellsy + 2 + 2*nbghostcells
308         jpi     = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci
309         jpj     = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj
310         nperio  = 0
311         jperio  = 0
312         ln_use_jattr = .false.
313      ENDIF
314#endif
315      !
316      !                             !--------------------------------------------!
317      !                             !  set communicator & select the local node  !
318      !                             !  NB: mynode also opens output.namelist.dyn !
319      !                             !      on unit number numond on first proc   !
320      !                             !--------------------------------------------!
321#if defined key_iomput
322      IF( Agrif_Root() ) THEN
323         IF( lk_oasis ) THEN
324            CALL cpl_init( "oceanx", ilocal_comm )                     ! nemo local communicator given by oasis
325            CALL xios_initialize( "not used",local_comm=ilocal_comm )    ! send nemo communicator to xios
326         ELSE
327            CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )    ! nemo local communicator given by xios
328         ENDIF
329      ENDIF
330      ! Nodes selection (control print return in cltxt)
331      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
332#else
333      IF( lk_oasis ) THEN
334         IF( Agrif_Root() ) THEN
335            CALL cpl_init( "oceanx", ilocal_comm )                      ! nemo local communicator given by oasis
336         ENDIF
337         ! Nodes selection (control print return in cltxt)
338         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
339      ELSE
340         ilocal_comm = 0
341         ! Nodes selection (control print return in cltxt)
342         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
343      ENDIF
344#endif
345
346      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
347
348      lwm = (narea == 1)                                    ! control of output namelists
349      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
350
351      IF(lwm) THEN
352         ! write merged namelists from earlier to output namelist now that the
353         ! file has been opened in call to mynode. nammpp has already been
354         ! written in mynode (if lk_mpp_mpi)
355         WRITE( numond, namctl )
356         WRITE( numond, namcfg )
357         IF( .NOT.ln_read_cfg ) THEN
358            DO ji = 1, SIZE(clnam)
359               IF( TRIM(clnam (ji)) /= '' )   WRITE(numond, * ) clnam(ji)    ! namusr_def print
360            END DO
361         ENDIF
362      ENDIF
363
364      ! If dimensions of processor grid weren't specified in the namelist file
365      ! then we calculate them here now that we have our communicator size
366      IF( jpni < 1 .OR. jpnj < 1 ) THEN
367#if   defined key_mpp_mpi
368         IF( Agrif_Root() )   CALL nemo_partition( mppsize )
369#else
370         jpni  = 1
371         jpnj  = 1
372         jpnij = jpni*jpnj
373#endif
374      ENDIF
375
376      IF( Agrif_Root() ) THEN       ! AGRIF mother: specific setting from jpni and jpnj
377#if defined key_nemocice_decomp
378         jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci    ! first  dim.
379         jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj    ! second dim.
380#else
381         jpi = ( jpiglo     -2*jpreci + (jpni-1) ) / jpni + 2*jpreci    ! first  dim.
382         jpj = ( jpjglo     -2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj    ! second dim.
383#endif
384      ENDIF
385
386!!gm ???    why here  it has already been done in line 301 !
387      jpk = jpkglo                                             ! third dim
388!!gm end
389
390#if defined key_agrif
391      ! simple trick to use same vertical grid as parent but different number of levels:
392      ! Save maximum number of levels in jpkglo, then define all vertical grids with this number.
393      ! Suppress once vertical online interpolation is ok
394      IF(.NOT.Agrif_Root())   jpkglo = Agrif_Parent( jpkglo )
395#endif
396      jpim1 = jpi-1                                            ! inner domain indices
397      jpjm1 = jpj-1                                            !   "           "
398      jpkm1 = jpk-1                                            !   "           "
399      jpij  = jpi*jpj                                          !  jpi x j
400
401      IF(lwp) THEN                            ! open listing units
402         !
403         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
404         !
405
406         DO ji = 1, SIZE(clbug)
407            IF( TRIM(clbug (ji)) /= '' )   WRITE(numout,*) clbug(ji)      ! bug print
408         END DO
409         WRITE(numout,*)
410
411
412
413
414         WRITE(numout,*)
415         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
416         WRITE(numout,*) '                       NEMO team'
417         WRITE(numout,*) '            Ocean General Circulation Model'
418         WRITE(numout,*) '                  version 3.7  (2016) '
419         WRITE(numout,*)
420         WRITE(numout,*)
421         DO ji = 1, SIZE(cltxt)
422            IF( TRIM(cltxt (ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
423         END DO
424         WRITE(numout,*)
425         WRITE(numout,*)
426         DO ji = 1, SIZE(cltxt2)
427!            IF( TRIM(cltxt2(ji)) /= '' )   WRITE(numout,*) cltxt2(ji)     ! control print of domain size
428            IF( cltxt2(ji) /= '' )   WRITE(numout,*) cltxt2(ji)     ! control print of domain size
429         END DO
430         !
431         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
432         !
433      ENDIF
434
435      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
436      CALL nemo_alloc()
437      !                             !-------------------------------!
438      !                             !  NEMO general initialization  !
439      !                             !-------------------------------!
440
441      CALL nemo_ctl                          ! Control prints
442
443      !                                      ! Domain decomposition
444      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
445      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
446      ENDIF
447      !
448      IF( nn_timing == 1 )  CALL timing_init
449      !
450      !                                      ! General initialization
451                            CALL     phy_cst    ! Physical constants
452                            CALL     eos_init   ! Equation of state
453      IF( lk_c1d        )   CALL     c1d_init   ! 1D column configuration
454                            CALL     wad_init   ! Wetting and drying options
455                            CALL     dom_init   ! Domain
456      IF( ln_crs        )   CALL     crs_init   ! coarsened grid: domain initialization
457      IF( ln_nnogather )    CALL nemo_northcomms! northfold neighbour lists (must be done after the masks are defined)
458      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
459     
460      CALL diurnal_sst_bulk_init            ! diurnal sst
461      IF ( ln_diurnal ) CALL diurnal_sst_coolskin_init   ! cool skin   
462     
463      ! IF ln_diurnal_only, then we only want a subset of the initialisation routines
464      IF ( ln_diurnal_only ) THEN
465         CALL  istate_init   ! ocean initial state (Dynamics and tracers)
466         CALL     sbc_init   ! Forcings : surface module
467         CALL tra_qsr_init   ! penetrative solar radiation qsr
468         IF( ln_diaobs     ) THEN                  ! Observation & model comparison
469            CALL dia_obs_init            ! Initialize observational data
470            CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
471         ENDIF     
472         !                                     ! Assimilation increments
473         IF( lk_asminc     )   CALL asm_inc_init   ! Initialize assimilation increments
474                 
475         IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
476         RETURN
477      ENDIF
478     
479                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
480
481      !                                      ! external forcing
482!!gm to be added : creation and call of sbc_apr_init
483      IF( lk_tide       )   CALL    tide_init   ! tidal harmonics
484                            CALL     sbc_init   ! surface boundary conditions (including sea-ice)
485!!gm ==>> bdy_init should call bdy_dta_init and bdytide_init  NOT in nemogcm !!!
486      IF( lk_bdy        )   CALL     bdy_init   ! Open boundaries initialisation
487      IF( lk_bdy        )   CALL bdy_dta_init   ! Open boundaries initialisation of external data arrays
488      IF( lk_bdy .AND. lk_tide )   &
489         &                  CALL bdytide_init   ! Open boundaries initialisation of tidal harmonic forcing
490         
491      !                                      ! Ocean physics
492      !                                         ! Vertical physics
493                            CALL     zdf_init      ! namelist read
494                            CALL zdf_bfr_init      ! bottom friction
495      IF( lk_zdfric     )   CALL zdf_ric_init      ! Richardson number dependent Kz
496      IF( lk_zdftke     )   CALL zdf_tke_init      ! TKE closure scheme
497      IF( lk_zdfgls     )   CALL zdf_gls_init      ! GLS closure scheme
498      IF( lk_zdftmx     )   CALL zdf_tmx_init      ! tidal vertical mixing
499      IF( lk_zdfddm     )   CALL zdf_ddm_init      ! double diffusive mixing
500         
501      !                                         ! Lateral physics
502                            CALL ldf_tra_init      ! Lateral ocean tracer physics
503                            CALL ldf_eiv_init      ! eddy induced velocity param.
504                            CALL ldf_dyn_init      ! Lateral ocean momentum physics
505
506      !                                         ! Active tracers
507                            CALL tra_qsr_init      ! penetrative solar radiation qsr
508                            CALL tra_bbc_init      ! bottom heat flux
509      IF( lk_trabbl     )   CALL tra_bbl_init      ! advective (and/or diffusive) bottom boundary layer scheme
510                            CALL tra_dmp_init      ! internal tracer damping
511                            CALL tra_adv_init      ! horizontal & vertical advection
512                            CALL tra_ldf_init      ! lateral mixing
513                            CALL tra_zdf_init      ! vertical mixing and after tracer fields
514
515      !                                         ! Dynamics
516      IF( lk_c1d        )   CALL dyn_dmp_init      ! internal momentum damping
517                            CALL dyn_adv_init      ! advection (vector or flux form)
518                            CALL dyn_vor_init      ! vorticity term including Coriolis
519                            CALL dyn_ldf_init      ! lateral mixing
520                            CALL dyn_hpg_init      ! horizontal gradient of Hydrostatic pressure
521                            CALL dyn_zdf_init      ! vertical diffusion
522                            CALL dyn_spg_init      ! surface pressure gradient
523
524#if defined key_top
525      !                                      ! Passive tracers
526                            CALL     trc_init
527#endif
528      IF( l_ldfslp      )   CALL ldf_slp_init   ! slope of lateral mixing
529
530      !                                      ! Icebergs
531                            CALL icb_init( rdt, nit000)   ! initialise icebergs instance
532
533      !                                      ! Misc. options
534                            CALL sto_par_init   ! Stochastic parametrization
535      IF( ln_sto_eos     )  CALL sto_pts_init   ! RRandom T/S fluctuations
536     
537      !                                      ! Diagnostics
538      IF( lk_floats     )   CALL     flo_init   ! drifting Floats
539                            CALL dia_cfl_init   ! Initialise CFL diagnostics
540      IF( lk_diaar5     )   CALL dia_ar5_init   ! ar5 diag
541                            CALL dia_ptr_init   ! Poleward TRansports initialization
542      IF( lk_diadct     )   CALL dia_dct_init   ! Sections tranports
543                            CALL dia_hsb_init   ! heat content, salt content and volume budgets
544                            CALL     trd_init   ! Mixed-layer/Vorticity/Integral constraints trends
545                            CALL dia_obs_init            ! Initialize observational data
546      IF( ln_diaobs     )   CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
547
548      !                                         ! Assimilation increments
549      IF( lk_asminc     )   CALL asm_inc_init   ! Initialize assimilation increments
550      IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
551                            CALL dia_tmb_init  ! TMB outputs
552                            CALL dia_25h_init  ! 25h mean  outputs
553
554      !
555   END SUBROUTINE nemo_init
556
557
558   SUBROUTINE nemo_ctl
559      !!----------------------------------------------------------------------
560      !!                     ***  ROUTINE nemo_ctl  ***
561      !!
562      !! ** Purpose :   control print setting
563      !!
564      !! ** Method  : - print namctl information and check some consistencies
565      !!----------------------------------------------------------------------
566      !
567      IF(lwp) THEN                  ! control print
568         WRITE(numout,*)
569         WRITE(numout,*) 'nemo_ctl: Control prints'
570         WRITE(numout,*) '~~~~~~~ '
571         WRITE(numout,*) '   Namelist namctl'
572         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
573         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
574         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
575         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
576         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
577         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
578         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
579         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
580         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
581      ENDIF
582      !
583      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
584      nictls    = nn_ictls
585      nictle    = nn_ictle
586      njctls    = nn_jctls
587      njctle    = nn_jctle
588      isplt     = nn_isplt
589      jsplt     = nn_jsplt
590
591      IF(lwp) THEN                  ! control print
592         WRITE(numout,*)
593         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
594         WRITE(numout,*) '~~~~~~~ '
595         WRITE(numout,*) '   Namelist namcfg'
596         WRITE(numout,*) '      read configuration definition files          ln_read_cfg = ', ln_read_cfg
597         WRITE(numout,*) '      configuration name                               cp_cfg  = ', TRIM(cp_cfg)
598         WRITE(numout,*) '      configuration resolution                         jp_cfg  = ', jp_cfg
599         WRITE(numout,*) '      use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
600      ENDIF
601      !                             ! Parameter control
602      !
603      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
604         IF( lk_mpp .AND. jpnij > 1 ) THEN
605            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
606         ELSE
607            IF( isplt == 1 .AND. jsplt == 1  ) THEN
608               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
609                  &           ' - the print control will be done over the whole domain' )
610            ENDIF
611            ijsplt = isplt * jsplt            ! total number of processors ijsplt
612         ENDIF
613         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
614         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
615         !
616         !                              ! indices used for the SUM control
617         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
618            lsp_area = .FALSE.
619         ELSE                                             ! print control done over a specific  area
620            lsp_area = .TRUE.
621            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
622               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
623               nictls = 1
624            ENDIF
625            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
626               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
627               nictle = jpiglo
628            ENDIF
629            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
630               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
631               njctls = 1
632            ENDIF
633            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
634               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
635               njctle = jpjglo
636            ENDIF
637         ENDIF
638      ENDIF
639      !
640      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
641         &                                               'f2003 standard. '                              ,  &
642         &                                               'Compile with key_nosignedzero enabled' )
643      !
644   END SUBROUTINE nemo_ctl
645
646
647   SUBROUTINE nemo_closefile
648      !!----------------------------------------------------------------------
649      !!                     ***  ROUTINE nemo_closefile  ***
650      !!
651      !! ** Purpose :   Close the files
652      !!----------------------------------------------------------------------
653      !
654      IF( lk_mpp )   CALL mppsync
655      !
656      CALL iom_close                                 ! close all input/output files managed by iom_*
657      !
658      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
659      IF( numsol          /= -1 )   CLOSE( numsol          )   ! solver file
660      IF( numnam_ref      /= -1 )   CLOSE( numnam_ref      )   ! oce reference namelist
661      IF( numnam_cfg      /= -1 )   CLOSE( numnam_cfg      )   ! oce configuration namelist
662      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
663      IF( numnam_ice_ref  /= -1 )   CLOSE( numnam_ice_ref  )   ! ice reference namelist
664      IF( numnam_ice_cfg  /= -1 )   CLOSE( numnam_ice_cfg  )   ! ice configuration namelist
665      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
666      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
667      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
668      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
669      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
670      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
671      !
672      numout = 6                                     ! redefine numout in case it is used after this point...
673      !
674   END SUBROUTINE nemo_closefile
675
676
677   SUBROUTINE nemo_alloc
678      !!----------------------------------------------------------------------
679      !!                     ***  ROUTINE nemo_alloc  ***
680      !!
681      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
682      !!
683      !! ** Method  :
684      !!----------------------------------------------------------------------
685      USE diawri    , ONLY: dia_wri_alloc
686      USE dom_oce   , ONLY: dom_oce_alloc
687      USE trc_oce   , ONLY: trc_oce_alloc
688#if defined key_diadct 
689      USE diadct    , ONLY: diadct_alloc 
690#endif 
691#if defined key_bdy
692      USE bdy_oce   , ONLY: bdy_oce_alloc
693#endif
694      !
695      INTEGER :: ierr
696      !!----------------------------------------------------------------------
697      !
698      ierr =        oce_alloc       ()          ! ocean
699      ierr = ierr + dia_wri_alloc   ()
700      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
701      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
702      !
703      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
704      !
705#if defined key_diadct 
706      ierr = ierr + diadct_alloc    ()          !
707#endif 
708#if defined key_bdy
709      ierr = ierr + bdy_oce_alloc   ()          ! bdy masks (incl. initialization)
710#endif
711      !
712      IF( lk_mpp    )   CALL mpp_sum( ierr )
713      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
714      !
715   END SUBROUTINE nemo_alloc
716
717
718   SUBROUTINE nemo_partition( num_pes )
719      !!----------------------------------------------------------------------
720      !!                 ***  ROUTINE nemo_partition  ***
721      !!
722      !! ** Purpose :
723      !!
724      !! ** Method  :
725      !!----------------------------------------------------------------------
726      INTEGER, INTENT(in) ::   num_pes   ! The number of MPI processes we have
727      !
728      INTEGER, PARAMETER :: nfactmax = 20
729      INTEGER :: nfact ! The no. of factors returned
730      INTEGER :: ierr  ! Error flag
731      INTEGER :: ji
732      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
733      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
734      !!----------------------------------------------------------------------
735      !
736      ierr = 0
737      !
738      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
739      !
740      IF( nfact <= 1 ) THEN
741         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
742         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
743         jpnj = 1
744         jpni = num_pes
745      ELSE
746         ! Search through factors for the pair that are closest in value
747         mindiff = 1000000
748         imin    = 1
749         DO ji = 1, nfact-1, 2
750            idiff = ABS( ifact(ji) - ifact(ji+1) )
751            IF( idiff < mindiff ) THEN
752               mindiff = idiff
753               imin = ji
754            ENDIF
755         END DO
756         jpnj = ifact(imin)
757         jpni = ifact(imin + 1)
758      ENDIF
759      !
760      jpnij = jpni*jpnj
761      !
762   END SUBROUTINE nemo_partition
763
764
765   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
766      !!----------------------------------------------------------------------
767      !!                     ***  ROUTINE factorise  ***
768      !!
769      !! ** Purpose :   return the prime factors of n.
770      !!                knfax factors are returned in array kfax which is of
771      !!                maximum dimension kmaxfax.
772      !! ** Method  :
773      !!----------------------------------------------------------------------
774      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
775      INTEGER                    , INTENT(  out) ::   kerr, knfax
776      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
777      !
778      INTEGER :: ifac, jl, inu
779      INTEGER, PARAMETER :: ntest = 14
780      INTEGER, DIMENSION(ntest) ::   ilfax
781      !!----------------------------------------------------------------------
782      !
783      ! lfax contains the set of allowed factors.
784      ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
785      !
786      ! Clear the error flag and initialise output vars
787      kerr  = 0
788      kfax  = 1
789      knfax = 0
790      !
791      ! Find the factors of n.
792      IF( kn == 1 )   GOTO 20
793
794      ! nu holds the unfactorised part of the number.
795      ! knfax holds the number of factors found.
796      ! l points to the allowed factor list.
797      ! ifac holds the current factor.
798      !
799      inu   = kn
800      knfax = 0
801      !
802      DO jl = ntest, 1, -1
803         !
804         ifac = ilfax(jl)
805         IF( ifac > inu )   CYCLE
806
807         ! Test whether the factor will divide.
808
809         IF( MOD(inu,ifac) == 0 ) THEN
810            !
811            knfax = knfax + 1            ! Add the factor to the list
812            IF( knfax > kmaxfax ) THEN
813               kerr = 6
814               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
815               return
816            ENDIF
817            kfax(knfax) = ifac
818            ! Store the other factor that goes with this one
819            knfax = knfax + 1
820            kfax(knfax) = inu / ifac
821            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
822         ENDIF
823         !
824      END DO
825      !
826   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
827      !
828   END SUBROUTINE factorise
829
830#if defined key_mpp_mpi
831
832   SUBROUTINE nemo_northcomms
833      !!----------------------------------------------------------------------
834      !!                     ***  ROUTINE  nemo_northcomms  ***
835      !! ** Purpose :   Setup for north fold exchanges with explicit
836      !!                point-to-point messaging
837      !!
838      !! ** Method :   Initialization of the northern neighbours lists.
839      !!----------------------------------------------------------------------
840      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
841      !!    2.0  ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
842      !!----------------------------------------------------------------------
843      INTEGER  ::   sxM, dxM, sxT, dxT, jn
844      INTEGER  ::   njmppmax
845      !!----------------------------------------------------------------------
846      !
847      njmppmax = MAXVAL( njmppt )
848      !
849      !initializes the north-fold communication variables
850      isendto(:) = 0
851      nsndto     = 0
852      !
853      !if I am a process in the north
854      IF ( njmpp == njmppmax ) THEN
855          !sxM is the first point (in the global domain) needed to compute the
856          !north-fold for the current process
857          sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
858          !dxM is the last point (in the global domain) needed to compute the
859          !north-fold for the current process
860          dxM = jpiglo - nimppt(narea) + 2
861
862          !loop over the other north-fold processes to find the processes
863          !managing the points belonging to the sxT-dxT range
864 
865          DO jn = 1, jpni
866                !sxT is the first point (in the global domain) of the jn
867                !process
868                sxT = nfiimpp(jn, jpnj)
869                !dxT is the last point (in the global domain) of the jn
870                !process
871                dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
872                IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
873                   nsndto = nsndto + 1
874                     isendto(nsndto) = jn
875                ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
876                   nsndto = nsndto + 1
877                     isendto(nsndto) = jn
878                ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
879                   nsndto = nsndto + 1
880                     isendto(nsndto) = jn
881                END IF
882          END DO
883          nfsloop = 1
884          nfeloop = nlci
885          DO jn = 2,jpni-1
886           IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
887              IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
888                 nfsloop = nldi
889              ENDIF
890              IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
891                 nfeloop = nlei
892              ENDIF
893           ENDIF
894        END DO
895
896      ENDIF
897      l_north_nogather = .TRUE.
898   END SUBROUTINE nemo_northcomms
899
900#else
901   SUBROUTINE nemo_northcomms      ! Dummy routine
902      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
903   END SUBROUTINE nemo_northcomms
904#endif
905
906   !!======================================================================
907END MODULE nemogcm
908
Note: See TracBrowser for help on using the repository browser.