New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
nemogcm.F90 in branches/UKMO/AMM15_v3_6_STABLE_package_collate_utils366_fabmv1/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/UKMO/AMM15_v3_6_STABLE_package_collate_utils366_fabmv1/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 13462

Last change on this file since 13462 was 13462, checked in by dford, 21 months ago

Tidy up.

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