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 NEMO/branches/UKMO/dev_r10037_GPU/src/OCE – NEMO

source: NEMO/branches/UKMO/dev_r10037_GPU/src/OCE/nemogcm.F90 @ 12806

Last change on this file since 12806 was 11467, checked in by andmirek, 5 years ago

Ticket #2197 allocate arrays at the beggining of the run

File size: 31.0 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)
[9656]15   !!            8.2  ! 1999-11  (M. Imbard, H. Goosse)  sea-ice model
[3764]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
[5836]30   !!             -   ! 2011-11  (C. Harris) decomposition changes for running with CICE
31   !!            3.6  ! 2012-05  (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
32   !!             -   ! 2014-12  (G. Madec) remove KPP scheme and cross-land advection (cla)
[7646]33   !!            4.0  ! 2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
[1593]34   !!----------------------------------------------------------------------
[3]35
36   !!----------------------------------------------------------------------
[6140]37   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
38   !!   nemo_init     : initialization of the NEMO system
39   !!   nemo_ctl      : initialisation of the contol print
40   !!   nemo_closefile: close remaining open files
41   !!   nemo_alloc    : dynamical allocation
[3]42   !!----------------------------------------------------------------------
[6140]43   USE step_oce       ! module used in the ocean time stepping module (step.F90)
[7646]44   USE phycst         ! physical constant                  (par_cst routine)
45   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
[9161]46   USE closea         ! treatment of closed seas (for ln_closea)
[7646]47   USE usrdef_nam     ! user defined configuration
[6140]48   USE tideini        ! tidal components initialization   (tide_ini routine)
[9019]49   USE bdy_oce,  ONLY : ln_bdy
[6140]50   USE bdyini         ! open boundary cond. setting       (bdy_init routine)
51   USE istate         ! initial state setting          (istate_init routine)
52   USE ldfdyn         ! lateral viscosity setting      (ldfdyn_init routine)
53   USE ldftra         ! lateral diffusivity setting    (ldftra_init routine)
54   USE trdini         ! dyn/tra trends initialization     (trd_init routine)
55   USE asminc         ! assimilation increments     
56   USE asmbkg         ! writing out state trajectory
57   USE diaptr         ! poleward transports           (dia_ptr_init routine)
58   USE diadct         ! sections transports           (dia_dct_init routine)
59   USE diaobs         ! Observation diagnostics       (dia_obs_init routine)
60   USE diacfl         ! CFL diagnostics               (dia_cfl_init routine)
61   USE step           ! NEMO time-stepping                 (stp     routine)
62   USE icbini         ! handle bergs, initialisation
63   USE icbstp         ! handle bergs, calving, themodynamics and transport
64   USE cpl_oasis3     ! OASIS3 coupling
65   USE c1d            ! 1D configuration
66   USE step_c1d       ! Time stepping loop for the 1D configuration
67   USE dyndmp         ! Momentum damping
68   USE stopar         ! Stochastic param.: ???
69   USE stopts         ! Stochastic param.: ???
[7646]70   USE diurnal_bulk   ! diurnal bulk SST
71   USE step_diu       ! diurnal bulk SST timestepping (called from here if run offline)
72   USE crsini         ! initialise grid coarsening utility
73   USE diatmb         ! Top,middle,bottom output
74   USE dia25h         ! 25h mean output
75   USE sbc_oce , ONLY : lk_oasis
76   USE wet_dry        ! Wetting and drying setting   (wad_init routine)
[1594]77#if defined key_top
[6140]78   USE trcini         ! passive tracer initialisation
[1594]79#endif
[7646]80#if defined key_nemocice_decomp
81   USE ice_domain_size, only: nx_global, ny_global
82#endif
83   !
[6140]84   USE lib_mpp        ! distributed memory computing
[7646]85   USE mppini         ! shared/distributed memory setting (mpp_init routine)
[9213]86   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
[7646]87   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1412]88#if defined key_iomput
[6140]89   USE xios           ! xIOserver
[1359]90#endif
[9780]91#if defined key_agrif
92   USE agrif_all_update   ! Master Agrif update
93#endif
[11467]94   USE scoce, ONLY : scoce_alloc ! scratch arrays
[268]95
[2715]96   IMPLICIT NONE
[3]97   PRIVATE
98
[2496]99   PUBLIC   nemo_gcm    ! called by model.F90
100   PUBLIC   nemo_init   ! needed by AGRIF
[3764]101   PUBLIC   nemo_alloc  ! needed by TAM
[467]102
[2498]103   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
[1593]104
[3]105   !!----------------------------------------------------------------------
[9570]106   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[2392]107   !! $Id$
[10843]108   !! Software governed by the CeCILL license (see ./LICENSE)
[3]109   !!----------------------------------------------------------------------
110CONTAINS
111
[2496]112   SUBROUTINE nemo_gcm
[3]113      !!----------------------------------------------------------------------
[2496]114      !!                     ***  ROUTINE nemo_gcm  ***
[3]115      !!
[3764]116      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
[1593]117      !!              curvilinear mesh on the sphere.
[3]118      !!
119      !! ** Method  : - model general initialization
120      !!              - launch the time-stepping (stp routine)
[1593]121      !!              - finalize the run by closing files and communications
[3]122      !!
[2715]123      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
[1593]124      !!              Madec, 2008, internal report, IPSL.
[3]125      !!----------------------------------------------------------------------
[7646]126      INTEGER ::   istp   ! time step index
[389]127      !!----------------------------------------------------------------------
[2382]128      !
[392]129#if defined key_agrif
[1593]130      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
[389]131#endif
[1593]132      !                            !-----------------------!
[2496]133      CALL nemo_init               !==  Initialisations  ==!
[1593]134      !                            !-----------------------!
[2715]135#if defined key_agrif
[3680]136      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
137      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
[2715]138# if defined key_top
[3680]139      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
[2715]140# endif
[9570]141# if defined key_si3
[9611]142      CALL Agrif_Declare_Var_ice   !  "      "   "   "      "  Sea ice
[7646]143# endif
[2715]144#endif
[682]145      ! check that all process are still there... If some process have an error,
146      ! they will never enter in step and other processes will wait until the end of the cpu time!
[900]147      IF( lk_mpp )   CALL mpp_max( nstop )
[682]148
[1593]149      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
150
151      !                            !-----------------------!
152      !                            !==   time stepping   ==!
153      !                            !-----------------------!
[900]154      istp = nit000
[9210]155      !
[2236]156#if defined key_c1d
[9210]157      DO WHILE ( istp <= nitend .AND. nstop == 0 )    !==  C1D time-stepping  ==!
158         CALL stp_c1d( istp )
159         istp = istp + 1
160      END DO
[2236]161#else
[9210]162      !
163# if defined key_agrif
164      !                                               !==  AGRIF time-stepping  ==!
165      CALL Agrif_Regrid()
[9213]166      !
[9780]167      ! Recursive update from highest nested level to lowest:
168      CALL Agrif_step_child_adj(Agrif_Update_All)
169      !
[9210]170      DO WHILE( istp <= nitend .AND. nstop == 0 )
171         CALL stp
172         istp = istp + 1
173      END DO
174      !
175      IF( .NOT. Agrif_Root() ) THEN
176         CALL Agrif_ParentGrid_To_ChildGrid()
177         IF( ln_diaobs )   CALL dia_obs_wri
178         IF( ln_timing )   CALL timing_finalize
179         CALL Agrif_ChildGrid_To_ParentGrid()
180      ENDIF
181      !
182# else
183      !
184      IF( .NOT.ln_diurnal_only ) THEN                 !==  Standard time-stepping  ==!
185         !
186         DO WHILE( istp <= nitend .AND. nstop == 0 )
187            CALL stp        ( istp ) 
[389]188            istp = istp + 1
189         END DO
[9210]190         !
191      ELSE                                            !==  diurnal SST time-steeping only  ==!
192         !
193         DO WHILE( istp <= nitend .AND. nstop == 0 )
194            CALL stp_diurnal( istp )   ! time step only the diurnal SST
195            istp = istp + 1
196         END DO
197         !
198      ENDIF
199      !
200# endif
201      !
[2236]202#endif
[9210]203      !
[6140]204      IF( ln_diaobs   )   CALL dia_obs_wri
[3609]205      !
206      IF( ln_icebergs )   CALL icb_end( nitend )
[3764]207
[1593]208      !                            !------------------------!
209      !                            !==  finalize the run  ==!
210      !                            !------------------------!
[7646]211      IF(lwp) WRITE(numout,cform_aaa)        ! Flag AAAAAAA
[1593]212      !
[7646]213      IF( nstop /= 0 .AND. lwp ) THEN        ! error print
[682]214         WRITE(numout,cform_err)
[9213]215         WRITE(numout,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
[9210]216         WRITE(numout,*)
[389]217      ENDIF
[1593]218      !
[9124]219      IF( ln_timing )   CALL timing_finalize
[3294]220      !
[2496]221      CALL nemo_closefile
[4990]222      !
[3769]223#if defined key_iomput
[9210]224                                    CALL xios_finalize  ! end mpp communications with xios
225      IF( lk_oasis     )            CALL cpl_finalize   ! end coupling and mpp communications with OASIS
[532]226#else
[9210]227      IF    ( lk_oasis ) THEN   ;   CALL cpl_finalize   ! end coupling and mpp communications with OASIS
228      ELSEIF( lk_mpp   ) THEN   ;   CALL mppstop        ! end mpp communications
[4990]229      ENDIF
[532]230#endif
[900]231      !
[2496]232   END SUBROUTINE nemo_gcm
[389]233
234
[2496]235   SUBROUTINE nemo_init
[389]236      !!----------------------------------------------------------------------
[2496]237      !!                     ***  ROUTINE nemo_init  ***
[389]238      !!
[2496]239      !! ** Purpose :   initialization of the NEMO GCM
[389]240      !!----------------------------------------------------------------------
[7646]241      INTEGER  ::   ji                 ! dummy loop indices
[9213]242      INTEGER  ::   ios, ilocal_comm   ! local integers
[9490]243      CHARACTER(len=120), DIMENSION(60) ::   cltxt, cltxt2, clnam
[9213]244      !!
[7646]245      NAMELIST/namctl/ ln_ctl   , nn_print, nn_ictls, nn_ictle,   &
246         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,   &
[9019]247         &             ln_timing, ln_diacfl
[9213]248      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]249      !!----------------------------------------------------------------------
[1593]250      !
[7646]251      cltxt  = ''
252      cltxt2 = ''
253      clnam  = '' 
[5407]254      cxios_context = 'nemo'
[2496]255      !
[4147]256      !                             ! Open reference namelist and configuration namelist files
257      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
258      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]259      !
[9213]260      REWIND( numnam_ref )              ! Namelist namctl in reference namelist
[4147]261      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
[9168]262901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
[7646]263      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist
[4147]264      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
[9168]265902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
[1593]266      !
[9213]267      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist
[4147]268      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
[9168]269903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
[9213]270      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist
[4147]271      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
[9168]272904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
[4309]273
[7646]274      !                             !--------------------------!
275      !                             !  Set global domain size  !   (control print return in cltxt2)
276      !                             !--------------------------!
277      IF( ln_read_cfg ) THEN              ! Read sizes in domain configuration file
278         CALL domain_cfg ( cltxt2,        cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
279         !
280      ELSE                                ! user-defined namelist
281         CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
282      ENDIF
283      !
284      !
[1593]285      !                             !--------------------------------------------!
286      !                             !  set communicator & select the local node  !
[4624]287      !                             !  NB: mynode also opens output.namelist.dyn !
288      !                             !      on unit number numond on first proc   !
[1593]289      !                             !--------------------------------------------!
[1412]290#if defined key_iomput
[2200]291      IF( Agrif_Root() ) THEN
[5407]292         IF( lk_oasis ) THEN
[7646]293            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
294            CALL xios_initialize( "not used"       ,local_comm= ilocal_comm )    ! send nemo communicator to xios
[4990]295         ELSE
[7646]296            CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )    ! nemo local communicator given by xios
[4990]297         ENDIF
[2200]298      ENDIF
[5407]299      ! Nodes selection (control print return in cltxt)
300      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[532]301#else
[5407]302      IF( lk_oasis ) THEN
[4990]303         IF( Agrif_Root() ) THEN
[7646]304            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
[4990]305         ENDIF
[5407]306         ! Nodes selection (control print return in cltxt)
307         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[4990]308      ELSE
[7646]309         ilocal_comm = 0                                    ! Nodes selection (control print return in cltxt)
[5407]310         narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
[2236]311      ENDIF
[532]312#endif
[7646]313
[2715]314      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
[3]315
[4624]316      lwm = (narea == 1)                                    ! control of output namelists
[2715]317      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
[1579]318
[7646]319      IF(lwm) THEN               ! write merged namelists from earlier to output namelist
320         !                       ! now that the file has been opened in call to mynode.
321         !                       ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
[4624]322         WRITE( numond, namctl )
323         WRITE( numond, namcfg )
[7646]324         IF( .NOT.ln_read_cfg ) THEN
325            DO ji = 1, SIZE(clnam)
326               IF( TRIM(clnam(ji)) /= '' )   WRITE(numond, * ) clnam(ji)     ! namusr_def print
327            END DO
328         ENDIF
[4624]329      ENDIF
330
[1593]331      IF(lwp) THEN                            ! open listing units
332         !
[1581]333         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]334         !
[1579]335         WRITE(numout,*)
[3294]336         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]337         WRITE(numout,*) '                       NEMO team'
[1579]338         WRITE(numout,*) '            Ocean General Circulation Model'
[9169]339         WRITE(numout,*) '                NEMO version 4.0  (2017) '
[1579]340         WRITE(numout,*)
341         WRITE(numout,*)
[3764]342         DO ji = 1, SIZE(cltxt)
[7646]343            IF( TRIM(cltxt (ji)) /= '' )   WRITE(numout,*) cltxt(ji)    ! control print of mynode
[1579]344         END DO
[7646]345         WRITE(numout,*)
346         WRITE(numout,*)
347         DO ji = 1, SIZE(cltxt2)
348            IF( TRIM(cltxt2(ji)) /= '' )   WRITE(numout,*) cltxt2(ji)   ! control print of domain size
349         END DO
[1593]350         !
[7646]351         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
352         !
[473]353      ENDIF
[9436]354      !                                      ! Domain decomposition
355      CALL mpp_init                          ! MPP
[2715]356
[7646]357      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]358      CALL nemo_alloc()
359
[2496]360      !                             !-------------------------------!
361      !                             !  NEMO general initialization  !
362      !                             !-------------------------------!
[473]363
[7646]364      CALL nemo_ctl                          ! Control prints
[2382]365      !
[9213]366      !                                      ! General initialization
367      IF( ln_timing    )   CALL timing_init     ! timing
368      IF( ln_timing    )   CALL timing_start( 'nemo_init')
[3294]369      !
[9367]370                           CALL     phy_cst         ! Physical constants
371                           CALL     eos_init        ! Equation of state
372      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
373                           CALL     wad_init        ! Wetting and drying options
374                           CALL     dom_init("OPA") ! Domain
375      IF( ln_crs       )   CALL     crs_init        ! coarsened grid: domain initialization
376      IF( ln_ctl       )   CALL prt_ctl_init        ! Print control
[6140]377     
[9213]378      CALL diurnal_sst_bulk_init                ! diurnal sst
379      IF( ln_diurnal   )   CALL diurnal_sst_coolskin_init   ! cool skin   
380      !                           
381      IF( ln_diurnal_only ) THEN                   ! diurnal only: a subset of the initialisation routines
382         CALL  istate_init                            ! ocean initial state (Dynamics and tracers)
383         CALL     sbc_init                            ! Forcings : surface module
384         CALL tra_qsr_init                            ! penetrative solar radiation qsr
385         IF( ln_diaobs ) THEN                         ! Observation & model comparison
386            CALL dia_obs_init                            ! Initialize observational data
387            CALL dia_obs( nit000 - 1 )                   ! Observation operator for restart
[6140]388         ENDIF     
[9213]389         IF( lk_asminc )   CALL asm_inc_init          ! Assimilation increments
390         !
391         RETURN                                       ! end of initialization
[6140]392      ENDIF
393     
[9213]394                           CALL  istate_init    ! ocean initial state (Dynamics and tracers)
[3651]395
[5836]396      !                                      ! external forcing
[9213]397                           CALL    tide_init    ! tidal harmonics
398                           CALL     sbc_init    ! surface boundary conditions (including sea-ice)
399                           CALL     bdy_init    ! Open boundaries initialisation
[9019]400
[5836]401      !                                      ! Ocean physics
[9019]402                           CALL zdf_phy_init    ! Vertical physics
403                                     
[2082]404      !                                         ! Lateral physics
[9019]405                           CALL ldf_tra_init      ! Lateral ocean tracer physics
406                           CALL ldf_eiv_init      ! eddy induced velocity param.
407                           CALL ldf_dyn_init      ! Lateral ocean momentum physics
[2082]408
[9019]409      !                                      ! Active tracers
410      IF( ln_traqsr    )   CALL tra_qsr_init      ! penetrative solar radiation qsr
411                           CALL tra_bbc_init      ! bottom heat flux
412      IF( ln_trabbl    )   CALL tra_bbl_init      ! advective (and/or diffusive) bottom boundary layer scheme
413                           CALL tra_dmp_init      ! internal tracer damping
414                           CALL tra_adv_init      ! horizontal & vertical advection
415                           CALL tra_ldf_init      ! lateral mixing
[2027]416
[9019]417      !                                      ! Dynamics
418      IF( lk_c1d       )   CALL dyn_dmp_init      ! internal momentum damping
419                           CALL dyn_adv_init      ! advection (vector or flux form)
420                           CALL dyn_vor_init      ! vorticity term including Coriolis
421                           CALL dyn_ldf_init      ! lateral mixing
422                           CALL dyn_hpg_init      ! horizontal gradient of Hydrostatic pressure
423                           CALL dyn_spg_init      ! surface pressure gradient
[3764]424
[5836]425#if defined key_top
426      !                                      ! Passive tracers
[9019]427                           CALL     trc_init
[5836]428#endif
[9019]429      IF( l_ldfslp     )   CALL ldf_slp_init    ! slope of lateral mixing
[5836]430
431      !                                      ! Icebergs
[9019]432                           CALL icb_init( rdt, nit000)   ! initialise icebergs instance
[5836]433
434      !                                      ! Misc. options
[9019]435                           CALL sto_par_init    ! Stochastic parametrization
436      IF( ln_sto_eos   )   CALL sto_pts_init    ! RRandom T/S fluctuations
[4147]437     
[5836]438      !                                      ! Diagnostics
[9019]439      IF( lk_floats    )   CALL     flo_init    ! drifting Floats
440      IF( ln_diacfl    )   CALL dia_cfl_init    ! Initialise CFL diagnostics
441                           CALL dia_ptr_init    ! Poleward TRansports initialization
442      IF( lk_diadct    )   CALL dia_dct_init    ! Sections tranports
443                           CALL dia_hsb_init    ! heat content, salt content and volume budgets
444                           CALL     trd_init    ! Mixed-layer/Vorticity/Integral constraints trends
445                           CALL dia_obs_init    ! Initialize observational data
[9213]446                           CALL dia_tmb_init    ! TMB outputs
447                           CALL dia_25h_init    ! 25h mean  outputs
448      IF( ln_diaobs    )   CALL dia_obs( nit000-1 )   ! Observation operator for restart
[6140]449
[9019]450      !                                      ! Assimilation increments
451      IF( lk_asminc    )   CALL asm_inc_init    ! Initialize assimilation increments
[1593]452      !
[9213]453      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
454      !
455      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
456      !
[2496]457   END SUBROUTINE nemo_init
[467]458
459
[2496]460   SUBROUTINE nemo_ctl
[467]461      !!----------------------------------------------------------------------
[2496]462      !!                     ***  ROUTINE nemo_ctl  ***
[467]463      !!
[3764]464      !! ** Purpose :   control print setting
[467]465      !!
[2442]466      !! ** Method  : - print namctl information and check some consistencies
[467]467      !!----------------------------------------------------------------------
[2442]468      !
[2496]469      IF(lwp) THEN                  ! control print
[531]470         WRITE(numout,*)
[7646]471         WRITE(numout,*) 'nemo_ctl: Control prints'
[9213]472         WRITE(numout,*) '~~~~~~~~'
[1593]473         WRITE(numout,*) '   Namelist namctl'
[1601]474         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
475         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
476         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
477         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
478         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
479         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
480         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
481         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
[9019]482         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
483         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
[531]484      ENDIF
[2442]485      !
[1601]486      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
487      nictls    = nn_ictls
488      nictle    = nn_ictle
489      njctls    = nn_jctls
490      njctle    = nn_jctle
491      isplt     = nn_isplt
[9213]492      jsplt     = nn_jsplt
[4147]493
494      IF(lwp) THEN                  ! control print
495         WRITE(numout,*)
496         WRITE(numout,*) '   Namelist namcfg'
[7646]497         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
498         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
[9213]499         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
500         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
[7646]501         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
502         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
[4147]503      ENDIF
[9213]504      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
505      !
[2442]506      !                             ! Parameter control
[1593]507      !
508      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
[3294]509         IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]510            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
[531]511         ELSE
512            IF( isplt == 1 .AND. jsplt == 1  ) THEN
[1593]513               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
514                  &           ' - the print control will be done over the whole domain' )
[531]515            ENDIF
[1593]516            ijsplt = isplt * jsplt            ! total number of processors ijsplt
[531]517         ENDIF
518         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
519         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
[1593]520         !
521         !                              ! indices used for the SUM control
522         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
[3764]523            lsp_area = .FALSE.
[1593]524         ELSE                                             ! print control done over a specific  area
[531]525            lsp_area = .TRUE.
526            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
527               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
528               nictls = 1
529            ENDIF
530            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
531               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
532               nictle = jpiglo
533            ENDIF
534            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
535               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
536               njctls = 1
537            ENDIF
538            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
539               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
540               njctle = jpjglo
541            ENDIF
[1593]542         ENDIF
543      ENDIF
[2442]544      !
[9213]545      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
546         &                                                'Compile with key_nosignedzero enabled' )
[3764]547      !
[9023]548#if defined key_agrif
[9124]549      IF( ln_timing )   CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
[9023]550#endif
551      !
[2496]552   END SUBROUTINE nemo_ctl
[467]553
554
[2496]555   SUBROUTINE nemo_closefile
[467]556      !!----------------------------------------------------------------------
[2496]557      !!                     ***  ROUTINE nemo_closefile  ***
[467]558      !!
559      !! ** Purpose :   Close the files
560      !!----------------------------------------------------------------------
[1593]561      !
562      IF( lk_mpp )   CALL mppsync
563      !
[1685]564      CALL iom_close                                 ! close all input/output files managed by iom_*
[1593]565      !
[4147]566      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
[9019]567      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
[4147]568      IF( numnam_ref      /= -1 )   CLOSE( numnam_ref      )   ! oce reference namelist
569      IF( numnam_cfg      /= -1 )   CLOSE( numnam_cfg      )   ! oce configuration namelist
[4624]570      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
[4147]571      IF( numnam_ice_ref  /= -1 )   CLOSE( numnam_ice_ref  )   ! ice reference namelist
572      IF( numnam_ice_cfg  /= -1 )   CLOSE( numnam_ice_cfg  )   ! ice configuration namelist
[4624]573      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
[4147]574      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
575      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
576      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
577      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
578      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
[1593]579      !
[2442]580      numout = 6                                     ! redefine numout in case it is used after this point...
581      !
[2496]582   END SUBROUTINE nemo_closefile
[467]583
[2715]584
585   SUBROUTINE nemo_alloc
586      !!----------------------------------------------------------------------
587      !!                     ***  ROUTINE nemo_alloc  ***
588      !!
589      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
590      !!
591      !! ** Method  :
592      !!----------------------------------------------------------------------
[9213]593      USE diawri    , ONLY : dia_wri_alloc
594      USE dom_oce   , ONLY : dom_oce_alloc
595      USE trc_oce   , ONLY : trc_oce_alloc
596      USE bdy_oce   , ONLY : bdy_oce_alloc
[3680]597#if defined key_diadct 
[9213]598      USE diadct    , ONLY : diadct_alloc 
[3680]599#endif 
[2715]600      !
601      INTEGER :: ierr
602      !!----------------------------------------------------------------------
603      !
[9213]604      ierr =        oce_alloc    ()    ! ocean
605      ierr = ierr + dia_wri_alloc()
606      ierr = ierr + dom_oce_alloc()    ! ocean domain
607      ierr = ierr + zdf_oce_alloc()    ! ocean vertical physics
608      ierr = ierr + trc_oce_alloc()    ! shared TRC / TRA arrays
609      ierr = ierr + bdy_oce_alloc()    ! bdy masks (incl. initialization)
[11467]610      ierr = ierr + scoce_alloc()       ! scratch arrays
[2715]611      !
[3680]612#if defined key_diadct 
[9213]613      ierr = ierr + diadct_alloc ()    !
[3680]614#endif 
615      !
[2715]616      IF( lk_mpp    )   CALL mpp_sum( ierr )
[9213]617      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
[2715]618      !
619   END SUBROUTINE nemo_alloc
620
[3]621   !!======================================================================
[2496]622END MODULE nemogcm
[4354]623
Note: See TracBrowser for help on using the repository browser.