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

Last change on this file since 12641 was 12641, checked in by smasson, 6 months ago

trunk: numnul with Agrif, see #2430

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