source: NEMO/branches/2019/dev_r11879_ENHANCE-05_SimonM-Harmonic_Analysis/src/OCE/nemogcm.F90 @ 12097

Last change on this file since 12097 was 12022, checked in by smueller, 11 months ago

Alternative implementation for the computation of daily detided averages (currently M2-detided averages only) of model diagnostics (ticket #2175)

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