source: NEMO/trunk/src/SAO/nemogcm.F90

Last change on this file was 13286, checked in by smasson, 5 months ago

trunk: merge extra halos branch in trunk, see #2366

  • Property svn:keywords set to Id
File size: 18.2 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 prtctl         ! Print control
32   USE in_out_manager ! I/O manager
33   USE lib_mpp        ! distributed memory computing
34   USE mppini         ! shared/distributed memory setting (mpp_init routine)
35   USE lbcnfd  , ONLY : isendto, nsndto ! Setup of north fold exchanges
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   USE halo_mng
41
42   IMPLICIT NONE
43   PRIVATE
44
45   PUBLIC   nemo_gcm    ! called by model.F90
46   PUBLIC   nemo_init   ! needed by AGRIF
47   PUBLIC   nemo_alloc  ! needed by TAM
48
49   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
50
51   !!----------------------------------------------------------------------
52   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
53   !! $Id$
54   !! Software governed by the CeCILL license (see ./LICENSE)
55   !!----------------------------------------------------------------------
56CONTAINS
57
58   SUBROUTINE nemo_gcm
59         !!----------------------------------------------------------------------
60         !!                    ***  SUBROUTINE offline_obs_oper ***
61         !!
62         !! ** Purpose : To use NEMO components to interpolate model fields
63         !!              to observation space.
64         !!
65         !! ** Method : 1. Initialise NEMO
66         !!             2. Initialise offline obs_oper
67         !!             3. Cycle through match ups
68         !!             4. Write results to file
69         !!----------------------------------------------------------------------
70         !
71         CALL nemo_init       ! Initialise NEMO
72         !
73         CALL sao_data_init   ! Initialise Stand Alone Observation operator data
74         !
75         CALL dia_obs_init    ! Initialise obs_operator
76         !
77         CALL sao_interp      ! Interpolate to observation space
78         !
79         CALL dia_obs_wri     ! Pipe to output files
80         !
81         CALL dia_obs_dealloc ! Reset the obs_oper between
82         !
83         IF(lk_mpp)   CALL mppstop  ! Safely stop MPI (end mpp communications)
84         !
85   END SUBROUTINE nemo_gcm
86
87
88   SUBROUTINE nemo_init
89      !!----------------------------------------------------------------------
90      !!                     ***  ROUTINE nemo_init  ***
91      !!
92      !! ** Purpose :   initialization of the NEMO GCM
93      !!----------------------------------------------------------------------
94      INTEGER ::   ios, ilocal_comm   ! local integer
95      !
96      NAMELIST/namctl/ sn_cfctl, ln_timing, ln_diacfl,                                &
97         &             nn_isplt,  nn_jsplt,  nn_ictls, nn_ictle, nn_jctls, nn_jctle           
98      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
99      !!----------------------------------------------------------------------
100      !
101      cxios_context = 'nemo'
102      nn_hls = 1
103      !
104      !                             !-------------------------------------------------!
105      !                             !     set communicator & select the local rank    !
106      !                             !  must be done as soon as possible to get narea  !
107      !                             !-------------------------------------------------!
108      !
109#if defined key_iomput
110      IF( Agrif_Root() ) THEN
111         IF( lk_oasis ) THEN
112            CALL cpl_init( "oceanx", ilocal_comm )                               ! nemo local communicator given by oasis
113            CALL xios_initialize( "not used"       , local_comm =ilocal_comm )   ! send nemo communicator to xios
114         ELSE
115            CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm )   ! nemo local communicator given by xios
116         ENDIF
117      ENDIF
118      CALL mpp_start( ilocal_comm )
119#else
120      IF( lk_oasis ) THEN
121         IF( Agrif_Root() ) THEN
122            CALL cpl_init( "oceanx", ilocal_comm )          ! nemo local communicator given by oasis
123         ENDIF
124         CALL mpp_start( ilocal_comm )
125      ELSE
126         CALL mpp_start( )
127      ENDIF
128#endif
129      !
130      narea = mpprank + 1               ! mpprank: the rank of proc (0 --> mppsize -1 )
131      lwm = (narea == 1)                ! control of output namelists
132      !
133      !                             !---------------------------------------------------------------!
134      !                             ! Open output files, reference and configuration namelist files !
135      !                             !---------------------------------------------------------------!
136      !
137      ! open ocean.output as soon as possible to get all output prints (including errors messages)
138      IF( lwm )   CALL ctl_opn(     numout,        'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
139      ! open reference and configuration namelist files
140                  CALL load_nml( numnam_ref,        'namelist_ref',                                           -1, lwm )
141                  CALL load_nml( numnam_cfg,        'namelist_cfg',                                           -1, lwm )
142      IF( lwm )   CALL ctl_opn(     numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
143      ! open /dev/null file to be able to supress output write easily
144      IF( Agrif_Root() ) THEN
145                  CALL ctl_opn(     numnul,           '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
146#ifdef key_agrif
147      ELSE
148                  numnul = Agrif_Parent(numnul)   
149#endif
150      ENDIF
151      !
152      !                             !--------------------!
153      !                             ! Open listing units !  -> need sn_cfctl from namctl to define lwp
154      !                             !--------------------!
155      !
156      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
157901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist' )
158      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
159902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist' )
160      !
161      ! finalize the definition of namctl variables
162      IF( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax .OR. MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 )   &
163         &   CALL nemo_set_cfctl( sn_cfctl, .FALSE. )
164      !
165      lwp = (narea == 1) .OR. sn_cfctl%l_oceout    ! control of all listing output print
166      !
167      IF(lwp) THEN                      ! open listing units
168         !
169         IF( .NOT. lwm )   &            ! alreay opened for narea == 1
170            &            CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
171         !
172         WRITE(numout,*)
173         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
174         WRITE(numout,*) '                       NEMO team'
175         WRITE(numout,*) '            Stand Alone Observation operator'
176         WRITE(numout,*) '                NEMO version 4.0  (2019) '
177         WRITE(numout,*)
178         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
179         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
180         WRITE(numout,*)
181         WRITE(numout,*) "           o         _,           _,             "
182         WRITE(numout,*) "            o      .' (        .-' /             "
183         WRITE(numout,*) "           o     _/..._'.    .'   /              "
184         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
185         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
186         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
187         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
188         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
189         WRITE(numout,*) "       )  ) jgs                     `    (   (   "
190         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
191         WRITE(numout,*)
192         !
193         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
194         !
195      ENDIF
196      !
197      IF(lwm) WRITE( numond, namctl )
198      !
199      !                             !------------------------------------!
200      !                             !  Set global domain size parameters !
201      !                             !------------------------------------!
202      !
203      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
204903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist' )
205      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
206904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist' )   
207      !
208      IF( ln_read_cfg ) THEN            ! Read sizes in domain configuration file
209         CALL domain_cfg ( cn_cfg, nn_cfg, Ni0glo, Nj0glo, jpkglo, jperio )
210      ELSE                              ! user-defined namelist
211         CALL usr_def_nam( cn_cfg, nn_cfg, Ni0glo, Nj0glo, jpkglo, jperio )
212      ENDIF
213      !
214      IF(lwm)   WRITE( numond, namcfg )
215      !
216      !                             !-----------------------------------------!
217      !                             ! mpp parameters and domain decomposition !
218      !                             !-----------------------------------------!
219      CALL mpp_init
220
221      CALL halo_mng_init()
222      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
223      CALL nemo_alloc()
224
225      !                             !-------------------------------!
226      !                             !  NEMO general initialization  !
227      !                             !-------------------------------!
228
229      CALL nemo_ctl                          ! Control prints
230      !
231      !                                         ! General initialization
232      IF( ln_timing    )   CALL timing_init     ! timing
233      IF( ln_timing    )   CALL timing_start( 'nemo_init')
234      !
235                           CALL phy_cst            ! Physical constants
236                           CALL eos_init           ! Equation of state
237                           CALL dom_init( Nbb, Nnn, Naa, 'SAO')    ! Domain
238
239
240      IF( sn_cfctl%l_prtctl )   &
241         &                 CALL prt_ctl_init       ! Print control
242
243                           CALL istate_init        ! ocean initial state (Dynamics and tracers)
244   END SUBROUTINE nemo_init
245
246
247   SUBROUTINE nemo_ctl
248      !!----------------------------------------------------------------------
249      !!                     ***  ROUTINE nemo_ctl  ***
250      !!
251      !! ** Purpose :   control print setting
252      !!
253      !! ** Method  : - print namctl and namcfg information and check some consistencies
254      !!----------------------------------------------------------------------
255      !
256      IF(lwp) THEN                  ! control print
257         WRITE(numout,*)
258         WRITE(numout,*) 'nemo_ctl: Control prints'
259         WRITE(numout,*) '~~~~~~~~'
260         WRITE(numout,*) '   Namelist namctl'
261         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
262         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
263         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
264         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
265         WRITE(numout,*) '                              sn_cfctl%l_prtctl  = ', sn_cfctl%l_prtctl
266         WRITE(numout,*) '                              sn_cfctl%l_prttrc  = ', sn_cfctl%l_prttrc
267         WRITE(numout,*) '                              sn_cfctl%l_oasout  = ', sn_cfctl%l_oasout
268         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin 
269         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax 
270         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr 
271         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr 
272         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
273         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
274      ENDIF
275      !
276      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
277      IF(lwp) THEN                  ! control print
278         WRITE(numout,*)
279         WRITE(numout,*) '   Namelist namcfg'
280         WRITE(numout,*) '      read domain configuration file                ln_read_cfg      = ', ln_read_cfg
281         WRITE(numout,*) '         filename to be read                           cn_domcfg     = ', TRIM(cn_domcfg)
282         WRITE(numout,*) '         keep closed seas in the domain (if exist)     ln_closea     = ', ln_closea
283         WRITE(numout,*) '      create a configuration definition file        ln_write_cfg     = ', ln_write_cfg
284         WRITE(numout,*) '         filename to be written                        cn_domcfg_out = ', TRIM(cn_domcfg_out)
285         WRITE(numout,*) '      use file attribute if exists as i/p j-start   ln_use_jattr     = ', ln_use_jattr
286      ENDIF
287      !
288      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
289         &                                                'Compile with key_nosignedzero enabled:',   &
290         &                                                '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
291      !
292   END SUBROUTINE nemo_ctl
293
294
295   SUBROUTINE nemo_closefile
296      !!----------------------------------------------------------------------
297      !!                     ***  ROUTINE nemo_closefile  ***
298      !!
299      !! ** Purpose :   Close the files
300      !!----------------------------------------------------------------------
301      !
302      IF( lk_mpp )   CALL mppsync
303      !
304      CALL iom_close                                 ! close all input/output files managed by iom_*
305      !
306      IF( numstp          /= -1 )   CLOSE( numstp          )   ! time-step file
307      IF( numrun          /= -1 )   CLOSE( numrun          )   ! run statistics file
308      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
309      IF( lwm.AND.numoni  /= -1 )   CLOSE( numoni          )   ! ice output namelist
310      IF( numevo_ice      /= -1 )   CLOSE( numevo_ice      )   ! ice variables (temp. evolution)
311      IF( numout          /=  6 )   CLOSE( numout          )   ! standard model output file
312      IF( numdct_vol      /= -1 )   CLOSE( numdct_vol      )   ! volume transports
313      IF( numdct_heat     /= -1 )   CLOSE( numdct_heat     )   ! heat transports
314      IF( numdct_salt     /= -1 )   CLOSE( numdct_salt     )   ! salt transports
315      !
316      numout = 6                                     ! redefine numout in case it is used after this point...
317      !
318   END SUBROUTINE nemo_closefile
319
320
321   SUBROUTINE nemo_alloc
322      !!----------------------------------------------------------------------
323      !!                     ***  ROUTINE nemo_alloc  ***
324      !!
325      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
326      !!
327      !! ** Method  :
328      !!----------------------------------------------------------------------
329      USE diawri    , ONLY: dia_wri_alloc
330      USE dom_oce   , ONLY: dom_oce_alloc
331      !
332      INTEGER :: ierr
333      !!----------------------------------------------------------------------
334      !
335      ierr =        oce_alloc       ()          ! ocean
336      ierr = ierr + dia_wri_alloc   ()
337      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
338      !
339      CALL mpp_sum( 'nemogcm', ierr )
340      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
341      !
342   END SUBROUTINE nemo_alloc
343
344   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto )
345      !!----------------------------------------------------------------------
346      !!                     ***  ROUTINE nemo_set_cfctl  ***
347      !!
348      !! ** Purpose :   Set elements of the output control structure to setto.
349      !!
350      !! ** Method  :   Note this routine can be used to switch on/off some
351      !!                types of output for selected areas.
352      !!----------------------------------------------------------------------
353      TYPE(sn_ctl), INTENT(inout) :: sn_cfctl
354      LOGICAL     , INTENT(in   ) :: setto
355      !!----------------------------------------------------------------------
356      sn_cfctl%l_runstat = setto
357      sn_cfctl%l_trcstat = setto
358      sn_cfctl%l_oceout  = setto
359      sn_cfctl%l_layout  = setto
360      sn_cfctl%l_prtctl  = setto
361      sn_cfctl%l_prttrc  = setto
362      sn_cfctl%l_oasout  = setto
363   END SUBROUTINE nemo_set_cfctl
364
365   !!======================================================================
366END MODULE nemogcm
367
Note: See TracBrowser for help on using the repository browser.