source: trunk/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5118

Last change on this file since 5118 was 5118, checked in by acc, 6 years ago

Merge changes from dev_r5087_NOC2_JATTR (see #1472) into trunk following successful SETTE tests

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