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/r4.0-HEAD_r12713_dan_test_clems_branch/src/OCE – NEMO

source: NEMO/branches/UKMO/r4.0-HEAD_r12713_dan_test_clems_branch/src/OCE/nemogcm.F90 @ 12803

Last change on this file since 12803 was 12803, checked in by dancopsey, 2 years ago

Merge in NEMO_4.0.1_GC_couple_pkg

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