New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
nemogcm.F90 in NEMO/branches/UKMO/NEMO_4.0_mirror_text_diagnostics/src/OCE – NEMO

source: NEMO/branches/UKMO/NEMO_4.0_mirror_text_diagnostics/src/OCE/nemogcm.F90 @ 10987

Last change on this file since 10987 was 10987, checked in by andmirek, 6 years ago

GMED 462 print ln_flush value to numout

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