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

Last change on this file since 12214 was 12214, checked in by smasson, 22 months ago

trunk: put back 1 line accidentally deleted by [12206]

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