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

Last change on this file since 12732 was 12732, checked in by techene, 11 months ago

some cleaning and proper module/routine name, mini bug introduced and corrected in sbcice_cice

  • Property svn:keywords set to Id
File size: 36.4 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      IF( .NOT. Agrif_Root() ) THEN
197         CALL Agrif_ParentGrid_To_ChildGrid()
198         IF( ln_diaobs )   CALL dia_obs_wri
199         IF( ln_timing )   CALL timing_finalize
200         CALL Agrif_ChildGrid_To_ParentGrid()
201      ENDIF
202      !
203# else
204      !
205      IF( .NOT.ln_diurnal_only ) THEN                 !==  Standard time-stepping  ==!
206         !
207         DO WHILE( istp <= nitend .AND. nstop == 0 )
208
209            ncom_stp = istp
210            IF( ln_timing ) THEN
211               zstptiming = MPI_Wtime()
212               IF ( istp == ( nit000 + 1 ) ) elapsed_time = zstptiming
213               IF ( istp ==         nitend ) elapsed_time = zstptiming - elapsed_time
214            ENDIF
215
216#if defined key_qco
217            CALL stp_MLF      ( istp )
218#else
219            CALL stp          ( istp )
220#endif
221            istp = istp + 1
222
223            IF( lwp .AND. ln_timing )   WRITE(numtime,*) 'timing step ', istp-1, ' : ', MPI_Wtime() - zstptiming
224
225         END DO
226         !
227      ELSE                                            !==  diurnal SST time-steeping only  ==!
228         !
229         DO WHILE( istp <= nitend .AND. nstop == 0 )
230            CALL stp_diurnal( istp )   ! time step only the diurnal SST
231            istp = istp + 1
232         END DO
233         !
234      ENDIF
235      !
236# endif
237      !
238#endif
239      !
240      IF( ln_diaobs   )   CALL dia_obs_wri
241      !
242      IF( ln_icebergs )   CALL icb_end( nitend )
243
244      !                            !------------------------!
245      !                            !==  finalize the run  ==!
246      !                            !------------------------!
247      IF(lwp) WRITE(numout,cform_aaa)        ! Flag AAAAAAA
248      !
249      IF( nstop /= 0 .AND. lwp ) THEN        ! error print
250         WRITE(ctmp1,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
251         CALL ctl_stop( ctmp1 )
252      ENDIF
253      !
254      IF( ln_timing )   CALL timing_finalize
255      !
256      CALL nemo_closefile
257      !
258#if defined key_iomput
259                                    CALL xios_finalize  ! end mpp communications with xios
260      IF( lk_oasis     )            CALL cpl_finalize   ! end coupling and mpp communications with OASIS
261#else
262      IF    ( lk_oasis ) THEN   ;   CALL cpl_finalize   ! end coupling and mpp communications with OASIS
263      ELSEIF( lk_mpp   ) THEN   ;   CALL mppstop      ! end mpp communications
264      ENDIF
265#endif
266      !
267      IF(lwm) THEN
268         IF( nstop == 0 ) THEN   ;   STOP 0
269         ELSE                    ;   STOP 123
270         ENDIF
271      ENDIF
272      !
273   END SUBROUTINE nemo_gcm
274
275
276   SUBROUTINE nemo_init
277      !!----------------------------------------------------------------------
278      !!                     ***  ROUTINE nemo_init  ***
279      !!
280      !! ** Purpose :   initialization of the NEMO GCM
281      !!----------------------------------------------------------------------
282      INTEGER ::   ios, ilocal_comm   ! local integers
283      !!
284      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
285         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
286         &             ln_timing, ln_diacfl
287      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
288      !!----------------------------------------------------------------------
289      !
290      cxios_context = 'nemo'
291      !
292      !                             !-------------------------------------------------!
293      !                             !     set communicator & select the local rank    !
294      !                             !  must be done as soon as possible to get narea  !
295      !                             !-------------------------------------------------!
296      !
297#if defined key_iomput
298      IF( Agrif_Root() ) THEN
299         IF( lk_oasis ) THEN
300            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
301            CALL xios_initialize( "not used"       , local_comm =ilocal_comm )   ! send nemo communicator to xios
302         ELSE
303            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
304         ENDIF
305      ENDIF
306      CALL mpp_start( ilocal_comm )
307#else
308      IF( lk_oasis ) THEN
309         IF( Agrif_Root() ) THEN
310            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
311         ENDIF
312         CALL mpp_start( ilocal_comm )
313      ELSE
314         CALL mpp_start( )
315      ENDIF
316#endif
317      !
318      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
319      lwm = (narea == 1)                ! control of output namelists
320      !
321      !                             !---------------------------------------------------------------!
322      !                             ! Open output files, reference and configuration namelist files !
323      !                             !---------------------------------------------------------------!
324      !
325      ! open ocean.output as soon as possible to get all output prints (including errors messages)
326      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
327      ! open reference and configuration namelist files
328                  CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
329                  CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
330      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
331      ! open /dev/null file to be able to supress output write easily
332      IF( Agrif_Root() ) THEN
333                  CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
334#ifdef key_agrif
335      ELSE
336                  numnul = Agrif_Parent(numnul)   
337#endif
338      ENDIF
339      !                             !--------------------!
340      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
341      !                             !--------------------!
342      !
343      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
344901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
345      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
346902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
347      !
348      ! finalize the definition of namctl variables
349      IF( sn_cfctl%l_allon ) THEN
350         ! Turn on all options.
351         CALL nemo_set_cfctl( sn_cfctl, .TRUE., .TRUE. )
352         ! Ensure all processors are active
353         sn_cfctl%procmin = 0 ; sn_cfctl%procmax = 1000000 ; sn_cfctl%procincr = 1
354      ELSEIF( sn_cfctl%l_config ) THEN
355         ! Activate finer control of report outputs
356         ! optionally switch off output from selected areas (note this only
357         ! applies to output which does not involve global communications)
358         IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax  ) .OR. &
359           & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) )    &
360           &   CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
361      ELSE
362         ! turn off all options.
363         CALL nemo_set_cfctl( sn_cfctl, .FALSE., .TRUE. )
364      ENDIF
365      !
366      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
367      !
368      IF(lwp) THEN                      ! open listing units
369         !
370         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
371            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
372         !
373         WRITE(numout,*)
374         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
375         WRITE(numout,*) '                       NEMO team'
376         WRITE(numout,*) '            Ocean General Circulation Model'
377         WRITE(numout,*) '                NEMO version 4.0  (2019) '
378         WRITE(numout,*)
379         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
380         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
381         WRITE(numout,*)
382         WRITE(numout,*) "           o         _,           _,             "
383         WRITE(numout,*) "            o      .' (        .-' /             "
384         WRITE(numout,*) "           o     _/..._'.    .'   /              "
385         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
386         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
387         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
388         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
389         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
390         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
391         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
392         WRITE(numout,*)
393         !
394         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
395         !
396      ENDIF
397      !
398      IF(lwm) WRITE( numond, namctl )
399      !
400      !                             !------------------------------------!
401      !                             !  Set global domain size parameters !
402      !                             !------------------------------------!
403      !
404      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
405903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
406      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
407904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
408      !
409      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
410         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
411      ELSE                              ! user-defined namelist
412         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
413      ENDIF
414      !
415      IF(lwm)   WRITE( numond, namcfg )
416      !
417      !                             !-----------------------------------------!
418      !                             ! mpp parameters and domain decomposition !
419      !                             !-----------------------------------------!
420      CALL mpp_init
421
422      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
423      CALL nemo_alloc()
424
425      ! Initialise time level indices
426      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
427
428      !                             !-------------------------------!
429      !                             !  NEMO general initialization  !
430      !                             !-------------------------------!
431
432      CALL nemo_ctl                          ! Control prints
433      !
434      !                                      ! General initialization
435      IF( ln_timing    )   CALL timing_init     ! timing
436      IF( ln_timing    )   CALL timing_start( 'nemo_init')
437      !
438                           CALL     phy_cst         ! Physical constants
439                           CALL     eos_init        ! Equation of state
440      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
441                           CALL     wad_init        ! Wetting and drying options
442                           CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
443      IF( ln_crs       )   CALL     crs_init(      Nnn )       ! coarsened grid: domain initialization
444      IF( sn_cfctl%l_prtctl )   &
445         &                 CALL prt_ctl_init        ! Print control
446
447                           CALL diurnal_sst_bulk_init       ! diurnal sst
448      IF( ln_diurnal   )   CALL diurnal_sst_coolskin_init   ! cool skin
449      !
450      IF( ln_diurnal_only ) THEN                    ! diurnal only: a subset of the initialisation routines
451         CALL  istate_init( Nbb, Nnn, Naa )         ! ocean initial state (Dynamics and tracers)
452         CALL     sbc_init( Nbb, Nnn, Naa )         ! Forcings : surface module
453         CALL tra_qsr_init                          ! penetrative solar radiation qsr
454         IF( ln_diaobs ) THEN                       ! Observation & model comparison
455            CALL dia_obs_init( Nnn )                ! Initialize observational data
456            CALL dia_obs( nit000 - 1, Nnn )         ! Observation operator for restart
457         ENDIF
458         IF( lk_asminc )   CALL asm_inc_init( Nbb, Nnn, Nrhs )   ! Assimilation increments
459         !
460         RETURN                                       ! end of initialization
461      ENDIF
462      !
463
464                           CALL  istate_init( Nbb, Nnn, Naa )    ! ocean initial state (Dynamics and tracers)
465
466      !                                      ! external forcing
467                           CALL    tide_init                     ! tidal harmonics
468                           CALL     sbc_init( Nbb, Nnn, Naa )    ! surface boundary conditions (including sea-ice)
469                           CALL     bdy_init                     ! Open boundaries initialisation
470
471      !                                      ! Ocean physics
472                           CALL zdf_phy_init( Nnn )    ! Vertical physics
473
474      !                                         ! Lateral physics
475                           CALL ldf_tra_init      ! Lateral ocean tracer physics
476                           CALL ldf_eiv_init      ! eddy induced velocity param.
477                           CALL ldf_dyn_init      ! Lateral ocean momentum physics
478
479      !                                      ! Active tracers
480      IF( ln_traqsr    )   CALL tra_qsr_init      ! penetrative solar radiation qsr
481                           CALL tra_bbc_init      ! bottom heat flux
482                           CALL tra_bbl_init      ! advective (and/or diffusive) bottom boundary layer scheme
483                           CALL tra_dmp_init      ! internal tracer damping
484                           CALL tra_adv_init      ! horizontal & vertical advection
485                           CALL tra_ldf_init      ! lateral mixing
486
487      !                                      ! Dynamics
488      IF( lk_c1d       )   CALL dyn_dmp_init         ! internal momentum damping
489                           CALL dyn_adv_init         ! advection (vector or flux form)
490                           CALL dyn_vor_init         ! vorticity term including Coriolis
491                           CALL dyn_ldf_init         ! lateral mixing
492                           CALL dyn_hpg_init( Nnn )  ! horizontal gradient of Hydrostatic pressure
493                           CALL dyn_spg_init         ! surface pressure gradient
494
495#if defined key_top
496      !                                      ! Passive tracers
497                           CALL     trc_init( Nbb, Nnn, Naa )
498#endif
499      IF( l_ldfslp     )   CALL ldf_slp_init    ! slope of lateral mixing
500
501      !                                      ! Icebergs
502                           CALL icb_init( rn_Dt, nit000)   ! initialise icebergs instance
503
504                                                ! ice shelf
505                           CALL isf_init( Nbb, Nnn, Naa )
506
507      !                                      ! Misc. options
508                           CALL sto_par_init    ! Stochastic parametrization
509      IF( ln_sto_eos   )   CALL sto_pts_init    ! RRandom T/S fluctuations
510
511      !                                      ! Diagnostics
512                           CALL     flo_init( Nnn )    ! drifting Floats
513      IF( ln_diacfl    )   CALL dia_cfl_init    ! Initialise CFL diagnostics
514!                           CALL dia_ptr_init    ! Poleward TRansports initialization
515                           CALL dia_dct_init    ! Sections tranports
516                           CALL dia_hsb_init( Nnn )    ! heat content, salt content and volume budgets
517                           CALL     trd_init( Nnn )    ! Mixed-layer/Vorticity/Integral constraints trends
518                           CALL dia_obs_init( Nnn )    ! Initialize observational data
519                           CALL dia_25h_init( Nbb )    ! 25h mean  outputs
520                           CALL dia_detide_init ! Weights computation for daily detiding of model diagnostics
521      IF( ln_diaobs    )   CALL dia_obs( nit000-1, Nnn )   ! Observation operator for restart
522                           CALL dia_mlr_init    ! Initialisation of IOM context management for multiple-linear-regression analysis
523
524      !                                      ! Assimilation increments
525      IF( lk_asminc    )   CALL asm_inc_init( Nbb, Nnn, Nrhs )   ! Initialize assimilation increments
526      !
527      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
528      !
529      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
530      !
531   END SUBROUTINE nemo_init
532
533
534   SUBROUTINE nemo_ctl
535      !!----------------------------------------------------------------------
536      !!                     ***  ROUTINE nemo_ctl  ***
537      !!
538      !! ** Purpose :   control print setting
539      !!
540      !! ** Method  : - print namctl and namcfg information and check some consistencies
541      !!----------------------------------------------------------------------
542      !
543      IF(lwp) THEN                  ! control print
544         WRITE(numout,*)
545         WRITE(numout,*) 'nemo_ctl: Control prints'
546         WRITE(numout,*) '~~~~~~~~'
547         WRITE(numout,*) '   Namelist namctl'
548         WRITE(numout,*) '                              sn_cfctl%l_glochk  = ', sn_cfctl%l_glochk
549         WRITE(numout,*) '                              sn_cfctl%l_allon   = ', sn_cfctl%l_allon
550         WRITE(numout,*) '       finer control over o/p sn_cfctl%l_config  = ', sn_cfctl%l_config
551         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
552         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
553         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
554         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
555         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
556         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
557         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
558         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin
559         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax
560         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr
561         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr
562         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
563         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
564         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
565         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
566         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
567         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
568         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
569         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
570         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
571      ENDIF
572      !
573      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
574      nictls    = nn_ictls
575      nictle    = nn_ictle
576      njctls    = nn_jctls
577      njctle    = nn_jctle
578      isplt     = nn_isplt
579      jsplt     = nn_jsplt
580
581      IF(lwp) THEN                  ! control print
582         WRITE(numout,*)
583         WRITE(numout,*) '   Namelist namcfg'
584         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
585         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
586         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
587         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
588         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
589         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
590      ENDIF
591      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
592      !
593      !                             ! Parameter control
594      !
595      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
596         IF( lk_mpp .AND. jpnij > 1 ) THEN
597            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
598         ELSE
599            IF( isplt == 1 .AND. jsplt == 1  ) THEN
600               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
601                  &           ' - the print control will be done over the whole domain' )
602            ENDIF
603            ijsplt = isplt * jsplt            ! total number of processors ijsplt
604         ENDIF
605         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
606         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
607         !
608         !                              ! indices used for the SUM control
609         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
610            lsp_area = .FALSE.
611         ELSE                                             ! print control done over a specific  area
612            lsp_area = .TRUE.
613            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
614               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
615               nictls = 1
616            ENDIF
617            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
618               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
619               nictle = jpiglo
620            ENDIF
621            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
622               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
623               njctls = 1
624            ENDIF
625            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
626               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
627               njctle = jpjglo
628            ENDIF
629         ENDIF
630      ENDIF
631      !
632      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
633         &                                                'Compile with key_nosignedzero enabled:',   &
634         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
635      !
636#if defined key_agrif
637      IF( ln_timing )   CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
638#endif
639      !
640   END SUBROUTINE nemo_ctl
641
642
643   SUBROUTINE nemo_closefile
644      !!----------------------------------------------------------------------
645      !!                     ***  ROUTINE nemo_closefile  ***
646      !!
647      !! ** Purpose :   Close the files
648      !!----------------------------------------------------------------------
649      !
650      IF( lk_mpp )   CALL mppsync
651      !
652      CALL iom_close                                 ! close all input/output files managed by iom_*
653      !
654      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
655      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
656      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
657      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
658      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
659      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
660      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
661      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
662      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
663      !
664      numout = 6                                     ! redefine numout in case it is used after this point...
665      !
666   END SUBROUTINE nemo_closefile
667
668
669   SUBROUTINE nemo_alloc
670      !!----------------------------------------------------------------------
671      !!                     ***  ROUTINE nemo_alloc  ***
672      !!
673      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
674      !!
675      !! ** Method  :
676      !!----------------------------------------------------------------------
677      USE diawri    , ONLY : dia_wri_alloc
678      USE dom_oce   , ONLY : dom_oce_alloc
679      USE trc_oce   , ONLY : trc_oce_alloc
680      USE bdy_oce   , ONLY : bdy_oce_alloc
681      !
682      INTEGER :: ierr
683      !!----------------------------------------------------------------------
684      !
685      ierr =        oce_alloc    ()    ! ocean
686      ierr = ierr + dia_wri_alloc()
687      ierr = ierr + dom_oce_alloc()    ! ocean domain
688      ierr = ierr + zdf_oce_alloc()    ! ocean vertical physics
689      ierr = ierr + trc_oce_alloc()    ! shared TRC / TRA arrays
690      ierr = ierr + bdy_oce_alloc()    ! bdy masks (incl. initialization)
691      !
692      CALL mpp_sum( 'nemogcm', ierr )
693      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
694      !
695   END SUBROUTINE nemo_alloc
696
697
698   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
699      !!----------------------------------------------------------------------
700      !!                     ***  ROUTINE nemo_set_cfctl  ***
701      !!
702      !! ** Purpose :   Set elements of the output control structure to setto.
703      !!                for_all should be .false. unless all areas are to be
704      !!                treated identically.
705      !!
706      !! ** Method  :   Note this routine can be used to switch on/off some
707      !!                types of output for selected areas but any output types
708      !!                that involve global communications (e.g. mpp_max, glob_sum)
709      !!                should be protected from selective switching by the
710      !!                for_all argument
711      !!----------------------------------------------------------------------
712      LOGICAL :: setto, for_all
713      TYPE(sn_ctl) :: sn_cfctl
714      !!----------------------------------------------------------------------
715      IF( for_all ) THEN
716         sn_cfctl%l_runstat = setto
717         sn_cfctl%l_trcstat = setto
718      ENDIF
719      sn_cfctl%l_oceout  = setto
720      sn_cfctl%l_layout  = setto
721      sn_cfctl%l_prtctl  = setto
722      sn_cfctl%l_prttrc  = setto
723      sn_cfctl%l_oasout  = setto
724   END SUBROUTINE nemo_set_cfctl
725
726   !!======================================================================
727END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.