New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
nemogcm.F90 in NEMO/trunk/src/SAO – NEMO

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

Last change on this file was 15267, checked in by smasson, 10 months ago

trunk: new nogather nolding, #2724

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