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.
domain.F90 in NEMO/branches/2020/temporary_r4_trunk/src/OCE/DOM – NEMO

source: NEMO/branches/2020/temporary_r4_trunk/src/OCE/DOM/domain.F90 @ 13470

Last change on this file since 13470 was 13470, checked in by smasson, 4 years ago

r4_trunk: second change of DO loops for routines to be merged, see #2523
  • Property svn:keywords set to Id
File size: 36.6 KB
Line 
1MODULE domain
2   !!==============================================================================
3   !!                       ***  MODULE domain   ***
4   !! Ocean initialization : domain initialization
5   !!==============================================================================
6   !! History :  OPA  !  1990-10  (C. Levy - G. Madec)  Original code
7   !!                 !  1992-01  (M. Imbard) insert time step initialization
8   !!                 !  1996-06  (G. Madec) generalized vertical coordinate
9   !!                 !  1997-02  (G. Madec) creation of domwri.F
10   !!                 !  2001-05  (E.Durand - G. Madec) insert closed sea
11   !!   NEMO     1.0  !  2002-08  (G. Madec)  F90: Free form and module
12   !!            2.0  !  2005-11  (V. Garnier) Surface pressure gradient organization
13   !!            3.3  !  2010-11  (G. Madec)  initialisation in C1D configuration
14   !!            3.6  !  2013     ( J. Simeon, C. Calone, G. Madec, C. Ethe ) Online coarsening of outputs
15   !!            3.7  !  2015-11  (G. Madec, A. Coward)  time varying zgr by default
16   !!            4.0  !  2016-10  (G. Madec, S. Flavoni)  domain configuration / user defined interface
17   !!----------------------------------------------------------------------
18   
19   !!----------------------------------------------------------------------
20   !!   dom_init      : initialize the space and time domain
21   !!   dom_glo       : initialize global domain <--> local domain indices
22   !!   dom_nam       : read and contral domain namelists
23   !!   dom_ctl       : control print for the ocean domain
24   !!   domain_cfg    : read the global domain size in domain configuration file
25   !!   cfg_write     : create the domain configuration file
26   !!----------------------------------------------------------------------
27   USE oce            ! ocean variables
28   USE dom_oce        ! domain: ocean
29   USE sbc_oce        ! surface boundary condition: ocean
30   USE trc_oce        ! shared ocean & passive tracers variab
31   USE phycst         ! physical constants
32   USE closea         ! closed seas
33   USE domhgr         ! domain: set the horizontal mesh
34   USE domzgr         ! domain: set the vertical mesh
35   USE dommsk         ! domain: set the mask system
36   USE domwri         ! domain: write the meshmask file
37   USE domvvl         ! variable volume
38   USE c1d            ! 1D configuration
39   USE dyncor_c1d     ! 1D configuration: Coriolis term    (cor_c1d routine)
40   USE wet_dry,  ONLY : ll_wd
41   !
42   USE in_out_manager ! I/O manager
43   USE iom            ! I/O library
44   USE lbclnk         ! ocean lateral boundary condition (or mpp link)
45   USE lib_mpp        ! distributed memory computing library
46
47   IMPLICIT NONE
48   PRIVATE
49
50   PUBLIC   dom_init     ! called by nemogcm.F90
51   PUBLIC   domain_cfg   ! called by nemogcm.F90
52
53   !!-------------------------------------------------------------------------
54   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
55   !! $Id$
56   !! Software governed by the CeCILL license (see ./LICENSE)
57   !!-------------------------------------------------------------------------
58CONTAINS
59
60   SUBROUTINE dom_init(cdstr)
61      !!----------------------------------------------------------------------
62      !!                  ***  ROUTINE dom_init  ***
63      !!                   
64      !! ** Purpose :   Domain initialization. Call the routines that are
65      !!              required to create the arrays which define the space
66      !!              and time domain of the ocean model.
67      !!
68      !! ** Method  : - dom_msk: compute the masks from the bathymetry file
69      !!              - dom_hgr: compute or read the horizontal grid-point position
70      !!                         and scale factors, and the coriolis factor
71      !!              - dom_zgr: define the vertical coordinate and the bathymetry
72      !!              - dom_wri: create the meshmask file (ln_meshmask=T)
73      !!              - 1D configuration, move Coriolis, u and v at T-point
74      !!----------------------------------------------------------------------
75      INTEGER ::   ji, jj, jk, ik   ! dummy loop indices
76      INTEGER ::   iconf = 0    ! local integers
77      CHARACTER (len=64) ::   cform = "(A12, 3(A13, I7))" 
78      CHARACTER (len=*), INTENT(IN) :: cdstr                  ! model: NEMO or SAS. Determines core restart variables
79      INTEGER , DIMENSION(jpi,jpj) ::   ik_top , ik_bot       ! top and bottom ocean level
80      REAL(wp), DIMENSION(jpi,jpj) ::   z1_hu_0, z1_hv_0
81      !!----------------------------------------------------------------------
82      !
83      IF(lwp) THEN         ! Ocean domain Parameters (control print)
84         WRITE(numout,*)
85         WRITE(numout,*) 'dom_init : domain initialization'
86         WRITE(numout,*) '~~~~~~~~'
87         !
88         WRITE(numout,*)     '   Domain info'
89         WRITE(numout,*)     '      dimension of model:'
90         WRITE(numout,*)     '             Local domain      Global domain       Data domain '
91         WRITE(numout,cform) '        ','   jpi     : ', jpi, '   jpiglo  : ', jpiglo
92         WRITE(numout,cform) '        ','   jpj     : ', jpj, '   jpjglo  : ', jpjglo
93         WRITE(numout,cform) '        ','   jpk     : ', jpk, '   jpkglo  : ', jpkglo
94         WRITE(numout,cform) '       ' ,'   jpij    : ', jpij
95         WRITE(numout,*)     '      mpp local domain info (mpp):'
96         WRITE(numout,*)     '              jpni    : ', jpni, '   nn_hls  : ', nn_hls
97         WRITE(numout,*)     '              jpnj    : ', jpnj, '   nn_hls  : ', nn_hls
98         WRITE(numout,*)     '              jpnij   : ', jpnij
99         WRITE(numout,*)     '      lateral boundary of the Global domain : jperio  = ', jperio
100         SELECT CASE ( jperio )
101         CASE( 0 )   ;   WRITE(numout,*) '         (i.e. closed)'
102         CASE( 1 )   ;   WRITE(numout,*) '         (i.e. cyclic east-west)'
103         CASE( 2 )   ;   WRITE(numout,*) '         (i.e. cyclic north-south)'
104         CASE( 3 )   ;   WRITE(numout,*) '         (i.e. north fold with T-point pivot)'
105         CASE( 4 )   ;   WRITE(numout,*) '         (i.e. cyclic east-west and north fold with T-point pivot)'
106         CASE( 5 )   ;   WRITE(numout,*) '         (i.e. north fold with F-point pivot)'
107         CASE( 6 )   ;   WRITE(numout,*) '         (i.e. cyclic east-west and north fold with F-point pivot)'
108         CASE( 7 )   ;   WRITE(numout,*) '         (i.e. cyclic east-west and north-south)'
109         CASE DEFAULT
110            CALL ctl_stop( 'jperio is out of range' )
111         END SELECT
112         WRITE(numout,*)     '      Ocean model configuration used:'
113         WRITE(numout,*)     '         cn_cfg = ', TRIM( cn_cfg ), '   nn_cfg = ', nn_cfg
114      ENDIF
115      nn_wxios = 0
116      ln_xios_read = .FALSE.
117      !
118      !           !==  Reference coordinate system  ==!
119      !
120      CALL dom_glo                     ! global domain versus local domain
121      CALL dom_nam                     ! read namelist ( namrun, namdom )
122      !
123      IF( lwxios ) THEN
124!define names for restart write and set core output (restart.F90)
125         CALL iom_set_rst_vars(rst_wfields)
126         CALL iom_set_rstw_core(cdstr)
127      ENDIF
128!reset namelist for SAS
129      IF(cdstr == 'SAS') THEN
130         IF(lrxios) THEN
131               IF(lwp) write(numout,*) 'Disable reading restart file using XIOS for SAS'
132               lrxios = .FALSE.
133         ENDIF
134      ENDIF
135      !
136      CALL dom_hgr                     ! Horizontal mesh
137      CALL dom_zgr( ik_top, ik_bot )   ! Vertical mesh and bathymetry
138      CALL dom_msk( ik_top, ik_bot )   ! Masks
139      IF( ln_closea )   CALL dom_clo   ! ln_closea=T : closed seas included in the simulation
140                                       ! Read in masks to define closed seas and lakes
141      !
142      DO_2D( 1, 1, 1, 1 )
143         ik = mikt(ji,jj)
144         risfdep(ji,jj) = gdepw_0(ji,jj,ik)
145      END_2D
146      !
147      ht_0(:,:) = 0._wp  ! Reference ocean thickness
148      hu_0(:,:) = 0._wp
149      hv_0(:,:) = 0._wp
150      DO jk = 1, jpk
151         ht_0(:,:) = ht_0(:,:) + e3t_0(:,:,jk) * tmask(:,:,jk)
152         hu_0(:,:) = hu_0(:,:) + e3u_0(:,:,jk) * umask(:,:,jk)
153         hv_0(:,:) = hv_0(:,:) + e3v_0(:,:,jk) * vmask(:,:,jk)
154      END DO
155      !
156      !           !==  time varying part of coordinate system  ==!
157      !
158      IF( ln_linssh ) THEN       != Fix in time : set to the reference one for all
159      !
160         !       before        !          now          !       after         !
161            gdept_b = gdept_0  ;   gdept_n = gdept_0   !        ---          ! depth of grid-points
162            gdepw_b = gdepw_0  ;   gdepw_n = gdepw_0   !        ---          !
163                                   gde3w_n = gde3w_0   !        ---          !
164         !                                                                 
165              e3t_b =   e3t_0  ;     e3t_n =   e3t_0   ;   e3t_a =  e3t_0    ! scale factors
166              e3u_b =   e3u_0  ;     e3u_n =   e3u_0   ;   e3u_a =  e3u_0    !
167              e3v_b =   e3v_0  ;     e3v_n =   e3v_0   ;   e3v_a =  e3v_0    !
168                                     e3f_n =   e3f_0   !        ---          !
169              e3w_b =   e3w_0  ;     e3w_n =   e3w_0   !        ---          !
170             e3uw_b =  e3uw_0  ;    e3uw_n =  e3uw_0   !        ---          !
171             e3vw_b =  e3vw_0  ;    e3vw_n =  e3vw_0   !        ---          !
172         !
173         z1_hu_0(:,:) = ssumask(:,:) / ( hu_0(:,:) + 1._wp - ssumask(:,:) )     ! _i mask due to ISF
174         z1_hv_0(:,:) = ssvmask(:,:) / ( hv_0(:,:) + 1._wp - ssvmask(:,:) )
175         !
176         !        before       !          now          !       after         !
177                                      ht_n =    ht_0   !                     ! water column thickness
178               hu_b =    hu_0  ;      hu_n =    hu_0   ;    hu_a =    hu_0   !
179               hv_b =    hv_0  ;      hv_n =    hv_0   ;    hv_a =    hv_0   !
180            r1_hu_b = z1_hu_0  ;   r1_hu_n = z1_hu_0   ; r1_hu_a = z1_hu_0   ! inverse of water column thickness
181            r1_hv_b = z1_hv_0  ;   r1_hv_n = z1_hv_0   ; r1_hv_a = z1_hv_0   !
182         !
183         !
184      ELSE                       != time varying : initialize before/now/after variables
185         !
186         IF( .NOT.l_offline )  CALL dom_vvl_init 
187         !
188      ENDIF
189      !
190      IF( lk_c1d         )   CALL cor_c1d       ! 1D configuration: Coriolis set at T-point
191      !
192      IF( ln_meshmask .AND. .NOT.ln_iscpl )                        CALL dom_wri     ! Create a domain file
193      IF( ln_meshmask .AND.      ln_iscpl .AND. .NOT.ln_rstart )   CALL dom_wri     ! Create a domain file
194      IF(                                       .NOT.ln_rstart )   CALL dom_ctl     ! Domain control
195      !
196      IF( ln_write_cfg )   CALL cfg_write         ! create the configuration file
197      !
198      IF(lwp) THEN
199         WRITE(numout,*)
200         WRITE(numout,*) 'dom_init :   ==>>>   END of domain initialization'
201         WRITE(numout,*) '~~~~~~~~'
202         WRITE(numout,*) 
203      ENDIF
204      !
205   END SUBROUTINE dom_init
206
207
208   SUBROUTINE dom_glo
209      !!----------------------------------------------------------------------
210      !!                     ***  ROUTINE dom_glo  ***
211      !!
212      !! ** Purpose :   initialization of global domain <--> local domain indices
213      !!
214      !! ** Method  :   
215      !!
216      !! ** Action  : - mig , mjg : local  domain indices ==> global domain indices
217      !!              - mi0 , mi1 : global domain indices ==> local  domain indices
218      !!              - mj0,, mj1   (global point not in the local domain ==> mi0>mi1 and/or mj0>mj1)
219      !!----------------------------------------------------------------------
220      INTEGER ::   ji, jj   ! dummy loop argument
221      !!----------------------------------------------------------------------
222      !
223      DO ji = 1, jpi                 ! local domain indices ==> global domain indices
224        mig(ji) = ji + nimpp - 1
225      END DO
226      DO jj = 1, jpj
227        mjg(jj) = jj + njmpp - 1
228      END DO
229      !                              ! global domain indices ==> local domain indices
230      !                                   ! (return (m.0,m.1)=(1,0) if data domain gridpoint is to the west/south of the
231      !                                   ! local domain, or (m.0,m.1)=(jp.+1,jp.) to the east/north of local domain.
232      DO ji = 1, jpiglo
233        mi0(ji) = MAX( 1 , MIN( ji - nimpp + 1, jpi+1 ) )
234        mi1(ji) = MAX( 0 , MIN( ji - nimpp + 1, jpi   ) )
235      END DO
236      DO jj = 1, jpjglo
237        mj0(jj) = MAX( 1 , MIN( jj - njmpp + 1, jpj+1 ) )
238        mj1(jj) = MAX( 0 , MIN( jj - njmpp + 1, jpj   ) )
239      END DO
240      IF(lwp) THEN                   ! control print
241         WRITE(numout,*)
242         WRITE(numout,*) 'dom_glo : domain: global <<==>> local '
243         WRITE(numout,*) '~~~~~~~ '
244         WRITE(numout,*) '   global domain:   jpiglo = ', jpiglo, ' jpjglo = ', jpjglo, ' jpkglo = ', jpkglo
245         WRITE(numout,*) '   local  domain:   jpi    = ', jpi   , ' jpj    = ', jpj   , ' jpk    = ', jpk
246         WRITE(numout,*)
247         WRITE(numout,*) '   conversion from local to global domain indices (and vise versa) done'
248         IF( nn_print >= 1 ) THEN
249            WRITE(numout,*)
250            WRITE(numout,*) '          conversion local  ==> global i-index domain (mig)'
251            WRITE(numout,25)              (mig(ji),ji = 1,jpi)
252            WRITE(numout,*)
253            WRITE(numout,*) '          conversion global ==> local  i-index domain'
254            WRITE(numout,*) '             starting index (mi0)'
255            WRITE(numout,25)              (mi0(ji),ji = 1,jpiglo)
256            WRITE(numout,*) '             ending index (mi1)'
257            WRITE(numout,25)              (mi1(ji),ji = 1,jpiglo)
258            WRITE(numout,*)
259            WRITE(numout,*) '          conversion local  ==> global j-index domain (mjg)'
260            WRITE(numout,25)              (mjg(jj),jj = 1,jpj)
261            WRITE(numout,*)
262            WRITE(numout,*) '          conversion global ==> local  j-index domain'
263            WRITE(numout,*) '             starting index (mj0)'
264            WRITE(numout,25)              (mj0(jj),jj = 1,jpjglo)
265            WRITE(numout,*) '             ending index (mj1)'
266            WRITE(numout,25)              (mj1(jj),jj = 1,jpjglo)
267         ENDIF
268      ENDIF
269 25   FORMAT( 100(10x,19i4,/) )
270      !
271   END SUBROUTINE dom_glo
272
273
274   SUBROUTINE dom_nam
275      !!----------------------------------------------------------------------
276      !!                     ***  ROUTINE dom_nam  ***
277      !!                   
278      !! ** Purpose :   read domaine namelists and print the variables.
279      !!
280      !! ** input   : - namrun namelist
281      !!              - namdom namelist
282      !!              - namnc4 namelist   ! "key_netcdf4" only
283      !!----------------------------------------------------------------------
284      USE ioipsl
285      !!
286      INTEGER  ::   ios   ! Local integer
287      !
288      NAMELIST/namrun/ cn_ocerst_indir, cn_ocerst_outdir, nn_stocklist, ln_rst_list,                 &
289         &             nn_no   , cn_exp   , cn_ocerst_in, cn_ocerst_out, ln_rstart , nn_rstctl ,     &
290         &             nn_it000, nn_itend , nn_date0    , nn_time0     , nn_leapy  , nn_istate ,     &
291         &             nn_stock, nn_write , ln_mskland  , ln_clobber   , nn_chunksz, nn_euler  ,     &
292         &             ln_cfmeta, ln_iscpl, ln_xios_read, nn_wxios
293      NAMELIST/namdom/ ln_linssh, rn_isfhmin, rn_rdt, rn_atfp, ln_crs, ln_meshmask
294#if defined key_netcdf4
295      NAMELIST/namnc4/ nn_nchunks_i, nn_nchunks_j, nn_nchunks_k, ln_nc4zip
296#endif
297      !!----------------------------------------------------------------------
298      !
299      IF(lwp) THEN
300         WRITE(numout,*)
301         WRITE(numout,*) 'dom_nam : domain initialization through namelist read'
302         WRITE(numout,*) '~~~~~~~ '
303      ENDIF
304      !
305      !
306      REWIND( numnam_ref )              ! Namelist namrun in reference namelist : Parameters of the run
307      READ  ( numnam_ref, namrun, IOSTAT = ios, ERR = 901)
308901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namrun in reference namelist' )
309      REWIND( numnam_cfg )              ! Namelist namrun in configuration namelist : Parameters of the run
310      READ  ( numnam_cfg, namrun, IOSTAT = ios, ERR = 902 )
311902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namrun in configuration namelist' )
312      IF(lwm) WRITE ( numond, namrun )
313      !
314      IF(lwp) THEN                  ! control print
315         WRITE(numout,*) '   Namelist : namrun   ---   run parameters'
316         WRITE(numout,*) '      Assimilation cycle              nn_no           = ', nn_no
317         WRITE(numout,*) '      experiment name for output      cn_exp          = ', TRIM( cn_exp           )
318         WRITE(numout,*) '      file prefix restart input       cn_ocerst_in    = ', TRIM( cn_ocerst_in     )
319         WRITE(numout,*) '      restart input directory         cn_ocerst_indir = ', TRIM( cn_ocerst_indir  )
320         WRITE(numout,*) '      file prefix restart output      cn_ocerst_out   = ', TRIM( cn_ocerst_out    )
321         WRITE(numout,*) '      restart output directory        cn_ocerst_outdir= ', TRIM( cn_ocerst_outdir )
322         WRITE(numout,*) '      restart logical                 ln_rstart       = ', ln_rstart
323         WRITE(numout,*) '      start with forward time step    nn_euler        = ', nn_euler
324         WRITE(numout,*) '      control of time step            nn_rstctl       = ', nn_rstctl
325         WRITE(numout,*) '      number of the first time step   nn_it000        = ', nn_it000
326         WRITE(numout,*) '      number of the last time step    nn_itend        = ', nn_itend
327         WRITE(numout,*) '      initial calendar date aammjj    nn_date0        = ', nn_date0
328         WRITE(numout,*) '      initial time of day in hhmm     nn_time0        = ', nn_time0
329         WRITE(numout,*) '      leap year calendar (0/1)        nn_leapy        = ', nn_leapy
330         WRITE(numout,*) '      initial state output            nn_istate       = ', nn_istate
331         IF( ln_rst_list ) THEN
332            WRITE(numout,*) '      list of restart dump times      nn_stocklist    =', nn_stocklist
333         ELSE
334            WRITE(numout,*) '      frequency of restart file       nn_stock        = ', nn_stock
335         ENDIF
336#if ! defined key_iomput
337         WRITE(numout,*) '      frequency of output file        nn_write        = ', nn_write
338#endif
339         WRITE(numout,*) '      mask land points                ln_mskland      = ', ln_mskland
340         WRITE(numout,*) '      additional CF standard metadata ln_cfmeta       = ', ln_cfmeta
341         WRITE(numout,*) '      overwrite an existing file      ln_clobber      = ', ln_clobber
342         WRITE(numout,*) '      NetCDF chunksize (bytes)        nn_chunksz      = ', nn_chunksz
343         WRITE(numout,*) '      IS coupling at the restart step ln_iscpl        = ', ln_iscpl
344         IF( TRIM(Agrif_CFixed()) == '0' ) THEN
345            WRITE(numout,*) '      READ restart for a single file using XIOS ln_xios_read =', ln_xios_read
346            WRITE(numout,*) '      Write restart using XIOS        nn_wxios   = ', nn_wxios
347         ELSE
348            WRITE(numout,*) "      AGRIF: nn_wxios will be ingored. See setting for parent"
349            WRITE(numout,*) "      AGRIF: ln_xios_read will be ingored. See setting for parent"
350         ENDIF
351      ENDIF
352
353      cexper = cn_exp         ! conversion DOCTOR names into model names (this should disappear soon)
354      nrstdt = nn_rstctl
355      nit000 = nn_it000
356      nitend = nn_itend
357      ndate0 = nn_date0
358      nleapy = nn_leapy
359      ninist = nn_istate
360      neuler = nn_euler
361      IF( neuler == 1 .AND. .NOT. ln_rstart ) THEN
362         IF(lwp) WRITE(numout,*) 
363         IF(lwp) WRITE(numout,*)'   ==>>>   Start from rest (ln_rstart=F)'
364         IF(lwp) WRITE(numout,*)'           an Euler initial time step is used : nn_euler is forced to 0 '   
365         neuler = 0
366      ENDIF
367      !                             ! control of output frequency
368      IF( .NOT. ln_rst_list ) THEN     ! we use nn_stock
369         IF( nn_stock == -1 )   CALL ctl_warn( 'nn_stock = -1 --> no restart will be done' )
370         IF( nn_stock == 0 .OR. nn_stock > nitend ) THEN
371            WRITE(ctmp1,*) 'nn_stock = ', nn_stock, ' it is forced to ', nitend
372            CALL ctl_warn( ctmp1 )
373            nn_stock = nitend
374         ENDIF
375      ENDIF
376#if ! defined key_iomput
377      IF( nn_write == -1 )   CALL ctl_warn( 'nn_write = -1 --> no output files will be done' )
378      IF ( nn_write == 0 ) THEN
379         WRITE(ctmp1,*) 'nn_write = ', nn_write, ' it is forced to ', nitend
380         CALL ctl_warn( ctmp1 )
381         nn_write = nitend
382      ENDIF
383#endif
384
385#if defined key_agrif
386      IF( Agrif_Root() ) THEN
387#endif
388      IF(lwp) WRITE(numout,*)
389      SELECT CASE ( nleapy )        ! Choose calendar for IOIPSL
390      CASE (  1 ) 
391         CALL ioconf_calendar('gregorian')
392         IF(lwp) WRITE(numout,*) '   ==>>>   The IOIPSL calendar is "gregorian", i.e. leap year'
393      CASE (  0 )
394         CALL ioconf_calendar('noleap')
395         IF(lwp) WRITE(numout,*) '   ==>>>   The IOIPSL calendar is "noleap", i.e. no leap year'
396      CASE ( 30 )
397         CALL ioconf_calendar('360d')
398         IF(lwp) WRITE(numout,*) '   ==>>>   The IOIPSL calendar is "360d", i.e. 360 days in a year'
399      END SELECT
400#if defined key_agrif
401      ENDIF
402#endif
403
404      REWIND( numnam_ref )              ! Namelist namdom in reference namelist : space & time domain (bathymetry, mesh, timestep)
405      READ  ( numnam_ref, namdom, IOSTAT = ios, ERR = 903)
406903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namdom in reference namelist' )
407      REWIND( numnam_cfg )              ! Namelist namdom in configuration namelist : space & time domain (bathymetry, mesh, timestep)
408      READ  ( numnam_cfg, namdom, IOSTAT = ios, ERR = 904 )
409904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namdom in configuration namelist' )
410      IF(lwm) WRITE( numond, namdom )
411      !
412      IF(lwp) THEN
413         WRITE(numout,*)
414         WRITE(numout,*) '   Namelist : namdom   ---   space & time domain'
415         WRITE(numout,*) '      linear free surface (=T)                ln_linssh   = ', ln_linssh
416         WRITE(numout,*) '      create mesh/mask file                   ln_meshmask = ', ln_meshmask
417         WRITE(numout,*) '      treshold to open the isf cavity         rn_isfhmin  = ', rn_isfhmin, ' [m]'
418         WRITE(numout,*) '      ocean time step                         rn_rdt      = ', rn_rdt
419         WRITE(numout,*) '      asselin time filter parameter           rn_atfp     = ', rn_atfp
420         WRITE(numout,*) '      online coarsening of dynamical fields   ln_crs      = ', ln_crs
421      ENDIF
422      !
423      !          ! conversion DOCTOR names into model names (this should disappear soon)
424      atfp = rn_atfp
425      rdt  = rn_rdt
426
427      IF( TRIM(Agrif_CFixed()) == '0' ) THEN
428         lrxios = ln_xios_read.AND.ln_rstart
429!set output file type for XIOS based on NEMO namelist
430         IF (nn_wxios > 0) lwxios = .TRUE. 
431         nxioso = nn_wxios
432      ENDIF
433
434#if defined key_netcdf4
435      !                             ! NetCDF 4 case   ("key_netcdf4" defined)
436      REWIND( numnam_ref )              ! Namelist namnc4 in reference namelist : NETCDF
437      READ  ( numnam_ref, namnc4, IOSTAT = ios, ERR = 907)
438907   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namnc4 in reference namelist' )
439      REWIND( numnam_cfg )              ! Namelist namnc4 in configuration namelist : NETCDF
440      READ  ( numnam_cfg, namnc4, IOSTAT = ios, ERR = 908 )
441908   IF( ios >  0 )   CALL ctl_nam ( ios , 'namnc4 in configuration namelist' )
442      IF(lwm) WRITE( numond, namnc4 )
443
444      IF(lwp) THEN                        ! control print
445         WRITE(numout,*)
446         WRITE(numout,*) '   Namelist namnc4 - Netcdf4 chunking parameters'
447         WRITE(numout,*) '      number of chunks in i-dimension             nn_nchunks_i = ', nn_nchunks_i
448         WRITE(numout,*) '      number of chunks in j-dimension             nn_nchunks_j = ', nn_nchunks_j
449         WRITE(numout,*) '      number of chunks in k-dimension             nn_nchunks_k = ', nn_nchunks_k
450         WRITE(numout,*) '      apply netcdf4/hdf5 chunking & compression   ln_nc4zip    = ', ln_nc4zip
451      ENDIF
452
453      ! Put the netcdf4 settings into a simple structure (snc4set, defined in in_out_manager module)
454      ! Note the chunk size in the unlimited (time) dimension will be fixed at 1
455      snc4set%ni   = nn_nchunks_i
456      snc4set%nj   = nn_nchunks_j
457      snc4set%nk   = nn_nchunks_k
458      snc4set%luse = ln_nc4zip
459#else
460      snc4set%luse = .FALSE.        ! No NetCDF 4 case
461#endif
462      !
463   END SUBROUTINE dom_nam
464
465
466   SUBROUTINE dom_ctl
467      !!----------------------------------------------------------------------
468      !!                     ***  ROUTINE dom_ctl  ***
469      !!
470      !! ** Purpose :   Domain control.
471      !!
472      !! ** Method  :   compute and print extrema of masked scale factors
473      !!----------------------------------------------------------------------
474      INTEGER, DIMENSION(2) ::   imi1, imi2, ima1, ima2
475      INTEGER, DIMENSION(2) ::   iloc   !
476      REAL(wp) ::   ze1min, ze1max, ze2min, ze2max
477      !!----------------------------------------------------------------------
478      !
479      IF(lk_mpp) THEN
480         CALL mpp_minloc( 'domain', e1t(:,:), tmask_i(:,:), ze1min, imi1 )
481         CALL mpp_minloc( 'domain', e2t(:,:), tmask_i(:,:), ze2min, imi2 )
482         CALL mpp_maxloc( 'domain', e1t(:,:), tmask_i(:,:), ze1max, ima1 )
483         CALL mpp_maxloc( 'domain', e2t(:,:), tmask_i(:,:), ze2max, ima2 )
484      ELSE
485         ze1min = MINVAL( e1t(:,:), mask = tmask_i(:,:) == 1._wp )   
486         ze2min = MINVAL( e2t(:,:), mask = tmask_i(:,:) == 1._wp )   
487         ze1max = MAXVAL( e1t(:,:), mask = tmask_i(:,:) == 1._wp )   
488         ze2max = MAXVAL( e2t(:,:), mask = tmask_i(:,:) == 1._wp )   
489         !
490         iloc  = MINLOC( e1t(:,:), mask = tmask_i(:,:) == 1._wp )
491         imi1(1) = iloc(1) + nimpp - 1
492         imi1(2) = iloc(2) + njmpp - 1
493         iloc  = MINLOC( e2t(:,:), mask = tmask_i(:,:) == 1._wp )
494         imi2(1) = iloc(1) + nimpp - 1
495         imi2(2) = iloc(2) + njmpp - 1
496         iloc  = MAXLOC( e1t(:,:), mask = tmask_i(:,:) == 1._wp )
497         ima1(1) = iloc(1) + nimpp - 1
498         ima1(2) = iloc(2) + njmpp - 1
499         iloc  = MAXLOC( e2t(:,:), mask = tmask_i(:,:) == 1._wp )
500         ima2(1) = iloc(1) + nimpp - 1
501         ima2(2) = iloc(2) + njmpp - 1
502      ENDIF
503      IF(lwp) THEN
504         WRITE(numout,*)
505         WRITE(numout,*) 'dom_ctl : extrema of the masked scale factors'
506         WRITE(numout,*) '~~~~~~~'
507         WRITE(numout,"(14x,'e1t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1max, ima1(1), ima1(2)
508         WRITE(numout,"(14x,'e1t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1min, imi1(1), imi1(2)
509         WRITE(numout,"(14x,'e2t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2max, ima2(1), ima2(2)
510         WRITE(numout,"(14x,'e2t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2min, imi2(1), imi2(2)
511      ENDIF
512      !
513   END SUBROUTINE dom_ctl
514
515
516   SUBROUTINE domain_cfg( cd_cfg, kk_cfg, kpi, kpj, kpk, kperio )
517      !!----------------------------------------------------------------------
518      !!                     ***  ROUTINE dom_nam  ***
519      !!                   
520      !! ** Purpose :   read the domain size in domain configuration file
521      !!
522      !! ** Method  :   read the cn_domcfg NetCDF file
523      !!----------------------------------------------------------------------
524      CHARACTER(len=*)              , INTENT(out) ::   cd_cfg          ! configuration name
525      INTEGER                       , INTENT(out) ::   kk_cfg          ! configuration resolution
526      INTEGER                       , INTENT(out) ::   kpi, kpj, kpk   ! global domain sizes
527      INTEGER                       , INTENT(out) ::   kperio          ! lateral global domain b.c.
528      !
529      INTEGER ::   inum   ! local integer
530      REAL(wp) ::   zorca_res                     ! local scalars
531      REAL(wp) ::   zperio                        !   -      -
532      INTEGER, DIMENSION(4) ::   idvar, idimsz    ! size   of dimensions
533      !!----------------------------------------------------------------------
534      !
535      IF(lwp) THEN
536         WRITE(numout,*) '           '
537         WRITE(numout,*) 'domain_cfg : domain size read in ', TRIM( cn_domcfg ), ' file'
538         WRITE(numout,*) '~~~~~~~~~~ '
539      ENDIF
540      !
541      CALL iom_open( cn_domcfg, inum )
542      !
543      !                                   !- ORCA family specificity
544      IF(  iom_varid( inum, 'ORCA'       , ldstop = .FALSE. ) > 0  .AND.  &
545         & iom_varid( inum, 'ORCA_index' , ldstop = .FALSE. ) > 0    ) THEN
546         !
547         cd_cfg = 'ORCA'
548         CALL iom_get( inum, 'ORCA_index', zorca_res )   ;   kk_cfg = NINT( zorca_res )
549         !
550         IF(lwp) THEN
551            WRITE(numout,*) '   .'
552            WRITE(numout,*) '   ==>>>   ORCA configuration '
553            WRITE(numout,*) '   .'
554         ENDIF
555         !
556      ELSE                                !- cd_cfg & k_cfg are not used
557         cd_cfg = 'UNKNOWN'
558         kk_cfg = -9999999
559                                          !- or they may be present as global attributes
560                                          !- (netcdf only) 
561         CALL iom_getatt( inum, 'cn_cfg', cd_cfg )  ! returns   !  if not found
562         CALL iom_getatt( inum, 'nn_cfg', kk_cfg )  ! returns -999 if not found
563         IF( TRIM(cd_cfg) == '!') cd_cfg = 'UNKNOWN'
564         IF( kk_cfg == -999     ) kk_cfg = -9999999
565         !
566      ENDIF
567       !
568      idvar = iom_varid( inum, 'e3t_0', kdimsz = idimsz )   ! use e3t_0, that must exist, to get jp(ijk)glo
569      kpi = idimsz(1)
570      kpj = idimsz(2)
571      kpk = idimsz(3)
572      CALL iom_get( inum, 'jperio', zperio )   ;   kperio = NINT( zperio )
573      CALL iom_close( inum )
574      !
575      IF(lwp) THEN
576         WRITE(numout,*) '      cn_cfg = ', TRIM(cd_cfg), '   nn_cfg = ', kk_cfg
577         WRITE(numout,*) '      jpiglo = ', kpi
578         WRITE(numout,*) '      jpjglo = ', kpj
579         WRITE(numout,*) '      jpkglo = ', kpk
580         WRITE(numout,*) '      type of global domain lateral boundary   jperio = ', kperio
581      ENDIF
582      !       
583   END SUBROUTINE domain_cfg
584   
585   
586   SUBROUTINE cfg_write
587      !!----------------------------------------------------------------------
588      !!                  ***  ROUTINE cfg_write  ***
589      !!                   
590      !! ** Purpose :   Create the "cn_domcfg_out" file, a NetCDF file which
591      !!              contains all the ocean domain informations required to
592      !!              define an ocean configuration.
593      !!
594      !! ** Method  :   Write in a file all the arrays required to set up an
595      !!              ocean configuration.
596      !!
597      !! ** output file :   domcfg_out.nc : domain size, characteristics, horizontal
598      !!                       mesh, Coriolis parameter, and vertical scale factors
599      !!                    NB: also contain ORCA family information
600      !!----------------------------------------------------------------------
601      INTEGER           ::   ji, jj, jk   ! dummy loop indices
602      INTEGER           ::   izco, izps, isco, icav
603      INTEGER           ::   inum     ! local units
604      CHARACTER(len=21) ::   clnam    ! filename (mesh and mask informations)
605      REAL(wp), DIMENSION(jpi,jpj) ::   z2d   ! workspace
606      !!----------------------------------------------------------------------
607      !
608      IF(lwp) WRITE(numout,*)
609      IF(lwp) WRITE(numout,*) 'cfg_write : create the domain configuration file (', TRIM(cn_domcfg_out),'.nc)'
610      IF(lwp) WRITE(numout,*) '~~~~~~~~~'
611      !
612      !                       ! ============================= !
613      !                       !  create 'domcfg_out.nc' file  !
614      !                       ! ============================= !
615      !         
616      clnam = cn_domcfg_out  ! filename (configuration information)
617      CALL iom_open( TRIM(clnam), inum, ldwrt = .TRUE. )
618     
619      !
620      !                             !==  ORCA family specificities  ==!
621      IF( cn_cfg == "ORCA" ) THEN
622         CALL iom_rstput( 0, 0, inum, 'ORCA'      , 1._wp            , ktype = jp_i4 )
623         CALL iom_rstput( 0, 0, inum, 'ORCA_index', REAL( nn_cfg, wp), ktype = jp_i4 )         
624      ENDIF
625      !
626      !                             !==  global domain size  ==!
627      !
628      CALL iom_rstput( 0, 0, inum, 'jpiglo', REAL( jpiglo, wp), ktype = jp_i4 )
629      CALL iom_rstput( 0, 0, inum, 'jpjglo', REAL( jpjglo, wp), ktype = jp_i4 )
630      CALL iom_rstput( 0, 0, inum, 'jpkglo', REAL( jpk   , wp), ktype = jp_i4 )
631      !
632      !                             !==  domain characteristics  ==!
633      !
634      !                                   ! lateral boundary of the global domain
635      CALL iom_rstput( 0, 0, inum, 'jperio', REAL( jperio, wp), ktype = jp_i4 )
636      !
637      !                                   ! type of vertical coordinate
638      IF( ln_zco    ) THEN   ;   izco = 1   ;   ELSE   ;   izco = 0   ;   ENDIF
639      IF( ln_zps    ) THEN   ;   izps = 1   ;   ELSE   ;   izps = 0   ;   ENDIF
640      IF( ln_sco    ) THEN   ;   isco = 1   ;   ELSE   ;   isco = 0   ;   ENDIF
641      CALL iom_rstput( 0, 0, inum, 'ln_zco'   , REAL( izco, wp), ktype = jp_i4 )
642      CALL iom_rstput( 0, 0, inum, 'ln_zps'   , REAL( izps, wp), ktype = jp_i4 )
643      CALL iom_rstput( 0, 0, inum, 'ln_sco'   , REAL( isco, wp), ktype = jp_i4 )
644      !
645      !                                   ! ocean cavities under iceshelves
646      IF( ln_isfcav ) THEN   ;   icav = 1   ;   ELSE   ;   icav = 0   ;   ENDIF
647      CALL iom_rstput( 0, 0, inum, 'ln_isfcav', REAL( icav, wp), ktype = jp_i4 )
648      !
649      !                             !==  horizontal mesh  !
650      !
651      CALL iom_rstput( 0, 0, inum, 'glamt', glamt, ktype = jp_r8 )   ! latitude
652      CALL iom_rstput( 0, 0, inum, 'glamu', glamu, ktype = jp_r8 )
653      CALL iom_rstput( 0, 0, inum, 'glamv', glamv, ktype = jp_r8 )
654      CALL iom_rstput( 0, 0, inum, 'glamf', glamf, ktype = jp_r8 )
655      !                               
656      CALL iom_rstput( 0, 0, inum, 'gphit', gphit, ktype = jp_r8 )   ! longitude
657      CALL iom_rstput( 0, 0, inum, 'gphiu', gphiu, ktype = jp_r8 )
658      CALL iom_rstput( 0, 0, inum, 'gphiv', gphiv, ktype = jp_r8 )
659      CALL iom_rstput( 0, 0, inum, 'gphif', gphif, ktype = jp_r8 )
660      !                               
661      CALL iom_rstput( 0, 0, inum, 'e1t'  , e1t  , ktype = jp_r8 )   ! i-scale factors (e1.)
662      CALL iom_rstput( 0, 0, inum, 'e1u'  , e1u  , ktype = jp_r8 )
663      CALL iom_rstput( 0, 0, inum, 'e1v'  , e1v  , ktype = jp_r8 )
664      CALL iom_rstput( 0, 0, inum, 'e1f'  , e1f  , ktype = jp_r8 )
665      !
666      CALL iom_rstput( 0, 0, inum, 'e2t'  , e2t  , ktype = jp_r8 )   ! j-scale factors (e2.)
667      CALL iom_rstput( 0, 0, inum, 'e2u'  , e2u  , ktype = jp_r8 )
668      CALL iom_rstput( 0, 0, inum, 'e2v'  , e2v  , ktype = jp_r8 )
669      CALL iom_rstput( 0, 0, inum, 'e2f'  , e2f  , ktype = jp_r8 )
670      !
671      CALL iom_rstput( 0, 0, inum, 'ff_f' , ff_f , ktype = jp_r8 )   ! coriolis factor
672      CALL iom_rstput( 0, 0, inum, 'ff_t' , ff_t , ktype = jp_r8 )
673      !
674      !                             !==  vertical mesh  ==!
675      !                                                     
676      CALL iom_rstput( 0, 0, inum, 'e3t_1d'  , e3t_1d , ktype = jp_r8 )   ! reference 1D-coordinate
677      CALL iom_rstput( 0, 0, inum, 'e3w_1d'  , e3w_1d , ktype = jp_r8 )
678      !
679      CALL iom_rstput( 0, 0, inum, 'e3t_0'   , e3t_0  , ktype = jp_r8 )   ! vertical scale factors
680      CALL iom_rstput( 0, 0, inum, 'e3u_0'   , e3u_0  , ktype = jp_r8 )
681      CALL iom_rstput( 0, 0, inum, 'e3v_0'   , e3v_0  , ktype = jp_r8 )
682      CALL iom_rstput( 0, 0, inum, 'e3f_0'   , e3f_0  , ktype = jp_r8 )
683      CALL iom_rstput( 0, 0, inum, 'e3w_0'   , e3w_0  , ktype = jp_r8 )
684      CALL iom_rstput( 0, 0, inum, 'e3uw_0'  , e3uw_0 , ktype = jp_r8 )
685      CALL iom_rstput( 0, 0, inum, 'e3vw_0'  , e3vw_0 , ktype = jp_r8 )
686      !                                         
687      !                             !==  wet top and bottom level  ==!   (caution: multiplied by ssmask)
688      !
689      CALL iom_rstput( 0, 0, inum, 'top_level'    , REAL( mikt, wp )*ssmask , ktype = jp_i4 )   ! nb of ocean T-points (ISF)
690      CALL iom_rstput( 0, 0, inum, 'bottom_level' , REAL( mbkt, wp )*ssmask , ktype = jp_i4 )   ! nb of ocean T-points
691      !
692      IF( ln_sco ) THEN             ! s-coordinate: store grid stiffness ratio  (Not required anyway)
693         CALL dom_stiff( z2d )
694         CALL iom_rstput( 0, 0, inum, 'stiffness', z2d )        !    ! Max. grid stiffness ratio
695      ENDIF
696      !
697      IF( ll_wd ) THEN              ! wetting and drying domain
698         CALL iom_rstput( 0, 0, inum, 'ht_0'   , ht_0   , ktype = jp_r8 )
699      ENDIF
700      !
701      ! Add some global attributes ( netcdf only )
702      CALL iom_putatt( inum, 'nn_cfg', nn_cfg )
703      CALL iom_putatt( inum, 'cn_cfg', TRIM(cn_cfg) )
704      !
705      !                                ! ============================
706      !                                !        close the files
707      !                                ! ============================
708      CALL iom_close( inum )
709      !
710   END SUBROUTINE cfg_write
711
712   !!======================================================================
713END MODULE domain
Note: See TracBrowser for help on using the repository browser.