source: NEMO/branches/2019/dev_r11943_MERGE_2019/tests/STATION_ASF/MY_SRC/nemogcm.F90 @ 12249

Last change on this file since 12249 was 12249, checked in by laurent, 11 months ago

Made STATION_ASF testcase fully compliant with new timestepping scheme.

File size: 23.9 KB
Line 
1MODULE nemogcm
2   !!======================================================================
3   !!                       ***  MODULE nemogcm   ***
4   !! StandAlone Surface module : surface fluxes
5   !!======================================================================
6   !! History :  3.6  ! 2011-11  (S. Alderson, G. Madec) original code
7   !!             -   ! 2013-06  (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication
8   !!             -   ! 2014-12  (G. Madec) remove KPP scheme and cross-land advection (cla)
9   !!            4.0  ! 2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
10   !!            4.x  ! 2019-12  (L. Brodeau)  STATION_ASF test-case
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
15   !!   nemo_init     : initialization of the NEMO system
16   !!   nemo_ctl      : initialisation of the contol print
17   !!   nemo_closefile: close remaining open files
18   !!   nemo_alloc    : dynamical allocation
19   !!----------------------------------------------------------------------
20   USE step_oce       ! module used in the ocean time stepping module (step.F90)
21   USE sbc_oce        ! surface boundary condition: ocean #LB: rm?
22   USE phycst         ! physical constant                  (par_cst routine)
23   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
24   USE closea         ! treatment of closed seas (for ln_closea)
25   USE usrdef_nam     ! user defined configuration
26   USE step, ONLY : Nbb, Nnn, Naa, Nrhs ! time level indices
27   USE daymod         ! calendar
28   USE restart        ! open  restart file
29   !LB:USE step           ! NEMO time-stepping                 (stp     routine)
30   USE c1d            ! 1D configuration
31   USE step_c1d       ! Time stepping loop for the 1D configuration
32   USE sbcssm         !
33   !
34   USE lib_mpp        ! distributed memory computing
35   USE mppini         ! shared/distributed memory setting (mpp_init routine)
36   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
37#if defined key_iomput
38   USE xios           ! xIOserver
39#endif
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   nemo_gcm    ! called by model.F90
45   PUBLIC   nemo_init   ! needed by AGRIF
46
47   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
48
49   !!----------------------------------------------------------------------
50   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
51   !! $Id: nemogcm.F90 11536 2019-09-11 13:54:18Z smasson $
52   !! Software governed by the CeCILL license (see ./LICENSE)
53   !!----------------------------------------------------------------------
54CONTAINS
55
56   SUBROUTINE nemo_gcm
57      !!----------------------------------------------------------------------
58      !!                     ***  ROUTINE nemo_gcm  ***
59      !!
60      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
61      !!              curvilinear mesh on the sphere.
62      !!
63      !! ** Method  : - model general initialization
64      !!              - launch the time-stepping (stp routine)
65      !!              - finalize the run by closing files and communications
66      !!
67      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
68      !!              Madec, 2008, internal report, IPSL.
69      !!----------------------------------------------------------------------
70      INTEGER ::   istp   ! time step index
71      REAL(wp)::   zstptiming   ! elapsed time for 1 time step
72      !!----------------------------------------------------------------------
73      !
74      !                            !-----------------------!
75      CALL nemo_init               !==  Initialisations  ==!
76      !                            !-----------------------!
77      ! check that all process are still there... If some process have an error,
78      ! they will never enter in step and other processes will wait until the end of the cpu time!
79      CALL mpp_max( 'nemogcm', nstop )
80
81      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
82
83      !                            !-----------------------!
84      !                            !==   time stepping   ==!
85      !                            !-----------------------!
86      istp = nit000
87      !
88      DO WHILE ( istp <= nitend .AND. nstop == 0 )    !==  C1D time-stepping  ==!
89         CALL stp_c1d( istp )
90         istp = istp + 1
91      END DO
92      !
93      !                            !------------------------!
94      !                            !==  finalize the run  ==!
95      !                            !------------------------!
96      IF(lwp) WRITE(numout,cform_aaa)        ! Flag AAAAAAA
97      !
98      IF( nstop /= 0 .AND. lwp ) THEN        ! error print
99         WRITE(ctmp1,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
100         CALL ctl_stop( ctmp1 )
101      ENDIF
102      !
103      IF( ln_timing )   CALL timing_finalize
104      !
105      CALL nemo_closefile
106      !
107#if defined key_iomput
108      CALL xios_finalize  ! end mpp communications with xios
109#else
110      IF( lk_mpp   ) THEN   ;   CALL mppstop      ! end mpp communications
111      ENDIF
112#endif
113      !
114      IF(lwm) THEN
115         IF( nstop == 0 ) THEN   ;   STOP 0
116         ELSE                    ;   STOP 123
117         ENDIF
118      ENDIF
119      !
120   END SUBROUTINE nemo_gcm
121
122
123   SUBROUTINE nemo_init
124      !!----------------------------------------------------------------------
125      !!                     ***  ROUTINE nemo_init  ***
126      !!
127      !! ** Purpose :   initialization of the NEMO GCM
128      !!----------------------------------------------------------------------
129      INTEGER ::   ios, ilocal_comm   ! local integers
130      !!
131      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
132         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
133         &             ln_timing, ln_diacfl
134      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
135      !!----------------------------------------------------------------------
136      !
137      cxios_context = 'nemo'
138      !
139      !                             !-------------------------------------------------!
140      !                             !     set communicator & select the local rank    !
141      !                             !  must be done as soon as possible to get narea  !
142      !                             !-------------------------------------------------!
143      !
144#if defined key_iomput
145      IF( Agrif_Root() ) THEN
146            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
147      ENDIF
148      CALL mpp_start( ilocal_comm )
149#else
150         CALL mpp_start( )
151#endif
152      !
153      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
154      lwm = (narea == 1)                ! control of output namelists
155      !
156      !                             !---------------------------------------------------------------!
157      !                             ! Open output files, reference and configuration namelist files !
158      !                             !---------------------------------------------------------------!
159      !
160      ! open ocean.output as soon as possible to get all output prints (including errors messages)
161      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
162      ! open reference and configuration namelist files
163      CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
164      CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
165      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
166      ! open /dev/null file to be able to supress output write easily
167      CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
168      !
169      !                             !--------------------!
170      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
171      !                             !--------------------!
172      !
173      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
174901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
175      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
176902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
177      !
178      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
179      !
180      IF(lwp) THEN                      ! open listing units
181         !
182         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
183            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
184         !
185         WRITE(numout,*)
186         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
187         WRITE(numout,*) '                       NEMO team'
188         WRITE(numout,*) '            Ocean General Circulation Model'
189         WRITE(numout,*) '                NEMO version 4.0  (2019) '
190         WRITE(numout,*) '                      STATION_ASF '
191         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
192         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
193         WRITE(numout,*)
194         WRITE(numout,*) "           o         _,           _,             "
195         WRITE(numout,*) "            o      .' (        .-' /             "
196         WRITE(numout,*) "           o     _/..._'.    .'   /              "
197         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
198         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
199         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
200         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
201         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
202         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
203         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
204         WRITE(numout,*)
205         !
206         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
207         !
208      ENDIF
209      !
210      IF(lwm) WRITE( numond, namctl )
211      !
212      !                             !------------------------------------!
213      !                             !  Set global domain size parameters !
214      !                             !------------------------------------!
215      !
216      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
217903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
218      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
219904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
220      !
221      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
222         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
223      ELSE                              ! user-defined namelist
224         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
225      ENDIF
226      !
227      IF(lwm)   WRITE( numond, namcfg )
228      !
229      !                             !-----------------------------------------!
230      !                             ! mpp parameters and domain decomposition !
231      !                             !-----------------------------------------!
232      CALL mpp_init
233
234      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
235      CALL nemo_alloc()
236
237      ! Initialise time level indices
238      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
239
240      !                             !-------------------------------!
241      !                             !  NEMO general initialization  !
242      !                             !-------------------------------!
243
244      CALL nemo_ctl                          ! Control prints
245      !
246      !                                      ! General initialization
247      IF( ln_timing    )   CALL timing_init     ! timing
248      IF( ln_timing    )   CALL timing_start( 'nemo_init')
249      !
250      CALL     phy_cst         ! Physical constants
251      CALL     eos_init        ! Equation of state
252      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
253      CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
254      IF( sn_cfctl%l_prtctl )   &
255         &                 CALL prt_ctl_init        ! Print control
256
257      IF( ln_rstart ) THEN                    ! Restart from a file                                                                                 
258         !                                    ! -------------------                                                                                 
259         CALL rst_read( Nbb, Nnn )            ! Read the restart file                                                                               
260         CALL day_init                        ! model calendar (using both namelist and restart infos)                                             
261         !                                                                                                                                         
262      ELSE                                    ! Start from rest                                                                                     
263         !                                    ! ---------------                                                                                     
264         numror = 0                           ! define numror = 0 -> no restart file to read                                                       
265         neuler = 0                           ! Set time-step indicator at nit000 (euler forward)                                                   
266         CALL day_init                        ! model calendar (using both namelist and restart infos)                                             
267      ENDIF
268      !
269
270      !                                      ! external forcing
271      CALL     sbc_init( Nbb, Nnn, Naa )    ! surface boundary conditions (including sea-ice)
272
273      !
274      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
275      !
276      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
277      !
278   END SUBROUTINE nemo_init
279
280
281   SUBROUTINE nemo_ctl
282      !!----------------------------------------------------------------------
283      !!                     ***  ROUTINE nemo_ctl  ***
284      !!
285      !! ** Purpose :   control print setting
286      !!
287      !! ** Method  : - print namctl and namcfg information and check some consistencies
288      !!----------------------------------------------------------------------
289      !
290      IF(lwp) THEN                  ! control print
291         WRITE(numout,*)
292         WRITE(numout,*) 'nemo_ctl: Control prints'
293         WRITE(numout,*) '~~~~~~~~'
294         WRITE(numout,*) '   Namelist namctl'
295         WRITE(numout,*) '                              sn_cfctl%l_glochk  = ', sn_cfctl%l_glochk
296         WRITE(numout,*) '                              sn_cfctl%l_allon   = ', sn_cfctl%l_allon
297         WRITE(numout,*) '       finer control over o/p sn_cfctl%l_config  = ', sn_cfctl%l_config
298         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
299         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
300         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
301         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
302         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
303         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
304         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
305         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin
306         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax
307         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr
308         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr
309         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
310         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
311         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
312         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
313         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
314         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
315         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
316         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
317         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
318      ENDIF
319      !
320      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
321      nictls    = nn_ictls
322      nictle    = nn_ictle
323      njctls    = nn_jctls
324      njctle    = nn_jctle
325      isplt     = nn_isplt
326      jsplt     = nn_jsplt
327
328      IF(lwp) THEN                  ! control print
329         WRITE(numout,*)
330         WRITE(numout,*) '   Namelist namcfg'
331         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
332         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
333         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
334         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
335         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
336         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
337      ENDIF
338      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
339      !
340      !                             ! Parameter control
341      !
342      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
343         IF( lk_mpp .AND. jpnij > 1 ) THEN
344            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
345         ELSE
346            IF( isplt == 1 .AND. jsplt == 1  ) THEN
347               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
348                  &           ' - the print control will be done over the whole domain' )
349            ENDIF
350            ijsplt = isplt * jsplt            ! total number of processors ijsplt
351         ENDIF
352         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
353         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
354         !
355         !                              ! indices used for the SUM control
356         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
357            lsp_area = .FALSE.
358         ELSE                                             ! print control done over a specific  area
359            lsp_area = .TRUE.
360            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
361               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
362               nictls = 1
363            ENDIF
364            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
365               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
366               nictle = jpiglo
367            ENDIF
368            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
369               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
370               njctls = 1
371            ENDIF
372            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
373               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
374               njctle = jpjglo
375            ENDIF
376         ENDIF
377      ENDIF
378      !
379      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
380         &                                                'Compile with key_nosignedzero enabled:',   &
381         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
382      !
383   END SUBROUTINE nemo_ctl
384
385
386   SUBROUTINE nemo_closefile
387      !!----------------------------------------------------------------------
388      !!                     ***  ROUTINE nemo_closefile  ***
389      !!
390      !! ** Purpose :   Close the files
391      !!----------------------------------------------------------------------
392      !
393      IF( lk_mpp )   CALL mppsync
394      !
395      CALL iom_close                                 ! close all input/output files managed by iom_*
396      !
397      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
398      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
399      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
400      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
401      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
402      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
403      !
404      numout = 6                                     ! redefine numout in case it is used after this point...
405      !
406   END SUBROUTINE nemo_closefile
407
408
409   SUBROUTINE nemo_alloc
410      !!----------------------------------------------------------------------
411      !!                     ***  ROUTINE nemo_alloc  ***
412      !!
413      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
414      !!
415      !! ** Method  :
416      !!----------------------------------------------------------------------
417      USE diawri    , ONLY : dia_wri_alloc
418      USE dom_oce   , ONLY : dom_oce_alloc
419      !
420      INTEGER :: ierr
421      !!----------------------------------------------------------------------
422      !
423      ierr =        oce_alloc    ()    ! ocean
424      ierr = ierr + dia_wri_alloc()
425      ierr = ierr + dom_oce_alloc()    ! ocean domain
426      !
427      CALL mpp_sum( 'nemogcm', ierr )
428      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
429      !
430   END SUBROUTINE nemo_alloc
431
432
433   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
434      !!----------------------------------------------------------------------
435      !!                     ***  ROUTINE nemo_set_cfctl  ***
436      !!
437      !! ** Purpose :   Set elements of the output control structure to setto.
438      !!                for_all should be .false. unless all areas are to be
439      !!                treated identically.
440      !!
441      !! ** Method  :   Note this routine can be used to switch on/off some
442      !!                types of output for selected areas but any output types
443      !!                that involve global communications (e.g. mpp_max, glob_sum)
444      !!                should be protected from selective switching by the
445      !!                for_all argument
446      !!----------------------------------------------------------------------
447      LOGICAL :: setto, for_all
448      TYPE(sn_ctl) :: sn_cfctl
449      !!----------------------------------------------------------------------
450      IF( for_all ) THEN
451         sn_cfctl%l_runstat = setto
452         sn_cfctl%l_trcstat = setto
453      ENDIF
454      sn_cfctl%l_oceout  = setto
455      sn_cfctl%l_layout  = setto
456      sn_cfctl%l_prtctl  = setto
457      sn_cfctl%l_prttrc  = setto
458      sn_cfctl%l_oasout  = setto
459   END SUBROUTINE nemo_set_cfctl
460
461   !!======================================================================
462END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.