source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/SWE/nemogcm.F90 @ 12983

Last change on this file since 12983 was 12983, checked in by techene, 4 months ago

SWE r12822 from Antoine updated with qco and rk3 options : draft 1

File size: 30.8 KB
Line 
1MODULE nemogcm
2   !!======================================================================
3   !!                       ***  MODULE nemogcm   ***
4   !! Ocean system   : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
5   !!======================================================================
6   !! History :  OPA  ! 1990-10  (C. Levy, G. Madec)  Original code
7   !!            7.0  ! 1991-11  (M. Imbard, C. Levy, G. Madec)
8   !!            7.1  ! 1993-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
9   !!                             P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
10   !!             -   ! 1992-06  (L.Terray)  coupling implementation
11   !!             -   ! 1993-11  (M.A. Filiberti) IGLOO sea-ice
12   !!            8.0  ! 1996-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
13   !!                             P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
14   !!            8.1  ! 1997-06  (M. Imbard, G. Madec)
15   !!            8.2  ! 1999-11  (M. Imbard, H. Goosse)  sea-ice model
16   !!                 ! 1999-12  (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols)  OPEN-MP
17   !!                 ! 2000-07  (J-M Molines, M. Imbard)  Open Boundary Conditions  (CLIPPER)
18   !!   NEMO     1.0  ! 2002-08  (G. Madec)  F90: Free form and modules
19   !!             -   ! 2004-06  (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
20   !!             -   ! 2004-08  (C. Talandier) New trends organization
21   !!             -   ! 2005-06  (C. Ethe) Add the 1D configuration possibility
22   !!             -   ! 2005-11  (V. Garnier) Surface pressure gradient organization
23   !!             -   ! 2006-03  (L. Debreu, C. Mazauric)  Agrif implementation
24   !!             -   ! 2006-04  (G. Madec, R. Benshila)  Step reorganization
25   !!             -   ! 2007-07  (J. Chanut, A. Sellar) Unstructured open boundaries (BDY)
26   !!            3.2  ! 2009-08  (S. Masson)  open/write in the listing file in mpp
27   !!            3.3  ! 2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
28   !!             -   ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
29   !!            3.3.1! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
30   !!             -   ! 2011-11  (C. Harris) decomposition changes for running with CICE
31   !!            3.6  ! 2012-05  (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
32   !!             -   ! 2014-12  (G. Madec) remove KPP scheme and cross-land advection (cla)
33   !!            4.0  ! 2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
34   !!----------------------------------------------------------------------
35
36   !!----------------------------------------------------------------------
37   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
38   !!   nemo_init     : initialization of the NEMO system
39   !!   nemo_ctl      : initialisation of the contol print
40   !!   nemo_closefile: close remaining open files
41   !!   nemo_alloc    : dynamical allocation
42   !!----------------------------------------------------------------------
43   USE step_oce       ! module used in the ocean time stepping module (step.F90)
44   USE phycst         ! physical constant                  (par_cst routine)
45   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
46   USE closea         ! treatment of closed seas (for ln_closea)
47   USE usrdef_nam     ! user defined configuration
48   USE tide_mod, ONLY : tide_init ! tidal components initialization   (tide_init routine)
49   USE bdy_oce,  ONLY : ln_bdy
50   USE bdyini         ! open boundary cond. setting       (bdy_init routine)
51   USE istate         ! initial state setting          (istate_init routine)
52   USE ldfdyn         ! lateral viscosity setting      (ldfdyn_init routine)
53   USE ldftra         ! lateral diffusivity setting    (ldftra_init routine)
54   USE trdini         ! dyn/tra trends initialization     (trd_init routine)
55   USE asminc         ! assimilation increments     
56   USE asmbkg         ! writing out state trajectory
57   USE diaptr         ! poleward transports           (dia_ptr_init routine)
58   USE diadct         ! sections transports           (dia_dct_init routine)
59   USE diaobs         ! Observation diagnostics       (dia_obs_init routine)
60   USE diacfl         ! CFL diagnostics               (dia_cfl_init routine)
61   USE diamlr         ! IOM context management for multiple-linear-regression analysis
62#if defined key_RK3
63   USE stpRK3
64#elif defined key_qco
65   USE stpLF
66#else
67   USE step           ! NEMO time-stepping                 (stp     routine)
68#endif
69   USE isfstp         ! ice shelf                     (isf_stp_init routine)
70   USE icbini         ! handle bergs, initialisation
71   USE icbstp         ! handle bergs, calving, themodynamics and transport
72   USE cpl_oasis3     ! OASIS3 coupling
73   USE c1d            ! 1D configuration
74   USE step_c1d       ! Time stepping loop for the 1D configuration
75   USE dyndmp         ! Momentum damping
76   USE stopar         ! Stochastic param.: ???
77   USE stopts         ! Stochastic param.: ???
78   USE diu_layers     ! diurnal bulk SST and coolskin
79   USE crsini         ! initialise grid coarsening utility
80   USE dia25h         ! 25h mean output
81   USE diadetide      ! Weights computation for daily detiding of model diagnostics
82   USE sbc_oce , ONLY : lk_oasis
83   USE wet_dry        ! Wetting and drying setting   (wad_init routine)
84#if defined key_top
85   USE trcini         ! passive tracer initialisation
86#endif
87#if defined key_nemocice_decomp
88   USE ice_domain_size, only: nx_global, ny_global
89#endif
90   !
91   USE lib_mpp        ! distributed memory computing
92   USE mppini         ! shared/distributed memory setting (mpp_init routine)
93   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
94   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
95#if defined key_iomput
96   USE xios           ! xIOserver
97#endif
98#if defined key_agrif
99   USE agrif_all_update   ! Master Agrif update
100#endif
101
102   IMPLICIT NONE
103   PRIVATE
104
105   PUBLIC   nemo_gcm    ! called by model.F90
106   PUBLIC   nemo_init   ! needed by AGRIF
107   PUBLIC   nemo_alloc  ! needed by TAM
108
109   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
110
111#if defined key_mpp_mpi
112   ! need MPI_Wtime
113   INCLUDE 'mpif.h'
114#endif
115
116   !!----------------------------------------------------------------------
117   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
118   !! $Id: nemogcm.F90 12614 2020-03-26 14:59:52Z gm $
119   !! Software governed by the CeCILL license (see ./LICENSE)
120   !!----------------------------------------------------------------------
121CONTAINS
122
123   SUBROUTINE nemo_gcm
124      !!----------------------------------------------------------------------
125      !!                     ***  ROUTINE nemo_gcm  ***
126      !!
127      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
128      !!              curvilinear mesh on the sphere.
129      !!
130      !! ** Method  : - model general initialization
131      !!              - launch the time-stepping (stp routine)
132      !!              - finalize the run by closing files and communications
133      !!
134      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
135      !!              Madec, 2008, internal report, IPSL.
136      !!----------------------------------------------------------------------
137      INTEGER ::   istp   ! time step index
138      REAL(wp)::   zstptiming   ! elapsed time for 1 time step
139      !!----------------------------------------------------------------------
140      !
141#if defined key_agrif
142      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
143#endif
144      !                            !-----------------------!
145      CALL nemo_init               !==  Initialisations  ==!
146      !                            !-----------------------!
147     
148#if defined key_agrif
149      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
150      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
151      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
152# if defined key_top
153      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
154# endif
155# if defined key_si3
156      CALL Agrif_Declare_Var_ice   !  "      "   "   "      "  Sea ice
157# endif
158#endif
159      ! check that all process are still there... If some process have an error,
160      ! they will never enter in step and other processes will wait until the end of the cpu time!
161      CALL mpp_max( 'nemogcm', nstop )
162
163      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
164
165      !                            !-----------------------!
166      !                            !==   time stepping   ==!
167      !                            !-----------------------!
168      !
169      !                                               !== set the model time-step  ==!
170      !
171      istp = nit000
172      !
173      !                                               !==  Standard time-stepping  ==!
174      !
175      DO WHILE( istp <= nitend .AND. nstop == 0 )
176
177         ncom_stp = istp
178         IF( ln_timing ) THEN
179            zstptiming = MPI_Wtime()
180            IF ( istp == ( nit000 + 1 ) ) elapsed_time = zstptiming
181            IF ( istp ==         nitend ) elapsed_time = zstptiming - elapsed_time
182         ENDIF
183#if defined key_RK3
184         CALL stp_RK3    ( istp )
185#elif defined key_qco
186         CALL stp_LF     ( istp )
187#else
188         CALL stp        ( istp )
189#endif
190         istp = istp + 1
191
192         IF( lwp .AND. ln_timing )   WRITE(numtime,*) 'timing step ', istp-1, ' : ', MPI_Wtime() - zstptiming
193
194      END DO
195      !
196      !
197      !                            !------------------------!
198      !                            !==  finalize the run  ==!
199      !                            !------------------------!
200      IF(lwp) WRITE(numout,cform_aaa)        ! Flag AAAAAAA
201      !
202      IF( nstop /= 0 .AND. lwp ) THEN        ! error print
203         WRITE(ctmp1,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
204         CALL ctl_stop( ctmp1 )
205      ENDIF
206      !
207      IF( ln_timing )   CALL timing_finalize
208      !
209      CALL nemo_closefile
210      !
211#if defined key_iomput
212                       CALL xios_finalize  ! end mpp communications with xios
213#else
214      IF( lk_mpp   )   CALL mppstop      ! end mpp communications
215#endif
216      !
217      IF(lwm) THEN
218         IF( nstop == 0 ) THEN   ;   STOP 0
219         ELSE                    ;   STOP 123
220         ENDIF
221      ENDIF
222      !
223   END SUBROUTINE nemo_gcm
224
225
226   SUBROUTINE nemo_init
227      !!----------------------------------------------------------------------
228      !!                     ***  ROUTINE nemo_init  ***
229      !!
230      !! ** Purpose :   initialization of the NEMO GCM
231      !!----------------------------------------------------------------------
232      INTEGER ::   ios, ilocal_comm   ! local integers
233      !!
234      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
235         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
236         &             ln_timing, ln_diacfl
237      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
238      !!----------------------------------------------------------------------
239      !
240      cxios_context = 'nemo'
241      !
242      !                             !-------------------------------------------------!
243      !                             !     set communicator & select the local rank    !
244      !                             !  must be done as soon as possible to get narea  !
245      !                             !-------------------------------------------------!
246      !
247#if defined key_iomput
248      IF( Agrif_Root() ) THEN
249         IF( lk_oasis ) THEN
250            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
251            CALL xios_initialize( "not used"       , local_comm =ilocal_comm )   ! send nemo communicator to xios
252         ELSE
253            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
254         ENDIF
255      ENDIF
256      CALL mpp_start( ilocal_comm )
257#else
258      IF( lk_oasis ) THEN
259         IF( Agrif_Root() ) THEN
260            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
261         ENDIF
262         CALL mpp_start( ilocal_comm )
263      ELSE
264         CALL mpp_start( )
265      ENDIF
266#endif
267      !
268      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
269      lwm = (narea == 1)                ! control of output namelists
270      !
271      !                             !---------------------------------------------------------------!
272      !                             ! Open output files, reference and configuration namelist files !
273      !                             !---------------------------------------------------------------!
274      !
275      ! open ocean.output as soon as possible to get all output prints (including errors messages)
276      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
277      ! open reference and configuration namelist files
278                  CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
279                  CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
280      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
281      ! open /dev/null file to be able to supress output write easily
282                  CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
283      !
284      !                             !--------------------!
285      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
286      !                             !--------------------!
287      !
288      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
289901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
290      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
291902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
292      !
293      ! finalize the definition of namctl variables
294      IF( sn_cfctl%l_allon ) THEN
295         ! Turn on all options.
296         CALL nemo_set_cfctl( sn_cfctl, .TRUE., .TRUE. )
297         ! Ensure all processors are active
298         sn_cfctl%procmin = 0 ; sn_cfctl%procmax = 1000000 ; sn_cfctl%procincr = 1
299      ELSEIF( sn_cfctl%l_config ) THEN
300         ! Activate finer control of report outputs
301         ! optionally switch off output from selected areas (note this only
302         ! applies to output which does not involve global communications)
303         IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax  ) .OR. &
304           & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) )    &
305           &   CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
306      ELSE
307         ! turn off all options.
308         CALL nemo_set_cfctl( sn_cfctl, .FALSE., .TRUE. )
309      ENDIF
310      !
311      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
312      !
313      IF(lwp) THEN                      ! open listing units
314         !
315         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
316            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
317         !
318         WRITE(numout,*)
319         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
320         WRITE(numout,*) '                       NEMO team'
321         WRITE(numout,*) '            Ocean General Circulation Model'
322         WRITE(numout,*) '                NEMO version 4.0  (2019) '
323         WRITE(numout,*)
324         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
325         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
326         WRITE(numout,*)
327         WRITE(numout,*) "           o         _,           _,             "
328         WRITE(numout,*) "            o      .' (        .-' /             "
329         WRITE(numout,*) "           o     _/..._'.    .'   /              "
330         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
331         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
332         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
333         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
334         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
335         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
336         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
337         WRITE(numout,*)
338         !
339         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
340         !
341      ENDIF
342      !
343      IF(lwm) WRITE( numond, namctl )
344      !
345      !                             !------------------------------------!
346      !                             !  Set global domain size parameters !
347      !                             !------------------------------------!
348      !
349      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
350903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
351      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
352904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )   
353      !
354      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
355         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
356      ELSE                              ! user-defined namelist
357         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
358      ENDIF
359      !
360      IF(lwm)   WRITE( numond, namcfg )
361      !
362      !                             !-----------------------------------------!
363      !                             ! mpp parameters and domain decomposition !
364      !                             !-----------------------------------------!
365      CALL mpp_init
366
367      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
368      CALL nemo_alloc()
369
370      ! Initialise time level indices
371      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
372
373      !                             !-------------------------------!
374      !                             !  NEMO general initialization  !
375      !                             !-------------------------------!
376
377      CALL nemo_ctl                          ! Control prints
378      !
379      !                                      ! General initialization
380      IF( ln_timing    )   CALL timing_init     ! timing
381      IF( ln_timing    )   CALL timing_start( 'nemo_init')
382      !
383                           CALL     phy_cst         ! Physical constants
384                           
385                           CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
386
387      IF( sn_cfctl%l_prtctl )   &
388         &                 CALL prt_ctl_init        ! Print control
389
390                           CALL  istate_init( Nbb, Nnn, Naa )    ! ocean initial state (Dynamics and tracers)
391
392      !                                      ! external forcing
393                           CALL    tide_init                     ! tidal harmonics
394
395                           CALL     sbc_init( Nbb, Nnn, Naa )    ! surface boundary conditions (including sea-ice)
396                           
397
398      !                                      ! Ocean physics                                   
399      !                                         ! Lateral physics
400                           CALL ldf_dyn_init      ! Lateral ocean momentum physics
401                           
402                           
403      !                                      ! Dynamics
404                           CALL dyn_adv_init         ! advection (vector or flux form)
405
406                           CALL dyn_vor_init         ! vorticity term including Coriolis
407
408                           CALL dyn_ldf_init         ! lateral mixing
409
410                           CALL dyn_spg_init         ! surface pressure gradient
411
412      !                                      ! Diagnostics
413                           CALL     flo_init( Nnn )    ! drifting Floats
414                           
415      IF( ln_diacfl    )   CALL dia_cfl_init    ! Initialise CFL diagnostics
416
417                           CALL     trd_init( Nnn )    ! Mixed-layer/Vorticity/Integral constraints trends
418
419
420      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
421      !
422      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
423      !
424
425   END SUBROUTINE nemo_init
426
427
428   SUBROUTINE nemo_ctl
429      !!----------------------------------------------------------------------
430      !!                     ***  ROUTINE nemo_ctl  ***
431      !!
432      !! ** Purpose :   control print setting
433      !!
434      !! ** Method  : - print namctl and namcfg information and check some consistencies
435      !!----------------------------------------------------------------------
436      !
437      IF(lwp) THEN                  ! control print
438         WRITE(numout,*)
439         WRITE(numout,*) 'nemo_ctl: Control prints'
440         WRITE(numout,*) '~~~~~~~~'
441         WRITE(numout,*) '   Namelist namctl'
442         WRITE(numout,*) '                              sn_cfctl%l_glochk  = ', sn_cfctl%l_glochk
443         WRITE(numout,*) '                              sn_cfctl%l_allon   = ', sn_cfctl%l_allon
444         WRITE(numout,*) '       finer control over o/p sn_cfctl%l_config  = ', sn_cfctl%l_config
445         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
446         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
447         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
448         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
449         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
450         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
451         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
452         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin 
453         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax 
454         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr 
455         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr 
456         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
457         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
458         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
459         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
460         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
461         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
462         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
463         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
464         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
465      ENDIF
466      !
467      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
468      nictls    = nn_ictls
469      nictle    = nn_ictle
470      njctls    = nn_jctls
471      njctle    = nn_jctle
472      isplt     = nn_isplt
473      jsplt     = nn_jsplt
474
475      IF(lwp) THEN                  ! control print
476         WRITE(numout,*)
477         WRITE(numout,*) '   Namelist namcfg'
478         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
479         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
480         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
481         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
482         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
483         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
484      ENDIF
485      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
486      !
487      !                             ! Parameter control
488      !
489      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
490         IF( lk_mpp .AND. jpnij > 1 ) THEN
491            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
492         ELSE
493            IF( isplt == 1 .AND. jsplt == 1  ) THEN
494               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
495                  &           ' - the print control will be done over the whole domain' )
496            ENDIF
497            ijsplt = isplt * jsplt            ! total number of processors ijsplt
498         ENDIF
499         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
500         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
501         !
502         !                              ! indices used for the SUM control
503         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
504            lsp_area = .FALSE.
505         ELSE                                             ! print control done over a specific  area
506            lsp_area = .TRUE.
507            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
508               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
509               nictls = 1
510            ENDIF
511            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
512               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
513               nictle = jpiglo
514            ENDIF
515            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
516               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
517               njctls = 1
518            ENDIF
519            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
520               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
521               njctle = jpjglo
522            ENDIF
523         ENDIF
524      ENDIF
525      !
526      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
527         &                                                'Compile with key_nosignedzero enabled:',   &
528         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
529      !
530#if defined key_agrif
531      IF( ln_timing )   CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
532#endif
533      !
534   END SUBROUTINE nemo_ctl
535
536
537   SUBROUTINE nemo_closefile
538      !!----------------------------------------------------------------------
539      !!                     ***  ROUTINE nemo_closefile  ***
540      !!
541      !! ** Purpose :   Close the files
542      !!----------------------------------------------------------------------
543      !
544      IF( lk_mpp )   CALL mppsync
545      !
546      CALL iom_close                                 ! close all input/output files managed by iom_*
547      !
548      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
549      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
550      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
551      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
552      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
553      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
554      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
555      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
556      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
557      !
558      numout = 6                                     ! redefine numout in case it is used after this point...
559      !
560   END SUBROUTINE nemo_closefile
561
562
563   SUBROUTINE nemo_alloc
564      !!----------------------------------------------------------------------
565      !!                     ***  ROUTINE nemo_alloc  ***
566      !!
567      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
568      !!
569      !! ** Method  :
570      !!----------------------------------------------------------------------
571      USE diawri    , ONLY : dia_wri_alloc
572      USE dom_oce   , ONLY : dom_oce_alloc
573      USE trc_oce   , ONLY : trc_oce_alloc
574      USE bdy_oce   , ONLY : bdy_oce_alloc
575      !
576      INTEGER :: ierr
577      !!----------------------------------------------------------------------
578      !
579      ierr =        oce_alloc    ()    ! ocean
580      ierr = ierr + dia_wri_alloc()
581      ierr = ierr + dom_oce_alloc()    ! ocean domain
582      ierr = ierr + zdf_oce_alloc()    ! ocean vertical physics
583      ierr = ierr + trc_oce_alloc()    ! shared TRC / TRA arrays
584      ierr = ierr + bdy_oce_alloc()    ! bdy masks (incl. initialization)
585      !
586      CALL mpp_sum( 'nemogcm', ierr )
587      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
588      !
589   END SUBROUTINE nemo_alloc
590
591   
592   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
593      !!----------------------------------------------------------------------
594      !!                     ***  ROUTINE nemo_set_cfctl  ***
595      !!
596      !! ** Purpose :   Set elements of the output control structure to setto.
597      !!                for_all should be .false. unless all areas are to be
598      !!                treated identically.
599      !!
600      !! ** Method  :   Note this routine can be used to switch on/off some
601      !!                types of output for selected areas but any output types
602      !!                that involve global communications (e.g. mpp_max, glob_sum)
603      !!                should be protected from selective switching by the
604      !!                for_all argument
605      !!----------------------------------------------------------------------
606      LOGICAL :: setto, for_all
607      TYPE(sn_ctl) :: sn_cfctl
608      !!----------------------------------------------------------------------
609      IF( for_all ) THEN
610         sn_cfctl%l_runstat = setto
611         sn_cfctl%l_trcstat = setto
612      ENDIF
613      sn_cfctl%l_oceout  = setto
614      sn_cfctl%l_layout  = setto
615      sn_cfctl%l_prtctl  = setto
616      sn_cfctl%l_prttrc  = setto
617      sn_cfctl%l_oasout  = setto
618   END SUBROUTINE nemo_set_cfctl
619
620   !!======================================================================
621END MODULE nemogcm
622
Note: See TracBrowser for help on using the repository browser.