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/2013/dev_LOCEAN_2013/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/2013/dev_LOCEAN_2013/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 4147

Last change on this file since 4147 was 4147, checked in by cetlod, 10 years ago

merge in dev_LOCEAN_2013, the 1st development branch dev_r3853_CNRS9_Confsetting, from its starting point ( r3853 ) on the trunk: see ticket #1169

  • Property svn:keywords set to Id
File size: 40.9 KB
RevLine 
[2496]1MODULE nemogcm
[2442]2   !!======================================================================
[2496]3   !!                       ***  MODULE nemogcm   ***
4   !! Ocean system   : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
[2442]5   !!======================================================================
[1593]6   !! History :  OPA  ! 1990-10  (C. Levy, G. Madec)  Original code
7   !!            7.0  ! 1991-11  (M. Imbard, C. Levy, G. Madec)
[3764]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
[1593]10   !!             -   ! 1992-06  (L.Terray)  coupling implementation
[3764]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,
[2104]13   !!                             P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
[1593]14   !!            8.1  ! 1997-06  (M. Imbard, G. Madec)
[3764]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
[1593]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
[3764]27   !!            3.3  ! 2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
[2236]28   !!             -   ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
[3294]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
[1593]31   !!----------------------------------------------------------------------
[3]32
33   !!----------------------------------------------------------------------
[2496]34   !!   nemo_gcm       : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
35   !!   nemo_init      : initialization of the NEMO system
[3764]36   !!   nemo_ctl       : initialisation of the contol print
[2496]37   !!   nemo_closefile : close remaining open files
[2715]38   !!   nemo_alloc     : dynamical allocation
39   !!   nemo_partition : calculate MPP domain decomposition
40   !!   factorise      : calculate the factors of the no. of MPI processes
[3]41   !!----------------------------------------------------------------------
[2382]42   USE step_oce        ! module used in the ocean time stepping module
[888]43   USE sbc_oce         ! surface boundary condition: ocean
[2392]44   USE cla             ! cross land advection               (tra_cla routine)
[3]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)
[3625]48#if defined key_nemocice_decomp
49   USE ice_domain_size, only: nx_global, ny_global
50#endif
[3651]51   USE tideini         ! tidal components initialization   (tide_ini routine)
[3]52   USE obcini          ! open boundary cond. initialization (obc_ini routine)
[3294]53   USE bdyini          ! open boundary cond. initialization (bdy_init routine)
54   USE bdydta          ! open boundary cond. initialization (bdy_dta_init routine)
[3651]55   USE bdytides        ! open boundary cond. initialization (bdytide_init routine)
[3]56   USE istate          ! initial state setting          (istate_init routine)
57   USE ldfdyn          ! lateral viscosity setting      (ldfdyn_init routine)
58   USE ldftra          ! lateral diffusivity setting    (ldftra_init routine)
[2392]59   USE zdfini          ! vertical physics setting          (zdf_init routine)
[3]60   USE phycst          ! physical constant                  (par_cst routine)
[2236]61   USE trdmod          ! momentum/tracers trends       (trd_mod_init routine)
[3768]62   USE asminc          ! assimilation increments     
63   USE asmbkg          ! writing out state trajectory
[2236]64   USE diaptr          ! poleward transports           (dia_ptr_init routine)
[3294]65   USE diadct          ! sections transports           (dia_dct_init routine)
[2236]66   USE diaobs          ! Observation diagnostics       (dia_obs_init routine)
[3764]67   USE lib_fortran     ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[2496]68   USE step            ! NEMO time-stepping                 (stp     routine)
[3609]69   USE icbini          ! handle bergs, initialisation
70   USE icbstp          ! handle bergs, calving, themodynamics and transport
[532]71#if defined key_oasis3
[1359]72   USE cpl_oasis3      ! OASIS3 coupling
[599]73#elif defined key_oasis4
[1359]74   USE cpl_oasis4      ! OASIS4 coupling (not working)
[532]75#endif
[900]76   USE c1d             ! 1D configuration
77   USE step_c1d        ! Time stepping loop for the 1D configuration
[1594]78#if defined key_top
[1593]79   USE trcini          ! passive tracer initialisation
[1594]80#endif
[1593]81   USE lib_mpp         ! distributed memory computing
[1412]82#if defined key_iomput
[3701]83   USE xios
[1359]84#endif
[3651]85   USE sbctide, ONLY: lk_tide
[268]86
[2715]87   IMPLICIT NONE
[3]88   PRIVATE
89
[2496]90   PUBLIC   nemo_gcm    ! called by model.F90
91   PUBLIC   nemo_init   ! needed by AGRIF
[3764]92   PUBLIC   nemo_alloc  ! needed by TAM
[467]93
[2498]94   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
[1593]95
[3]96   !!----------------------------------------------------------------------
[2715]97   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
[2392]98   !! $Id$
[2329]99   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
[3]100   !!----------------------------------------------------------------------
101CONTAINS
102
[2496]103   SUBROUTINE nemo_gcm
[3]104      !!----------------------------------------------------------------------
[2496]105      !!                     ***  ROUTINE nemo_gcm  ***
[3]106      !!
[3764]107      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
[1593]108      !!              curvilinear mesh on the sphere.
[3]109      !!
110      !! ** Method  : - model general initialization
111      !!              - launch the time-stepping (stp routine)
[1593]112      !!              - finalize the run by closing files and communications
[3]113      !!
[2715]114      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
[1593]115      !!              Madec, 2008, internal report, IPSL.
[3]116      !!----------------------------------------------------------------------
117      INTEGER ::   istp       ! time step index
[389]118      !!----------------------------------------------------------------------
[2382]119      !
[4147]120
[392]121#if defined key_agrif
[1593]122      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
[389]123#endif
124
[1593]125      !                            !-----------------------!
[2496]126      CALL nemo_init               !==  Initialisations  ==!
[1593]127      !                            !-----------------------!
[2715]128#if defined key_agrif
[3680]129      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
130      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
[2715]131# if defined key_top
[3680]132      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
[2715]133# endif
[3680]134# if defined key_lim2
135      CALL Agrif_Declare_Var_lim2  !  "      "   "   "      "  LIM
136# endif
[2715]137#endif
[4147]138
[682]139      ! check that all process are still there... If some process have an error,
140      ! they will never enter in step and other processes will wait until the end of the cpu time!
[900]141      IF( lk_mpp )   CALL mpp_max( nstop )
[682]142
[1593]143      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
144
145      !                            !-----------------------!
146      !                            !==   time stepping   ==!
147      !                            !-----------------------!
[900]148      istp = nit000
[2236]149#if defined key_c1d
[389]150         DO WHILE ( istp <= nitend .AND. nstop == 0 )
[900]151            CALL stp_c1d( istp )
[389]152            istp = istp + 1
153         END DO
[2236]154#else
155          IF( lk_asminc ) THEN
156             IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 )    ! Output background fields
157             IF( ln_asmdin ) THEN                        ! Direct initialization
158                IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 )    ! Tracers
[3764]159                IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 )    ! Dynamics
[2236]160                IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 )    ! SSH
161             ENDIF
162          ENDIF
[3764]163
[389]164         DO WHILE ( istp <= nitend .AND. nstop == 0 )
[4147]165
[392]166#if defined key_agrif
[1593]167            CALL Agrif_Step( stp )           ! AGRIF: time stepping
[389]168#else
[1593]169            CALL stp( istp )                 ! standard time stepping
[389]170#endif
[4147]171
[389]172            istp = istp + 1
[900]173            IF( lk_mpp )   CALL mpp_max( nstop )
[389]174         END DO
[2236]175#endif
176
[3609]177      IF( lk_diaobs   )   CALL dia_obs_wri
178      !
179      IF( ln_icebergs )   CALL icb_end( nitend )
[3764]180
[1593]181      !                            !------------------------!
182      !                            !==  finalize the run  ==!
183      !                            !------------------------!
184      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
185      !
186      IF( nstop /= 0 .AND. lwp ) THEN   ! error print
[682]187         WRITE(numout,cform_err)
[3764]188         WRITE(numout,*) nstop, ' error have been found'
[389]189      ENDIF
[1593]190      !
[3294]191#if defined key_agrif
192      CALL Agrif_ParentGrid_To_ChildGrid()
193      IF( lk_diaobs ) CALL dia_obs_wri
194      IF( nn_timing == 1 )   CALL timing_finalize
195      CALL Agrif_ChildGrid_To_ParentGrid()
196#endif
197      IF( nn_timing == 1 )   CALL timing_finalize
198      !
[2496]199      CALL nemo_closefile
[3769]200#if defined key_iomput
201      CALL xios_finalize                ! end mpp communications with xios
202# if defined key_oasis3 || defined key_oasis4
[1976]203      CALL cpl_prism_finalize           ! end coupling and mpp communications with OASIS
[3769]204# endif
[532]205#else
[3769]206# if defined key_oasis3 || defined key_oasis4
207      CALL cpl_prism_finalize           ! end coupling and mpp communications with OASIS
[3701]208# else
[1593]209      IF( lk_mpp )   CALL mppstop       ! end mpp communications
[3701]210# endif
[532]211#endif
[900]212      !
[2496]213   END SUBROUTINE nemo_gcm
[389]214
215
[2496]216   SUBROUTINE nemo_init
[389]217      !!----------------------------------------------------------------------
[2496]218      !!                     ***  ROUTINE nemo_init  ***
[389]219      !!
[2496]220      !! ** Purpose :   initialization of the NEMO GCM
[389]221      !!----------------------------------------------------------------------
[2715]222      INTEGER ::   ji            ! dummy loop indices
223      INTEGER ::   ilocal_comm   ! local integer
[4147]224      INTEGER ::   ios
[2715]225      CHARACTER(len=80), DIMENSION(16) ::   cltxt
[1593]226      !!
[4147]227      NAMELIST/namctl/ ln_ctl, nn_print, nn_ictls, nn_ictle,   &
[3294]228         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
229         &             nn_bench, nn_timing
[4147]230      NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, &
231         &             jpizoom, jpjzoom, jperio
[3]232      !!----------------------------------------------------------------------
[1593]233      !
[2496]234      cltxt = ''
235      !
[4147]236      !                             ! Open reference namelist and configuration namelist files
237      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
238      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
239      CALL ctl_opn( numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]240      !
[4147]241      REWIND( numnam_ref )              ! Namelist namctl in reference namelist : Control prints & Benchmark
242      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
243901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', lwp )
244
245      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist : Control prints & Benchmark
246      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
247902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', lwp )
248      WRITE( numond, namctl )
249
[1593]250      !
[4147]251      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist : Control prints & Benchmark
252      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
253903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', lwp )
254
255      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist : Control prints & Benchmark
256      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
257904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', lwp )   
258      WRITE( numond, namcfg )
259! Force values for AGRIF zoom (cf. agrif_user.F90)
260#if defined key_agrif
261   IF( .NOT. Agrif_Root() ) THEN
262      jpiglo  = nbcellsx + 2 + 2*nbghostcells
263      jpjglo  = nbcellsy + 2 + 2*nbghostcells
264      jpi     = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci
265      jpj     = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj
266      jpidta  = jpiglo
267      jpjdta  = jpjglo
268      jpizoom = 1
269      jpjzoom = 1
270      nperio  = 0
271      jperio  = 0
272   ENDIF
273#endif
274      !
[1593]275      !                             !--------------------------------------------!
276      !                             !  set communicator & select the local node  !
277      !                             !--------------------------------------------!
[1412]278#if defined key_iomput
[2200]279      IF( Agrif_Root() ) THEN
[1412]280# if defined key_oasis3 || defined key_oasis4
[3701]281         CALL cpl_prism_init( ilocal_comm )      ! nemo local communicator given by oasis
282         CALL xios_initialize( "oceanx",local_comm=ilocal_comm )
283# else
284         CALL  xios_initialize( "nemo",return_comm=ilocal_comm )
[1412]285# endif
[2200]286      ENDIF
[4147]287      narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )   ! Nodes selection
[532]288#else
[1412]289# if defined key_oasis3 || defined key_oasis4
[2236]290      IF( Agrif_Root() ) THEN
[2715]291         CALL cpl_prism_init( ilocal_comm )                 ! nemo local communicator given by oasis
[2236]292      ENDIF
[4147]293      narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )   ! Nodes selection (control print return in cltxt)
[1412]294# else
[2082]295      ilocal_comm = 0
[4147]296      narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop )                 ! Nodes selection (control print return in cltxt)
[1412]297# endif
[532]298#endif
[2715]299      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
[3]300
[2715]301      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
[1579]302
[3764]303      ! If dimensions of processor grid weren't specified in the namelist file
[2715]304      ! then we calculate them here now that we have our communicator size
305      IF( (jpni < 1) .OR. (jpnj < 1) )THEN
306#if   defined key_mpp_mpi
307         IF( Agrif_Root() ) CALL nemo_partition(mppsize)
308#else
309         jpni  = 1
310         jpnj  = 1
311         jpnij = jpni*jpnj
312#endif
313      END IF
314
315      ! Calculate domain dimensions given calculated jpni and jpnj
316      ! This used to be done in par_oce.F90 when they were parameters rather
317      ! than variables
318      IF( Agrif_Root() ) THEN
[3294]319#if defined key_nemocice_decomp
[3625]320         jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first  dim.
321         jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim.
[3294]322#else
[3625]323         jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   ! first  dim.
[2715]324         jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   ! second dim.
[3294]325#endif
[4147]326      ENDIF
[2715]327         jpk = jpkdta                                             ! third dim
328         jpim1 = jpi-1                                            ! inner domain indices
329         jpjm1 = jpj-1                                            !   "           "
330         jpkm1 = jpk-1                                            !   "           "
331         jpij  = jpi*jpj                                          !  jpi x j
332
[1593]333      IF(lwp) THEN                            ! open listing units
334         !
[1581]335         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]336         !
[1579]337         WRITE(numout,*)
[3294]338         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]339         WRITE(numout,*) '                       NEMO team'
[1579]340         WRITE(numout,*) '            Ocean General Circulation Model'
[3294]341         WRITE(numout,*) '                  version 3.4  (2011) '
[1579]342         WRITE(numout,*)
343         WRITE(numout,*)
[3764]344         DO ji = 1, SIZE(cltxt)
[1593]345            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
[1579]346         END DO
[1593]347         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
348         !
[473]349      ENDIF
[2715]350
[3764]351      ! Now we know the dimensions of the grid and numout has been set we can
[2715]352      ! allocate arrays
353      CALL nemo_alloc()
354
[2496]355      !                             !-------------------------------!
356      !                             !  NEMO general initialization  !
357      !                             !-------------------------------!
[473]358
[2496]359      CALL nemo_ctl                          ! Control prints & Benchmark
[531]360
[2082]361      !                                      ! Domain decomposition
[1593]362      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
363      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
[3]364      ENDIF
[2382]365      !
[3294]366      IF( nn_timing == 1 )  CALL timing_init
367      !
[2082]368      !                                      ! General initialization
[2027]369                            CALL     phy_cst    ! Physical constants
370                            CALL     eos_init   ! Equation of state
371                            CALL     dom_cfg    ! Domain configuration
372                            CALL     dom_init   ! Domain
[413]373
[3294]374      IF( ln_nnogather )    CALL nemo_northcomms   ! Initialise the northfold neighbour lists (must be done after the masks are defined)
375
[2027]376      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
377
[3764]378      IF( lk_obc        )   CALL     obc_init   ! Open boundaries
[3651]379
380                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
381
382      IF( lk_tide       )   CALL tide_init( nit000 )    ! Initialisation of the tidal harmonics
383
[3294]384      IF( lk_bdy        )   CALL     bdy_init       ! Open boundaries initialisation
385      IF( lk_bdy        )   CALL     bdy_dta_init   ! Open boundaries initialisation of external data arrays
[3651]386      IF( lk_bdy        )   CALL     bdytide_init   ! Open boundaries initialisation of tidal harmonic forcing
[2027]387
[3294]388                            CALL dyn_nept_init  ! simplified form of Neptune effect
389
[3]390      !                                     ! Ocean physics
[3764]391                            CALL     sbc_init   ! Forcings : surface module
[2082]392      !                                         ! Vertical physics
[4147]393
[2082]394                            CALL     zdf_init      ! namelist read
[4147]395
[2082]396                            CALL zdf_bfr_init      ! bottom friction
[4147]397
[2082]398      IF( lk_zdfric     )   CALL zdf_ric_init      ! Richardson number dependent Kz
[2329]399      IF( lk_zdftke     )   CALL zdf_tke_init      ! TKE closure scheme
400      IF( lk_zdfgls     )   CALL zdf_gls_init      ! GLS closure scheme
401      IF( lk_zdfkpp     )   CALL zdf_kpp_init      ! KPP closure scheme
[2082]402      IF( lk_zdftmx     )   CALL zdf_tmx_init      ! tidal vertical mixing
[3764]403      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
[2082]404         &                  CALL zdf_ddm_init      ! double diffusive mixing
405      !                                         ! Lateral physics
406                            CALL ldf_tra_init      ! Lateral ocean tracer physics
407                            CALL ldf_dyn_init      ! Lateral ocean momentum physics
[2392]408      IF( lk_ldfslp     )   CALL ldf_slp_init      ! slope of lateral mixing
[2082]409
[2027]410      !                                     ! Active tracers
411                            CALL tra_qsr_init   ! penetrative solar radiation qsr
[2325]412                            CALL tra_bbc_init   ! bottom heat flux
[2027]413      IF( lk_trabbl     )   CALL tra_bbl_init   ! advective (and/or diffusive) bottom boundary layer scheme
[3294]414      IF( ln_tradmp     )   CALL tra_dmp_init   ! internal damping trends
[2027]415                            CALL tra_adv_init   ! horizontal & vertical advection
416                            CALL tra_ldf_init   ! lateral mixing
417                            CALL tra_zdf_init   ! vertical mixing and after tracer fields
418
419      !                                     ! Dynamics
420                            CALL dyn_adv_init   ! advection (vector or flux form)
[2104]421                            CALL dyn_vor_init   ! vorticity term including Coriolis
[2027]422                            CALL dyn_ldf_init   ! lateral mixing
[2104]423                            CALL dyn_hpg_init   ! horizontal gradient of Hydrostatic pressure
[2027]424                            CALL dyn_zdf_init   ! vertical diffusion
425                            CALL dyn_spg_init   ! surface pressure gradient
[3764]426
[2392]427      !                                     ! Misc. options
[4147]428      IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 )   CALL cla_init       ! Cross Land Advection
[3609]429                            CALL icb_init( rdt, nit000)   ! initialise icebergs instance
[4147]430     
[1594]431#if defined key_top
[2027]432      !                                     ! Passive tracers
[2082]433                            CALL     trc_init
[1594]434#endif
[4147]435      !
436 
437                                            ! Diagnostics
[3294]438      IF( lk_floats     )   CALL     flo_init   ! drifting Floats
[2392]439      IF( lk_diaar5     )   CALL dia_ar5_init   ! ar5 diag
[2027]440                            CALL dia_ptr_init   ! Poleward TRansports initialization
[3294]441      IF( lk_diadct     )   CALL dia_dct_init   ! Sections tranports
[2148]442                            CALL dia_hsb_init   ! heat content, salt content and volume budgets
[2027]443                            CALL trd_mod_init   ! Mixed-layer/Vorticity/Integral constraints trends
[2392]444      IF( lk_diaobs     ) THEN                  ! Observation & model comparison
[2382]445                            CALL dia_obs_init            ! Initialize observational data
446                            CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
[3764]447      ENDIF
[2382]448      !                                     ! Assimilation increments
[2392]449      IF( lk_asminc     )   CALL asm_inc_init   ! Initialize assimilation increments
[2382]450      IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
[1593]451      !
[2496]452   END SUBROUTINE nemo_init
[467]453
454
[2496]455   SUBROUTINE nemo_ctl
[467]456      !!----------------------------------------------------------------------
[2496]457      !!                     ***  ROUTINE nemo_ctl  ***
[467]458      !!
[3764]459      !! ** Purpose :   control print setting
[467]460      !!
[2442]461      !! ** Method  : - print namctl information and check some consistencies
[467]462      !!----------------------------------------------------------------------
[2442]463      !
[2496]464      IF(lwp) THEN                  ! control print
[531]465         WRITE(numout,*)
[2496]466         WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
[531]467         WRITE(numout,*) '~~~~~~~ '
[1593]468         WRITE(numout,*) '   Namelist namctl'
[1601]469         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
470         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
471         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
472         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
473         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
474         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
475         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
476         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
477         WRITE(numout,*) '      benchmark parameter (0/1)       nn_bench   = ', nn_bench
[3610]478         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
[531]479      ENDIF
[2442]480      !
[1601]481      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
482      nictls    = nn_ictls
483      nictle    = nn_ictle
484      njctls    = nn_jctls
485      njctle    = nn_jctle
486      isplt     = nn_isplt
487      jsplt     = nn_jsplt
488      nbench    = nn_bench
[4147]489
490      IF(lwp) THEN                  ! control print
491         WRITE(numout,*)
492         WRITE(numout,*) 'namcfg  : configuration initialization through namelist read'
493         WRITE(numout,*) '~~~~~~~ '
494         WRITE(numout,*) '   Namelist namcfg'
495         WRITE(numout,*) '      configuration name              cp_cfg      = ', TRIM(cp_cfg)
496         WRITE(numout,*) '      configuration zoom name         cp_cfz      = ', TRIM(cp_cfz)
497         WRITE(numout,*) '      configuration resolution        jp_cfg      = ', jp_cfg
498         WRITE(numout,*) '      1st lateral dimension ( >= jpi ) jpidta     = ', jpidta
499         WRITE(numout,*) '      2nd    "         "    ( >= jpj ) jpjdta     = ', jpjdta
500         WRITE(numout,*) '      3nd    "         "               jpkdta     = ', jpkdta
501         WRITE(numout,*) '      1st dimension of global domain in i jpiglo  = ', jpiglo
502         WRITE(numout,*) '      2nd    -                  -    in j jpjglo  = ', jpjglo
503         WRITE(numout,*) '      left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom
504         WRITE(numout,*) '      left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom
505         WRITE(numout,*) '      lateral cond. type (between 0 and 6) jperio = ', jperio   
506      ENDIF
[2442]507      !                             ! Parameter control
[1593]508      !
509      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
[3294]510         IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]511            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
[531]512         ELSE
513            IF( isplt == 1 .AND. jsplt == 1  ) THEN
[1593]514               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
515                  &           ' - the print control will be done over the whole domain' )
[531]516            ENDIF
[1593]517            ijsplt = isplt * jsplt            ! total number of processors ijsplt
[531]518         ENDIF
519         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
520         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
[1593]521         !
522         !                              ! indices used for the SUM control
523         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
[3764]524            lsp_area = .FALSE.
[1593]525         ELSE                                             ! print control done over a specific  area
[531]526            lsp_area = .TRUE.
527            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
528               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
529               nictls = 1
530            ENDIF
531            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
532               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
533               nictle = jpiglo
534            ENDIF
535            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
536               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
537               njctls = 1
538            ENDIF
539            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
540               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
541               njctle = jpjglo
542            ENDIF
[1593]543         ENDIF
544      ENDIF
[2442]545      !
[3764]546      IF( nbench == 1 ) THEN              ! Benchmark
[531]547         SELECT CASE ( cp_cfg )
[1593]548         CASE ( 'gyre' )   ;   CALL ctl_warn( ' The Benchmark is activated ' )
549         CASE DEFAULT      ;   CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:',   &
[4147]550            &                                 ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' )
[531]551         END SELECT
552      ENDIF
[1593]553      !
[2496]554      IF( lk_c1d .AND. .NOT.lk_iomput )   CALL ctl_stop( 'nemo_ctl: The 1D configuration must be used ',   &
555         &                                               'with the IOM Input/Output manager. '         ,   &
[2442]556         &                                               'Compile with key_iomput enabled' )
[2409]557      !
[3764]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      !
[2496]562   END SUBROUTINE nemo_ctl
[467]563
564
[2496]565   SUBROUTINE nemo_closefile
[467]566      !!----------------------------------------------------------------------
[2496]567      !!                     ***  ROUTINE nemo_closefile  ***
[467]568      !!
569      !! ** Purpose :   Close the files
570      !!----------------------------------------------------------------------
[1593]571      !
572      IF( lk_mpp )   CALL mppsync
573      !
[1685]574      CALL iom_close                                 ! close all input/output files managed by iom_*
[1593]575      !
[4147]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( 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( 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
[3294]589
[1593]590      !
[2442]591      numout = 6                                     ! redefine numout in case it is used after this point...
592      !
[2496]593   END SUBROUTINE nemo_closefile
[467]594
[2715]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
[3680]609#if defined key_diadct 
610      USE diadct    , ONLY: diadct_alloc 
611#endif 
[2715]612      !
613      INTEGER :: ierr
614      !!----------------------------------------------------------------------
615      !
[3764]616      ierr =        oce_alloc       ()          ! ocean
[2715]617      ierr = ierr + dia_wri_alloc   ()
618      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
619      ierr = ierr + ldfdyn_oce_alloc()          ! ocean lateral  physics : dynamics
620      ierr = ierr + ldftra_oce_alloc()          ! ocean lateral  physics : tracers
621      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
622      !
623      ierr = ierr + lib_mpp_alloc   (numout)    ! mpp exchanges
624      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
625      !
[3680]626#if defined key_diadct 
627      ierr = ierr + diadct_alloc    ()          !
628#endif 
629      !
[2715]630      IF( lk_mpp    )   CALL mpp_sum( ierr )
631      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
632      !
633   END SUBROUTINE nemo_alloc
634
635
636   SUBROUTINE nemo_partition( num_pes )
637      !!----------------------------------------------------------------------
638      !!                 ***  ROUTINE nemo_partition  ***
639      !!
[3764]640      !! ** Purpose :
[2715]641      !!
642      !! ** Method  :
643      !!----------------------------------------------------------------------
644      INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
645      !
646      INTEGER, PARAMETER :: nfactmax = 20
647      INTEGER :: nfact ! The no. of factors returned
648      INTEGER :: ierr  ! Error flag
649      INTEGER :: ji
650      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
651      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
652      !!----------------------------------------------------------------------
653
654      ierr = 0
655
656      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
657
658      IF( nfact <= 1 ) THEN
659         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
660         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
661         jpnj = 1
662         jpni = num_pes
663      ELSE
664         ! Search through factors for the pair that are closest in value
665         mindiff = 1000000
666         imin    = 1
667         DO ji = 1, nfact-1, 2
668            idiff = ABS( ifact(ji) - ifact(ji+1) )
669            IF( idiff < mindiff ) THEN
670               mindiff = idiff
671               imin = ji
672            ENDIF
673         END DO
674         jpnj = ifact(imin)
675         jpni = ifact(imin + 1)
676      ENDIF
677      !
678      jpnij = jpni*jpnj
679      !
680   END SUBROUTINE nemo_partition
681
682
683   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
684      !!----------------------------------------------------------------------
685      !!                     ***  ROUTINE factorise  ***
686      !!
687      !! ** Purpose :   return the prime factors of n.
[3764]688      !!                knfax factors are returned in array kfax which is of
[2715]689      !!                maximum dimension kmaxfax.
690      !! ** Method  :
691      !!----------------------------------------------------------------------
692      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
693      INTEGER                    , INTENT(  out) ::   kerr, knfax
694      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
695      !
696      INTEGER :: ifac, jl, inu
697      INTEGER, PARAMETER :: ntest = 14
698      INTEGER :: ilfax(ntest)
699
700      ! lfax contains the set of allowed factors.
701      data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256,  &
702         &                            128,   64,   32,   16,    8,   4,   2  /
703      !!----------------------------------------------------------------------
704
705      ! Clear the error flag and initialise output vars
706      kerr = 0
707      kfax = 1
708      knfax = 0
709
710      ! Find the factors of n.
711      IF( kn == 1 )   GOTO 20
712
713      ! nu holds the unfactorised part of the number.
714      ! knfax holds the number of factors found.
715      ! l points to the allowed factor list.
716      ! ifac holds the current factor.
717
718      inu   = kn
719      knfax = 0
720
721      DO jl = ntest, 1, -1
722         !
723         ifac = ilfax(jl)
724         IF( ifac > inu )   CYCLE
725
726         ! Test whether the factor will divide.
727
728         IF( MOD(inu,ifac) == 0 ) THEN
729            !
730            knfax = knfax + 1            ! Add the factor to the list
731            IF( knfax > kmaxfax ) THEN
732               kerr = 6
733               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
734               return
735            ENDIF
736            kfax(knfax) = ifac
737            ! Store the other factor that goes with this one
738            knfax = knfax + 1
739            kfax(knfax) = inu / ifac
740            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
741         ENDIF
742         !
743      END DO
744
745   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
746      !
747   END SUBROUTINE factorise
748
[3294]749#if defined key_mpp_mpi
750   SUBROUTINE nemo_northcomms
751      !!======================================================================
752      !!                     ***  ROUTINE  nemo_northcomms  ***
753      !! nemo_northcomms    :  Setup for north fold exchanges with explicit peer to peer messaging
754      !!=====================================================================
755      !!----------------------------------------------------------------------
[3764]756      !!
[3294]757      !! ** Purpose :   Initialization of the northern neighbours lists.
758      !!----------------------------------------------------------------------
[3764]759      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
[3294]760      !!----------------------------------------------------------------------
761
762      INTEGER ::   ji, jj, jk, ij, jtyp    ! dummy loop indices
763      INTEGER ::   ijpj                    ! number of rows involved in north-fold exchange
764      INTEGER ::   northcomms_alloc        ! allocate return status
765      REAL(wp), ALLOCATABLE, DIMENSION ( :,: ) ::   znnbrs     ! workspace
766      LOGICAL,  ALLOCATABLE, DIMENSION ( : )   ::   lrankset   ! workspace
767
768      IF(lwp) WRITE(numout,*)
769      IF(lwp) WRITE(numout,*) 'nemo_northcomms : Initialization of the northern neighbours lists'
770      IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
771
772      !!----------------------------------------------------------------------
773      ALLOCATE( znnbrs(jpi,jpj), stat = northcomms_alloc )
774      ALLOCATE( lrankset(jpnij), stat = northcomms_alloc )
775      IF( northcomms_alloc /= 0 ) THEN
776         WRITE(numout,cform_war)
777         WRITE(numout,*) 'northcomms_alloc : failed to allocate arrays'
778         CALL ctl_stop( 'STOP', 'nemo_northcomms : unable to allocate temporary arrays' )
779      ENDIF
780      nsndto = 0
781      isendto = -1
782      ijpj   = 4
783      !
784      ! This routine has been called because ln_nnogather has been set true ( nammpp )
785      ! However, these first few exchanges have to use the mpi_allgather method to
786      ! establish the neighbour lists to use in subsequent peer to peer exchanges.
787      ! Consequently, set l_north_nogather to be false here and set it true only after
788      ! the lists have been established.
789      !
790      l_north_nogather = .FALSE.
791      !
792      ! Exchange and store ranks on northern rows
793
794      DO jtyp = 1,4
795
796         lrankset = .FALSE.
797         znnbrs = narea
798         SELECT CASE (jtyp)
799            CASE(1)
800               CALL lbc_lnk( znnbrs, 'T', 1. )      ! Type 1: T,W-points
801            CASE(2)
802               CALL lbc_lnk( znnbrs, 'U', 1. )      ! Type 2: U-point
803            CASE(3)
804               CALL lbc_lnk( znnbrs, 'V', 1. )      ! Type 3: V-point
805            CASE(4)
806               CALL lbc_lnk( znnbrs, 'F', 1. )      ! Type 4: F-point
807         END SELECT
808
809         IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
810            DO jj = nlcj-ijpj+1, nlcj
811               ij = jj - nlcj + ijpj
812               DO ji = 1,jpi
813                  IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
814               &     lrankset(INT(znnbrs(ji,jj))) = .true.
815               END DO
816            END DO
817
818            DO jj = 1,jpnij
819               IF ( lrankset(jj) ) THEN
820                  nsndto(jtyp) = nsndto(jtyp) + 1
821                  IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
822                     CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
823                  &                 ' jpmaxngh will need to be increased ')
824                  ENDIF
825                  isendto(nsndto(jtyp),jtyp) = jj-1   ! narea converted to MPI rank
826               ENDIF
827            END DO
828         ENDIF
829
830      END DO
831
832      !
833      ! Type 5: I-point
834      !
835      ! ICE point exchanges may involve some averaging. The neighbours list is
836      ! built up using two exchanges to ensure that the whole stencil is covered.
837      ! lrankset should not be reset between these 'J' and 'K' point exchanges
838
839      jtyp = 5
840      lrankset = .FALSE.
[3764]841      znnbrs = narea
[3294]842      CALL lbc_lnk( znnbrs, 'J', 1. ) ! first ice U-V point
843
844      IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
845         DO jj = nlcj-ijpj+1, nlcj
846            ij = jj - nlcj + ijpj
847            DO ji = 1,jpi
848               IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
849            &     lrankset(INT(znnbrs(ji,jj))) = .true.
850         END DO
851        END DO
852      ENDIF
853
[3764]854      znnbrs = narea
[3294]855      CALL lbc_lnk( znnbrs, 'K', 1. ) ! second ice U-V point
856
857      IF ( njmppt(narea) .EQ. MAXVAL( njmppt )) THEN
858         DO jj = nlcj-ijpj+1, nlcj
859            ij = jj - nlcj + ijpj
860            DO ji = 1,jpi
861               IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND.  INT(znnbrs(ji,jj)) .NE. narea ) &
862            &       lrankset( INT(znnbrs(ji,jj))) = .true.
863            END DO
864         END DO
865
866         DO jj = 1,jpnij
867            IF ( lrankset(jj) ) THEN
868               nsndto(jtyp) = nsndto(jtyp) + 1
869               IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
870                  CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
871               &                 ' jpmaxngh will need to be increased ')
872               ENDIF
873               isendto(nsndto(jtyp),jtyp) = jj-1   ! narea converted to MPI rank
874            ENDIF
875         END DO
876         !
[3764]877         ! For northern row areas, set l_north_nogather so that all subsequent exchanges
[3294]878         ! can use peer to peer communications at the north fold
879         !
880         l_north_nogather = .TRUE.
881         !
882      ENDIF
883      DEALLOCATE( znnbrs )
884      DEALLOCATE( lrankset )
885
886   END SUBROUTINE nemo_northcomms
887#else
888   SUBROUTINE nemo_northcomms      ! Dummy routine
889      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
890   END SUBROUTINE nemo_northcomms
891#endif
[3]892   !!======================================================================
[2496]893END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.