source: NEMO/trunk/src/OCE/nemogcm.F90

Last change on this file was 13558, checked in by smasson, 8 weeks ago

trunk: pass sette tests with debugging option -init=arrays,snan,huge, see #2535

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