source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/OCE/nemogcm.F90 @ 13193

Last change on this file since 13193 was 13193, checked in by smasson, 3 months ago

better e3: update with trunk@13136 see #2385

  • Property svn:keywords set to Id
File size: 35.3 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)  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   !!             -   ! 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)
33   !!            4.0  ! 2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
34   !!----------------------------------------------------------------------
35
36   !!----------------------------------------------------------------------
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
42   !!----------------------------------------------------------------------
43   USE step_oce       ! module used in the ocean time stepping module (step.F90)
44   USE phycst         ! physical constant                  (par_cst routine)
45   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
46   USE closea         ! treatment of closed seas (for ln_closea)
47   USE usrdef_nam     ! user defined configuration
48   USE tide_mod, ONLY : tide_init ! tidal components initialization   (tide_init routine)
49   USE bdy_oce,  ONLY : ln_bdy
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 diamlr         ! IOM context management for multiple-linear-regression analysis
62#if defined key_qco
63   USE stepMLF        ! NEMO time-stepping               (stp_MLF   routine)
64#else
65   USE step           ! NEMO time-stepping               (stp       routine)
66#endif
67   USE isfstp         ! ice shelf                     (isf_stp_init 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   USE stopar         ! Stochastic param.: ???
75   USE stopts         ! Stochastic param.: ???
76   USE diu_layers     ! diurnal bulk SST and coolskin
77   USE step_diu       ! diurnal bulk SST timestepping (called from here if run offline)
78   USE crsini         ! initialise grid coarsening utility
79   USE dia25h         ! 25h mean output
80   USE diadetide      ! Weights computation for daily detiding of model diagnostics
81   USE sbc_oce , ONLY : lk_oasis
82   USE wet_dry        ! Wetting and drying setting   (wad_init routine)
83#if defined key_top
84   USE trcini         ! passive tracer initialisation
85#endif
86#if defined key_nemocice_decomp
87   USE ice_domain_size, only: nx_global, ny_global
88#endif
89   !
90   USE in_out_manager ! I/O manager
91   USE lib_mpp        ! distributed memory computing
92   USE mppini         ! shared/distributed memory setting (mpp_init routine)
93   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
94   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
95#if defined key_iomput
96   USE xios           ! xIOserver
97#endif
98#if defined key_agrif
99   USE agrif_all_update   ! Master Agrif update
100#endif
101
102   IMPLICIT NONE
103   PRIVATE
104
105   PUBLIC   nemo_gcm    ! called by model.F90
106   PUBLIC   nemo_init   ! needed by AGRIF
107   PUBLIC   nemo_alloc  ! needed by TAM
108
109   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
110
111#if defined key_mpp_mpi
112   ! need MPI_Wtime
113   INCLUDE 'mpif.h'
114#endif
115
116   !!----------------------------------------------------------------------
117   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
118   !! $Id$
119   !! Software governed by the CeCILL license (see ./LICENSE)
120   !!----------------------------------------------------------------------
121CONTAINS
122
123   SUBROUTINE nemo_gcm
124      !!----------------------------------------------------------------------
125      !!                     ***  ROUTINE nemo_gcm  ***
126      !!
127      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
128      !!              curvilinear mesh on the sphere.
129      !!
130      !! ** Method  : - model general initialization
131      !!              - launch the time-stepping (stp routine)
132      !!              - finalize the run by closing files and communications
133      !!
134      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
135      !!              Madec, 2008, internal report, IPSL.
136      !!----------------------------------------------------------------------
137      INTEGER ::   istp   ! time step index
138      REAL(wp)::   zstptiming   ! elapsed time for 1 time step
139      !!----------------------------------------------------------------------
140      !
141#if defined key_agrif
142      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
143#endif
144      !                            !-----------------------!
145      CALL nemo_init               !==  Initialisations  ==!
146      !                            !-----------------------!
147#if defined key_agrif
148      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
149      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
150      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
151# if defined key_top
152      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
153# endif
154# if defined key_si3
155      CALL Agrif_Declare_Var_ice   !  "      "   "   "      "  Sea ice
156# endif
157#endif
158      ! check that all process are still there... If some process have an error,
159      ! they will never enter in step and other processes will wait until the end of the cpu time!
160      CALL mpp_max( 'nemogcm', nstop )
161
162      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
163
164      !                            !-----------------------!
165      !                            !==   time stepping   ==!
166      !                            !-----------------------!
167      !
168      !                                               !== set the model time-step  ==!
169      !
170      istp = nit000
171      !
172#if defined key_c1d
173      DO WHILE ( istp <= nitend .AND. nstop == 0 )    !==  C1D time-stepping  ==!
174         CALL stp_c1d( istp )
175         istp = istp + 1
176      END DO
177#else
178      !
179# if defined key_agrif
180      !                                               !==  AGRIF time-stepping  ==!
181      CALL Agrif_Regrid()
182      !
183      ! Recursive update from highest nested level to lowest:
184      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
185      CALL Agrif_step_child_adj(Agrif_Update_All)
186      !
187      DO WHILE( istp <= nitend .AND. nstop == 0 )
188#if defined key_qco
189         CALL stp_MLF
190#else
191         CALL stp
192#endif
193         istp = istp + 1
194      END DO
195      !
196# else
197      !
198      IF( .NOT.ln_diurnal_only ) THEN                 !==  Standard time-stepping  ==!
199         !
200         DO WHILE( istp <= nitend .AND. nstop == 0 )
201
202            ncom_stp = istp
203            IF( ln_timing ) THEN
204               zstptiming = MPI_Wtime()
205               IF ( istp == ( nit000 + 1 ) ) elapsed_time = zstptiming
206               IF ( istp ==         nitend ) elapsed_time = zstptiming - elapsed_time
207            ENDIF
208
209#if defined key_qco
210            CALL stp_MLF      ( istp )
211#else
212            CALL stp          ( istp )
213#endif
214            istp = istp + 1
215
216            IF( lwp .AND. ln_timing )   WRITE(numtime,*) 'timing step ', istp-1, ' : ', MPI_Wtime() - zstptiming
217
218         END DO
219         !
220      ELSE                                            !==  diurnal SST time-steeping only  ==!
221         !
222         DO WHILE( istp <= nitend .AND. nstop == 0 )
223            CALL stp_diurnal( istp )   ! time step only the diurnal SST
224            istp = istp + 1
225         END DO
226         !
227      ENDIF
228      !
229# endif
230      !
231#endif
232      !
233      IF( ln_diaobs   )   CALL dia_obs_wri
234      !
235      IF( ln_icebergs )   CALL icb_end( nitend )
236
237      !                            !------------------------!
238      !                            !==  finalize the run  ==!
239      !                            !------------------------!
240      IF(lwp) WRITE(numout,cform_aaa)        ! Flag AAAAAAA
241      !
242      IF( nstop /= 0 .AND. lwp ) THEN        ! error print
243         WRITE(ctmp1,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
244         IF( ngrdstop > 0 ) THEN
245            WRITE(ctmp9,'(i2)') ngrdstop
246            WRITE(ctmp2,*) '           E R R O R detected in Agrif grid '//TRIM(ctmp9)
247            WRITE(ctmp3,*) '           Look for "E R R O R" messages in all existing '//TRIM(ctmp9)//'_ocean_output* files'
248            CALL ctl_stop( ' ', ctmp1, ' ', ctmp2, ' ', ctmp3 )
249         ELSE
250            WRITE(ctmp2,*) '           Look for "E R R O R" messages in all existing ocean_output* files'
251            CALL ctl_stop( ' ', ctmp1, ' ', ctmp2 )
252         ENDIF
253      ENDIF
254      !
255      IF( ln_timing )   CALL timing_finalize
256      !
257      CALL nemo_closefile
258      !
259#if defined key_iomput
260                                    CALL xios_finalize  ! end mpp communications with xios
261      IF( lk_oasis     )            CALL cpl_finalize   ! end coupling and mpp communications with OASIS
262#else
263      IF    ( lk_oasis ) THEN   ;   CALL cpl_finalize   ! end coupling and mpp communications with OASIS
264      ELSEIF( lk_mpp   ) THEN   ;   CALL mppstop        ! end mpp communications
265      ENDIF
266#endif
267      !
268      IF(lwm) THEN
269         IF( nstop == 0 ) THEN   ;   STOP 0
270         ELSE                    ;   STOP 123
271         ENDIF
272      ENDIF
273      !
274   END SUBROUTINE nemo_gcm
275
276
277   SUBROUTINE nemo_init
278      !!----------------------------------------------------------------------
279      !!                     ***  ROUTINE nemo_init  ***
280      !!
281      !! ** Purpose :   initialization of the NEMO GCM
282      !!----------------------------------------------------------------------
283      INTEGER ::   ios, ilocal_comm   ! local integers
284      !!
285      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
286         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
287         &             ln_timing, ln_diacfl
288      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
289      !!----------------------------------------------------------------------
290      !
291      cxios_context = 'nemo'
292      !
293      !                             !-------------------------------------------------!
294      !                             !     set communicator & select the local rank    !
295      !                             !  must be done as soon as possible to get narea  !
296      !                             !-------------------------------------------------!
297      !
298#if defined key_iomput
299      IF( Agrif_Root() ) THEN
300         IF( lk_oasis ) THEN
301            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
302            CALL xios_initialize( "not used"       , local_comm =ilocal_comm )   ! send nemo communicator to xios
303         ELSE
304            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
305         ENDIF
306      ENDIF
307      CALL mpp_start( ilocal_comm )
308#else
309      IF( lk_oasis ) THEN
310         IF( Agrif_Root() ) THEN
311            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
312         ENDIF
313         CALL mpp_start( ilocal_comm )
314      ELSE
315         CALL mpp_start( )
316      ENDIF
317#endif
318      !
319      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
320      lwm = (narea == 1)                ! control of output namelists
321      !
322      !                             !---------------------------------------------------------------!
323      !                             ! Open output files, reference and configuration namelist files !
324      !                             !---------------------------------------------------------------!
325      !
326      ! open ocean.output as soon as possible to get all output prints (including errors messages)
327      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
328      ! open reference and configuration namelist files
329                  CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
330                  CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
331      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
332      ! open /dev/null file to be able to supress output write easily
333      IF( Agrif_Root() ) THEN
334                  CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
335#ifdef key_agrif
336      ELSE
337                  numnul = Agrif_Parent(numnul)   
338#endif
339      ENDIF
340      !                             !--------------------!
341      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
342      !                             !--------------------!
343      !
344      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
345901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
346      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
347902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
348      !
349      ! finalize the definition of namctl variables
350      IF( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax .OR. MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 )   &
351         &   CALL nemo_set_cfctl( sn_cfctl, .FALSE. )
352      !
353      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
354      !
355      IF(lwp) THEN                      ! open listing units
356         !
357         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
358            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
359         !
360         WRITE(numout,*)
361         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
362         WRITE(numout,*) '                       NEMO team'
363         WRITE(numout,*) '            Ocean General Circulation Model'
364         WRITE(numout,*) '                NEMO version 4.0  (2019) '
365         WRITE(numout,*)
366         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
367         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
368         WRITE(numout,*)
369         WRITE(numout,*) "           o         _,           _,             "
370         WRITE(numout,*) "            o      .' (        .-' /             "
371         WRITE(numout,*) "           o     _/..._'.    .'   /              "
372         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
373         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
374         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
375         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
376         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
377         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
378         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
379         WRITE(numout,*)
380         !
381         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
382         !
383      ENDIF
384      !
385      IF(lwm) WRITE( numond, namctl )
386      !
387      !                             !------------------------------------!
388      !                             !  Set global domain size parameters !
389      !                             !------------------------------------!
390      !
391      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
392903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
393      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
394904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
395      !
396      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
397         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
398      ELSE                              ! user-defined namelist
399         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
400      ENDIF
401      !
402      IF(lwm)   WRITE( numond, namcfg )
403      !
404      !                             !-----------------------------------------!
405      !                             ! mpp parameters and domain decomposition !
406      !                             !-----------------------------------------!
407      CALL mpp_init
408
409      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
410      CALL nemo_alloc()
411
412      ! Initialise time level indices
413      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
414
415      !                             !-------------------------------!
416      !                             !  NEMO general initialization  !
417      !                             !-------------------------------!
418
419      CALL nemo_ctl                          ! Control prints
420      !
421      !                                      ! General initialization
422      IF( ln_timing    )   CALL timing_init     ! timing
423      IF( ln_timing    )   CALL timing_start( 'nemo_init')
424      !
425                           CALL     phy_cst         ! Physical constants
426                           CALL     eos_init        ! Equation of state
427      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
428                           CALL     wad_init        ! Wetting and drying options
429                           CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
430      IF( ln_crs       )   CALL     crs_init(      Nnn )       ! coarsened grid: domain initialization
431      IF( sn_cfctl%l_prtctl )   &
432         &                 CALL prt_ctl_init        ! Print control
433
434                           CALL diurnal_sst_bulk_init       ! diurnal sst
435      IF( ln_diurnal   )   CALL diurnal_sst_coolskin_init   ! cool skin
436      !
437      IF( ln_diurnal_only ) THEN                    ! diurnal only: a subset of the initialisation routines
438         CALL  istate_init( Nbb, Nnn, Naa )         ! ocean initial state (Dynamics and tracers)
439         CALL     sbc_init( Nbb, Nnn, Naa )         ! Forcings : surface module
440         CALL tra_qsr_init                          ! penetrative solar radiation qsr
441         IF( ln_diaobs ) THEN                       ! Observation & model comparison
442            CALL dia_obs_init( Nnn )                ! Initialize observational data
443            CALL dia_obs( nit000 - 1, Nnn )         ! Observation operator for restart
444         ENDIF
445         IF( lk_asminc )   CALL asm_inc_init( Nbb, Nnn, Nrhs )   ! Assimilation increments
446         !
447         RETURN                                       ! end of initialization
448      ENDIF
449      !
450
451                           CALL  istate_init( Nbb, Nnn, Naa )    ! ocean initial state (Dynamics and tracers)
452
453      !                                      ! external forcing
454                           CALL    tide_init                     ! tidal harmonics
455                           CALL     sbc_init( Nbb, Nnn, Naa )    ! surface boundary conditions (including sea-ice)
456                           CALL     bdy_init                     ! Open boundaries initialisation
457
458      !                                      ! Ocean physics
459                           CALL zdf_phy_init( Nnn )    ! Vertical physics
460
461      !                                         ! Lateral physics
462                           CALL ldf_tra_init      ! Lateral ocean tracer physics
463                           CALL ldf_eiv_init      ! eddy induced velocity param.
464                           CALL ldf_dyn_init      ! Lateral ocean momentum physics
465
466      !                                      ! Active tracers
467      IF( ln_traqsr    )   CALL tra_qsr_init      ! penetrative solar radiation qsr
468                           CALL tra_bbc_init      ! bottom heat flux
469                           CALL tra_bbl_init      ! advective (and/or diffusive) bottom boundary layer scheme
470                           CALL tra_dmp_init      ! internal tracer damping
471                           CALL tra_adv_init      ! horizontal & vertical advection
472                           CALL tra_ldf_init      ! lateral mixing
473
474      !                                      ! Dynamics
475      IF( lk_c1d       )   CALL dyn_dmp_init         ! internal momentum damping
476                           CALL dyn_adv_init         ! advection (vector or flux form)
477                           CALL dyn_vor_init         ! vorticity term including Coriolis
478                           CALL dyn_ldf_init         ! lateral mixing
479                           CALL dyn_hpg_init( Nnn )  ! horizontal gradient of Hydrostatic pressure
480                           CALL dyn_spg_init         ! surface pressure gradient
481
482#if defined key_top
483      !                                      ! Passive tracers
484                           CALL     trc_init( Nbb, Nnn, Naa )
485#endif
486      IF( l_ldfslp     )   CALL ldf_slp_init    ! slope of lateral mixing
487
488      !                                      ! Icebergs
489                           CALL icb_init( rn_Dt, nit000)   ! initialise icebergs instance
490
491                                                ! ice shelf
492                           CALL isf_init( Nbb, Nnn, Naa )
493
494      !                                      ! Misc. options
495                           CALL sto_par_init    ! Stochastic parametrization
496      IF( ln_sto_eos   )   CALL sto_pts_init    ! RRandom T/S fluctuations
497
498      !                                      ! Diagnostics
499                           CALL     flo_init( Nnn )    ! drifting Floats
500      IF( ln_diacfl    )   CALL dia_cfl_init    ! Initialise CFL diagnostics
501!                           CALL dia_ptr_init    ! Poleward TRansports initialization
502                           CALL dia_dct_init    ! Sections tranports
503                           CALL dia_hsb_init( Nnn )    ! heat content, salt content and volume budgets
504                           CALL     trd_init( Nnn )    ! Mixed-layer/Vorticity/Integral constraints trends
505                           CALL dia_obs_init( Nnn )    ! Initialize observational data
506                           CALL dia_25h_init( Nbb )    ! 25h mean  outputs
507                           CALL dia_detide_init ! Weights computation for daily detiding of model diagnostics
508      IF( ln_diaobs    )   CALL dia_obs( nit000-1, Nnn )   ! Observation operator for restart
509                           CALL dia_mlr_init    ! Initialisation of IOM context management for multiple-linear-regression analysis
510
511      !                                      ! Assimilation increments
512      IF( lk_asminc    )   CALL asm_inc_init( Nbb, Nnn, Nrhs )   ! Initialize assimilation increments
513      !
514      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
515      !
516      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
517      !
518   END SUBROUTINE nemo_init
519
520
521   SUBROUTINE nemo_ctl
522      !!----------------------------------------------------------------------
523      !!                     ***  ROUTINE nemo_ctl  ***
524      !!
525      !! ** Purpose :   control print setting
526      !!
527      !! ** Method  : - print namctl and namcfg information and check some consistencies
528      !!----------------------------------------------------------------------
529      !
530      IF(lwp) THEN                  ! control print
531         WRITE(numout,*)
532         WRITE(numout,*) 'nemo_ctl: Control prints'
533         WRITE(numout,*) '~~~~~~~~'
534         WRITE(numout,*) '   Namelist namctl'
535         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
536         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
537         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
538         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
539         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
540         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
541         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
542         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin
543         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax
544         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr
545         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr
546         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
547         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
548         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
549         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
550         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
551         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
552         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
553         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
554         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
555      ENDIF
556      !
557      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
558      nictls    = nn_ictls
559      nictle    = nn_ictle
560      njctls    = nn_jctls
561      njctle    = nn_jctle
562      isplt     = nn_isplt
563      jsplt     = nn_jsplt
564
565      IF(lwp) THEN                  ! control print
566         WRITE(numout,*)
567         WRITE(numout,*) '   Namelist namcfg'
568         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
569         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
570         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
571         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
572         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
573         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
574      ENDIF
575      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
576      !
577      !                             ! Parameter control
578      !
579      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
580         IF( lk_mpp .AND. jpnij > 1 ) THEN
581            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
582         ELSE
583            IF( isplt == 1 .AND. jsplt == 1  ) THEN
584               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
585                  &           ' - the print control will be done over the whole domain' )
586            ENDIF
587            ijsplt = isplt * jsplt            ! total number of processors ijsplt
588         ENDIF
589         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
590         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
591         !
592         !                              ! indices used for the SUM control
593         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
594            lsp_area = .FALSE.
595         ELSE                                             ! print control done over a specific  area
596            lsp_area = .TRUE.
597            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
598               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
599               nictls = 1
600            ENDIF
601            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
602               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
603               nictle = jpiglo
604            ENDIF
605            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
606               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
607               njctls = 1
608            ENDIF
609            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
610               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
611               njctle = jpjglo
612            ENDIF
613         ENDIF
614      ENDIF
615      !
616      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
617         &                                                'Compile with key_nosignedzero enabled:',   &
618         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
619      !
620#if defined key_agrif
621      IF( ln_timing )   CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
622#endif
623      !
624   END SUBROUTINE nemo_ctl
625
626
627   SUBROUTINE nemo_closefile
628      !!----------------------------------------------------------------------
629      !!                     ***  ROUTINE nemo_closefile  ***
630      !!
631      !! ** Purpose :   Close the files
632      !!----------------------------------------------------------------------
633      !
634      IF( lk_mpp )   CALL mppsync
635      !
636      CALL iom_close                                 ! close all input/output files managed by iom_*
637      !
638      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
639      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
640      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
641      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
642      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
643      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
644      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
645      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
646      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
647      !
648      numout = 6                                     ! redefine numout in case it is used after this point...
649      !
650   END SUBROUTINE nemo_closefile
651
652
653   SUBROUTINE nemo_alloc
654      !!----------------------------------------------------------------------
655      !!                     ***  ROUTINE nemo_alloc  ***
656      !!
657      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
658      !!
659      !! ** Method  :
660      !!----------------------------------------------------------------------
661      USE diawri    , ONLY : dia_wri_alloc
662      USE dom_oce   , ONLY : dom_oce_alloc
663      USE trc_oce   , ONLY : trc_oce_alloc
664      USE bdy_oce   , ONLY : bdy_oce_alloc
665      !
666      INTEGER :: ierr
667      !!----------------------------------------------------------------------
668      !
669      ierr =        oce_alloc    ()    ! ocean
670      ierr = ierr + dia_wri_alloc()
671      ierr = ierr + dom_oce_alloc()    ! ocean domain
672      ierr = ierr + zdf_oce_alloc()    ! ocean vertical physics
673      ierr = ierr + trc_oce_alloc()    ! shared TRC / TRA arrays
674      ierr = ierr + bdy_oce_alloc()    ! bdy masks (incl. initialization)
675      !
676      CALL mpp_sum( 'nemogcm', ierr )
677      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
678      !
679   END SUBROUTINE nemo_alloc
680
681
682   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto )
683      !!----------------------------------------------------------------------
684      !!                     ***  ROUTINE nemo_set_cfctl  ***
685      !!
686      !! ** Purpose :   Set elements of the output control structure to setto.
687      !!
688      !! ** Method  :   Note this routine can be used to switch on/off some
689      !!                types of output for selected areas.
690      !!----------------------------------------------------------------------
691      TYPE(sn_ctl), INTENT(inout) :: sn_cfctl
692      LOGICAL     , INTENT(in   ) :: setto
693      !!----------------------------------------------------------------------
694      sn_cfctl%l_runstat = setto
695      sn_cfctl%l_trcstat = setto
696      sn_cfctl%l_oceout  = setto
697      sn_cfctl%l_layout  = setto
698      sn_cfctl%l_prtctl  = setto
699      sn_cfctl%l_prttrc  = setto
700      sn_cfctl%l_oasout  = setto
701   END SUBROUTINE nemo_set_cfctl
702
703   !!======================================================================
704END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.