source: NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/tests/STATION_ASF/MY_SRC/nemogcm.F90 @ 13159

Last change on this file since 13159 was 13159, checked in by gsamson, 7 weeks ago

merge trunk@r13136 into ASINTER-06 branch; pass all SETTE tests; results identical to trunk@r13136; ticket #2419

File size: 23.6 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         WRITE(ctmp2,*) '           Look for "E R R O R" messages in all existing ocean_output* files'
101         CALL ctl_stop( ' ', ctmp1, ' ', ctmp2 )
102      ENDIF
103      !
104      IF( ln_timing )   CALL timing_finalize
105      !
106      CALL nemo_closefile
107      !
108#if defined key_iomput
109      CALL xios_finalize  ! end mpp communications with xios
110#else
111      IF( lk_mpp   ) THEN   ;   CALL mppstop      ! end mpp communications
112      ENDIF
113#endif
114      !
115      IF(lwm) THEN
116         IF( nstop == 0 ) THEN   ;   STOP 0
117         ELSE                    ;   STOP 123
118         ENDIF
119      ENDIF
120      !
121   END SUBROUTINE nemo_gcm
122
123
124   SUBROUTINE nemo_init
125      !!----------------------------------------------------------------------
126      !!                     ***  ROUTINE nemo_init  ***
127      !!
128      !! ** Purpose :   initialization of the NEMO GCM
129      !!----------------------------------------------------------------------
130      INTEGER ::   ios, ilocal_comm   ! local integers
131      !!
132      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
133         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
134         &             ln_timing, ln_diacfl
135      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
136      !!----------------------------------------------------------------------
137      !
138      cxios_context = 'nemo'
139      !
140      !                             !-------------------------------------------------!
141      !                             !     set communicator & select the local rank    !
142      !                             !  must be done as soon as possible to get narea  !
143      !                             !-------------------------------------------------!
144      !
145#if defined key_iomput
146      IF( Agrif_Root() ) THEN
147            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
148      ENDIF
149      CALL mpp_start( ilocal_comm )
150#else
151         CALL mpp_start( )
152#endif
153      !
154      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
155      lwm = (narea == 1)                ! control of output namelists
156      !
157      !                             !---------------------------------------------------------------!
158      !                             ! Open output files, reference and configuration namelist files !
159      !                             !---------------------------------------------------------------!
160      !
161      ! open ocean.output as soon as possible to get all output prints (including errors messages)
162      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
163      ! open reference and configuration namelist files
164      CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
165      CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
166      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
167      ! open /dev/null file to be able to supress output write easily
168      CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
169      !
170      !                             !--------------------!
171      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
172      !                             !--------------------!
173      !
174      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
175901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
176      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
177902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
178      !
179      ! finalize the definition of namctl variables
180      IF( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax .OR. MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 )   &
181         &   CALL nemo_set_cfctl( sn_cfctl, .FALSE. )
182      !
183      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
184      !
185      IF(lwp) THEN                      ! open listing units
186         !
187         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
188            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
189         !
190         WRITE(numout,*)
191         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
192         WRITE(numout,*) '                       NEMO team'
193         WRITE(numout,*) '            Ocean General Circulation Model'
194         WRITE(numout,*) '                NEMO version 4.0  (2019) '
195         WRITE(numout,*) '                      STATION_ASF '
196         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
197         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
198         WRITE(numout,*)
199         WRITE(numout,*) "           o         _,           _,             "
200         WRITE(numout,*) "            o      .' (        .-' /             "
201         WRITE(numout,*) "           o     _/..._'.    .'   /              "
202         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
203         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
204         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
205         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
206         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
207         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
208         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
209         WRITE(numout,*)
210         !
211         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
212         !
213      ENDIF
214      !
215      IF(lwm) WRITE( numond, namctl )
216      !
217      !                             !------------------------------------!
218      !                             !  Set global domain size parameters !
219      !                             !------------------------------------!
220      !
221      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
222903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
223      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
224904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
225      !
226      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
227         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
228      ELSE                              ! user-defined namelist
229         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
230      ENDIF
231      !
232      IF(lwm)   WRITE( numond, namcfg )
233      !
234      !                             !-----------------------------------------!
235      !                             ! mpp parameters and domain decomposition !
236      !                             !-----------------------------------------!
237      CALL mpp_init
238
239      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
240      CALL nemo_alloc()
241
242      ! Initialise time level indices
243      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
244
245      !                             !-------------------------------!
246      !                             !  NEMO general initialization  !
247      !                             !-------------------------------!
248
249      CALL nemo_ctl                          ! Control prints
250      !
251      !                                      ! General initialization
252      IF( ln_timing    )   CALL timing_init     ! timing
253      IF( ln_timing    )   CALL timing_start( 'nemo_init')
254      !
255      CALL     phy_cst         ! Physical constants
256      CALL     eos_init        ! Equation of state
257      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
258      CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
259      IF( sn_cfctl%l_prtctl )   &
260         &                 CALL prt_ctl_init        ! Print control
261
262      IF( ln_rstart ) THEN                    ! Restart from a file                                                                                 
263         !                                    ! -------------------                                                                                 
264         CALL rst_read( Nbb, Nnn )            ! Read the restart file                                                                               
265         CALL day_init                        ! model calendar (using both namelist and restart infos)                                             
266         !                                                                                                                                         
267      ELSE                                    ! Start from rest                                                                                     
268         !                                    ! ---------------                                                                                     
269         numror = 0                           ! define numror = 0 -> no restart file to read                                                       
270         neuler = 0                           ! Set time-step indicator at nit000 (euler forward)                                                   
271         CALL day_init                        ! model calendar (using both namelist and restart infos)                                             
272      ENDIF
273      !
274
275      !                                      ! external forcing
276      CALL     sbc_init( Nbb, Nnn, Naa )    ! surface boundary conditions (including sea-ice)
277
278      !
279      IF(lwp) WRITE(numout,cform_aaa)           ! Flag AAAAAAA
280      !
281      IF( ln_timing    )   CALL timing_stop( 'nemo_init')
282      !
283   END SUBROUTINE nemo_init
284
285
286   SUBROUTINE nemo_ctl
287      !!----------------------------------------------------------------------
288      !!                     ***  ROUTINE nemo_ctl  ***
289      !!
290      !! ** Purpose :   control print setting
291      !!
292      !! ** Method  : - print namctl and namcfg information and check some consistencies
293      !!----------------------------------------------------------------------
294      !
295      IF(lwp) THEN                  ! control print
296         WRITE(numout,*)
297         WRITE(numout,*) 'nemo_ctl: Control prints'
298         WRITE(numout,*) '~~~~~~~~'
299         WRITE(numout,*) '   Namelist namctl'
300         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
301         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
302         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
303         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
304         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
305         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
306         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
307         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin
308         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax
309         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr
310         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr
311         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
312         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
313         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
314         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
315         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
316         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
317         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
318         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
319         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
320      ENDIF
321      !
322      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
323      nictls    = nn_ictls
324      nictle    = nn_ictle
325      njctls    = nn_jctls
326      njctle    = nn_jctle
327      isplt     = nn_isplt
328      jsplt     = nn_jsplt
329
330      IF(lwp) THEN                  ! control print
331         WRITE(numout,*)
332         WRITE(numout,*) '   Namelist namcfg'
333         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
334         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
335         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
336         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
337         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
338         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
339      ENDIF
340      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
341      !
342      !                             ! Parameter control
343      !
344      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
345         IF( lk_mpp .AND. jpnij > 1 ) THEN
346            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
347         ELSE
348            IF( isplt == 1 .AND. jsplt == 1  ) THEN
349               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
350                  &           ' - the print control will be done over the whole domain' )
351            ENDIF
352            ijsplt = isplt * jsplt            ! total number of processors ijsplt
353         ENDIF
354         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
355         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
356         !
357         !                              ! indices used for the SUM control
358         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
359            lsp_area = .FALSE.
360         ELSE                                             ! print control done over a specific  area
361            lsp_area = .TRUE.
362            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
363               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
364               nictls = 1
365            ENDIF
366            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
367               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
368               nictle = jpiglo
369            ENDIF
370            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
371               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
372               njctls = 1
373            ENDIF
374            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
375               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
376               njctle = jpjglo
377            ENDIF
378         ENDIF
379      ENDIF
380      !
381      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
382         &                                                'Compile with key_nosignedzero enabled:',   &
383         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
384      !
385   END SUBROUTINE nemo_ctl
386
387
388   SUBROUTINE nemo_closefile
389      !!----------------------------------------------------------------------
390      !!                     ***  ROUTINE nemo_closefile  ***
391      !!
392      !! ** Purpose :   Close the files
393      !!----------------------------------------------------------------------
394      !
395      IF( lk_mpp )   CALL mppsync
396      !
397      CALL iom_close                                 ! close all input/output files managed by iom_*
398      !
399      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
400      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
401      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
402      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
403      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
404      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
405      !
406      numout = 6                                     ! redefine numout in case it is used after this point...
407      !
408   END SUBROUTINE nemo_closefile
409
410
411   SUBROUTINE nemo_alloc
412      !!----------------------------------------------------------------------
413      !!                     ***  ROUTINE nemo_alloc  ***
414      !!
415      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
416      !!
417      !! ** Method  :
418      !!----------------------------------------------------------------------
419      USE diawri    , ONLY : dia_wri_alloc
420      USE dom_oce   , ONLY : dom_oce_alloc
421      !
422      INTEGER :: ierr
423      !!----------------------------------------------------------------------
424      !
425      ierr =        oce_alloc    ()    ! ocean
426      ierr = ierr + dia_wri_alloc()
427      ierr = ierr + dom_oce_alloc()    ! ocean domain
428      !
429      CALL mpp_sum( 'nemogcm', ierr )
430      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
431      !
432   END SUBROUTINE nemo_alloc
433
434
435   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto )
436      !!----------------------------------------------------------------------
437      !!                     ***  ROUTINE nemo_set_cfctl  ***
438      !!
439      !! ** Purpose :   Set elements of the output control structure to setto.
440      !!
441      !! ** Method  :   Note this routine can be used to switch on/off some
442      !!                types of output for selected areas.
443      !!----------------------------------------------------------------------
444      TYPE(sn_ctl), INTENT(inout) :: sn_cfctl
445      LOGICAL     , INTENT(in   ) :: setto
446      !!----------------------------------------------------------------------
447      sn_cfctl%l_runstat = setto
448      sn_cfctl%l_trcstat = setto
449      sn_cfctl%l_oceout  = setto
450      sn_cfctl%l_layout  = setto
451      sn_cfctl%l_prtctl  = setto
452      sn_cfctl%l_prttrc  = setto
453      sn_cfctl%l_oasout  = setto
454   END SUBROUTINE nemo_set_cfctl
455
456   !!======================================================================
457END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.