source: NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/src/SAO/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

  • Property svn:keywords set to Id
File size: 21.0 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 :  3.6  ! 2015-12  (A. Ryan) Original code   (from OCE/)
7   !!            4.0  ! 2016-11  (G. Madec, S. Flavoni)  domain configuration / user defined interface
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
12   !!   nemo_init     : initialization of the NEMO system
13   !!   nemo_ctl      : initialisation of the contol print
14   !!   nemo_closefile: close remaining open files
15   !!   nemo_alloc    : dynamical allocation
16   !!----------------------------------------------------------------------
17   USE step_oce       ! module used in the ocean time stepping module (step.F90)
18   USE domain         ! domain initialization   (dom_init & dom_cfg routines)
19   USE istate         ! initial state setting          (istate_init routine)
20   USE phycst         ! physical constant                  (par_cst routine)
21   USE step           ! NEMO time-stepping                 (stp     routine)
22   USE cpl_oasis3     ! OASIS3 coupling
23   USE diaobs         ! Observation diagnostics       (dia_obs_init routine)
24#if defined key_nemocice_decomp
25   USE ice_domain_size, only: nx_global, ny_global
26#endif
27   !           ! Stand Alone Observation operator modules
28   USE sao_data
29   USE sao_intp
30   !
31   USE in_out_manager ! I/O manager
32   USE lib_mpp        ! distributed memory computing
33   USE mppini         ! shared/distributed memory setting (mpp_init routine)
34   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
35   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
36#if defined key_iomput
37   USE xios           ! xIOserver
38#endif
39
40   IMPLICIT NONE
41   PRIVATE
42
43   PUBLIC   nemo_gcm    ! called by model.F90
44   PUBLIC   nemo_init   ! needed by AGRIF
45   PUBLIC   nemo_alloc  ! needed by TAM
46
47   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
48
49   !!----------------------------------------------------------------------
50   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
51   !! $Id$
52   !! Software governed by the CeCILL license (see ./LICENSE)
53   !!----------------------------------------------------------------------
54CONTAINS
55
56   SUBROUTINE nemo_gcm
57         !!----------------------------------------------------------------------
58         !!                    ***  SUBROUTINE offline_obs_oper ***
59         !!
60         !! ** Purpose : To use NEMO components to interpolate model fields
61         !!              to observation space.
62         !!
63         !! ** Method : 1. Initialise NEMO
64         !!             2. Initialise offline obs_oper
65         !!             3. Cycle through match ups
66         !!             4. Write results to file
67         !!----------------------------------------------------------------------
68         !
69         CALL nemo_init       ! Initialise NEMO
70         !
71         CALL sao_data_init   ! Initialise Stand Alone Observation operator data
72         !
73         CALL dia_obs_init    ! Initialise obs_operator
74         !
75         CALL sao_interp      ! Interpolate to observation space
76         !
77         CALL dia_obs_wri     ! Pipe to output files
78         !
79         CALL dia_obs_dealloc ! Reset the obs_oper between
80         !
81         IF(lk_mpp)   CALL mppstop  ! Safely stop MPI (end mpp communications)
82         !
83   END SUBROUTINE nemo_gcm
84
85
86   SUBROUTINE nemo_init
87      !!----------------------------------------------------------------------
88      !!                     ***  ROUTINE nemo_init  ***
89      !!
90      !! ** Purpose :   initialization of the NEMO GCM
91      !!----------------------------------------------------------------------
92      INTEGER ::   ios, ilocal_comm   ! local integer
93      !
94      NAMELIST/namctl/ sn_cfctl,  nn_print, nn_ictls, nn_ictle,             &
95         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
96         &             ln_timing, ln_diacfl
97      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
98      !!----------------------------------------------------------------------
99      !
100      cxios_context = 'nemo'
101      !
102      !                             !-------------------------------------------------!
103      !                             !     set communicator & select the local rank    !
104      !                             !  must be done as soon as possible to get narea  !
105      !                             !-------------------------------------------------!
106      !
107#if defined key_iomput
108      IF( Agrif_Root() ) THEN
109         IF( lk_oasis ) THEN
110            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
111            CALL xios_initialize( "not used"       , local_comm =ilocal_comm )   ! send nemo communicator to xios
112         ELSE
113            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
114         ENDIF
115      ENDIF
116      CALL mpp_start( ilocal_comm )
117#else
118      IF( lk_oasis ) THEN
119         IF( Agrif_Root() ) THEN
120            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
121         ENDIF
122         CALL mpp_start( ilocal_comm )
123      ELSE
124         CALL mpp_start( )
125      ENDIF
126#endif
127      !
128      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
129      lwm = (narea == 1)                ! control of output namelists
130      !
131      !                             !---------------------------------------------------------------!
132      !                             ! Open output files, reference and configuration namelist files !
133      !                             !---------------------------------------------------------------!
134      !
135      ! open ocean.output as soon as possible to get all output prints (including errors messages)
136      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
137      ! open reference and configuration namelist files
138                  CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
139                  CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
140      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
141      ! open /dev/null file to be able to supress output write easily
142      IF( Agrif_Root() ) THEN
143                  CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
144#ifdef key_agrif
145      ELSE
146                  numnul = Agrif_Parent(numnul)   
147#endif
148      ENDIF
149      !
150      !                             !--------------------!
151      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
152      !                             !--------------------!
153      !
154      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
155901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
156      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
157902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
158      !
159      ! finalize the definition of namctl variables
160      IF( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax .OR. MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 )   &
161         &   CALL nemo_set_cfctl( sn_cfctl, .FALSE. )
162      !
163      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
164      !
165      IF(lwp) THEN                      ! open listing units
166         !
167         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
168            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
169         !
170         WRITE(numout,*)
171         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
172         WRITE(numout,*) '                       NEMO team'
173         WRITE(numout,*) '            Stand Alone Observation operator'
174         WRITE(numout,*) '                NEMO version 4.0  (2019) '
175         WRITE(numout,*)
176         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
177         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
178         WRITE(numout,*)
179         WRITE(numout,*) "           o         _,           _,             "
180         WRITE(numout,*) "            o      .' (        .-' /             "
181         WRITE(numout,*) "           o     _/..._'.    .'   /              "
182         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
183         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
184         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
185         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
186         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
187         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
188         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
189         WRITE(numout,*)
190         !
191         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
192         !
193      ENDIF
194      !
195      IF(lwm) WRITE( numond, namctl )
196      !
197      !                             !------------------------------------!
198      !                             !  Set global domain size parameters !
199      !                             !------------------------------------!
200      !
201      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
202903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
203      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
204904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )   
205      !
206      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
207         CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
208      ELSE                              ! user-defined namelist
209         CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
210      ENDIF
211      !
212      IF(lwm)   WRITE( numond, namcfg )
213      !
214      !                             !-----------------------------------------!
215      !                             ! mpp parameters and domain decomposition !
216      !                             !-----------------------------------------!
217      CALL mpp_init
218
219      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
220      CALL nemo_alloc()
221
222      !                             !-------------------------------!
223      !                             !  NEMO general initialization  !
224      !                             !-------------------------------!
225
226      CALL nemo_ctl                          ! Control prints
227      !
228      !                                         ! General initialization
229      IF( ln_timing    )   CALL timing_init     ! timing
230      IF( ln_timing    )   CALL timing_start( 'nemo_init')
231      !
232                           CALL phy_cst            ! Physical constants
233                           CALL eos_init           ! Equation of state
234                           CALL dom_init( Nbb, Nnn, Naa, 'SAO')    ! Domain
235
236
237      IF( sn_cfctl%l_prtctl )   &
238         &                 CALL prt_ctl_init       ! Print control
239
240                           CALL istate_init        ! ocean initial state (Dynamics and tracers)
241   END SUBROUTINE nemo_init
242
243
244   SUBROUTINE nemo_ctl
245      !!----------------------------------------------------------------------
246      !!                     ***  ROUTINE nemo_ctl  ***
247      !!
248      !! ** Purpose :   control print setting
249      !!
250      !! ** Method  : - print namctl and namcfg information and check some consistencies
251      !!----------------------------------------------------------------------
252      !
253      IF(lwp) THEN                  ! control print
254         WRITE(numout,*)
255         WRITE(numout,*) 'nemo_ctl: Control prints'
256         WRITE(numout,*) '~~~~~~~~'
257         WRITE(numout,*) '   Namelist namctl'
258         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
259         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
260         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
261         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
262         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
263         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
264         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
265         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin 
266         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax 
267         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr 
268         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr 
269         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
270         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
271         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
272         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
273         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
274         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
275         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
276         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
277         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
278      ENDIF
279      !
280      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
281      nictls    = nn_ictls
282      nictle    = nn_ictle
283      njctls    = nn_jctls
284      njctle    = nn_jctle
285      isplt     = nn_isplt
286      jsplt     = nn_jsplt
287
288      IF(lwp) THEN                  ! control print
289         WRITE(numout,*)
290         WRITE(numout,*) '   Namelist namcfg'
291         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
292         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
293         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
294         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
295         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
296         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
297      ENDIF
298      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
299      !
300      !                             ! Parameter control
301      !
302      IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN              ! sub-domain area indices for the control prints
303         IF( lk_mpp .AND. jpnij > 1 ) THEN
304            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
305         ELSE
306            IF( isplt == 1 .AND. jsplt == 1  ) THEN
307               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
308                  &           ' - the print control will be done over the whole domain' )
309            ENDIF
310            ijsplt = isplt * jsplt            ! total number of processors ijsplt
311         ENDIF
312         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
313         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
314         !
315         !                              ! indices used for the SUM control
316         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
317            lsp_area = .FALSE.
318         ELSE                                             ! print control done over a specific  area
319            lsp_area = .TRUE.
320            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
321               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
322               nictls = 1
323            ENDIF
324            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
325               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
326               nictle = jpiglo
327            ENDIF
328            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
329               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
330               njctls = 1
331            ENDIF
332            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
333               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
334               njctle = jpjglo
335            ENDIF
336         ENDIF
337      ENDIF
338      !
339      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
340         &                                                'Compile with key_nosignedzero enabled:',   &
341         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
342      !
343   END SUBROUTINE nemo_ctl
344
345
346   SUBROUTINE nemo_closefile
347      !!----------------------------------------------------------------------
348      !!                     ***  ROUTINE nemo_closefile  ***
349      !!
350      !! ** Purpose :   Close the files
351      !!----------------------------------------------------------------------
352      !
353      IF( lk_mpp )   CALL mppsync
354      !
355      CALL iom_close                                 ! close all input/output files managed by iom_*
356      !
357      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
358      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
359      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
360      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
361      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
362      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
363      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
364      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
365      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
366      !
367      numout = 6                                     ! redefine numout in case it is used after this point...
368      !
369   END SUBROUTINE nemo_closefile
370
371
372   SUBROUTINE nemo_alloc
373      !!----------------------------------------------------------------------
374      !!                     ***  ROUTINE nemo_alloc  ***
375      !!
376      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
377      !!
378      !! ** Method  :
379      !!----------------------------------------------------------------------
380      USE diawri    , ONLY: dia_wri_alloc
381      USE dom_oce   , ONLY: dom_oce_alloc
382      !
383      INTEGER :: ierr
384      !!----------------------------------------------------------------------
385      !
386      ierr =        oce_alloc       ()          ! ocean
387      ierr = ierr + dia_wri_alloc   ()
388      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
389      !
390      CALL mpp_sum( 'nemogcm', ierr )
391      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
392      !
393   END SUBROUTINE nemo_alloc
394
395   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto )
396      !!----------------------------------------------------------------------
397      !!                     ***  ROUTINE nemo_set_cfctl  ***
398      !!
399      !! ** Purpose :   Set elements of the output control structure to setto.
400      !!
401      !! ** Method  :   Note this routine can be used to switch on/off some
402      !!                types of output for selected areas.
403      !!----------------------------------------------------------------------
404      TYPE(sn_ctl), INTENT(inout) :: sn_cfctl
405      LOGICAL     , INTENT(in   ) :: setto
406      !!----------------------------------------------------------------------
407      sn_cfctl%l_runstat = setto
408      sn_cfctl%l_trcstat = setto
409      sn_cfctl%l_oceout  = setto
410      sn_cfctl%l_layout  = setto
411      sn_cfctl%l_prtctl  = setto
412      sn_cfctl%l_prttrc  = setto
413      sn_cfctl%l_oasout  = setto
414   END SUBROUTINE nemo_set_cfctl
415
416   !!======================================================================
417END MODULE nemogcm
418
Note: See TracBrowser for help on using the repository browser.