source: branches/UKMO/AMM15_v3_6_STABLE_package_reanalysis2/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 11039

Last change on this file since 11039 was 11039, checked in by rrenshaw, 19 months ago

code fix

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