source: branches/UKMO/dev_r5107_hadgem3_cplseq/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5572

Last change on this file since 5572 was 5572, checked in by davestorkey, 6 years ago

Update UKMO/dev_r5107_hadgem3_cplseq branch to trunk revision 5518
(= branching point of NEMO 3.6_stable).

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