source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 10149

Last change on this file since 10149 was 10149, checked in by frrh, 23 months ago

Met Office GMED ticket 379: Merged David Ford's MEDUSA assimilation changes
using command:

svn merge -r 10054:10141 svn+ssh://forge.ipsl.jussieu.fr/ipsl/forge/projets/nemo/svn/branches/UKMO/dev_r5518_GO6_package_asm_3d_bgc_v3

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