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/2019/dev_r12072_MERGE_OPTION2_2019/src/OCE/DOM – NEMO

source: NEMO/branches/2019/dev_r12072_MERGE_OPTION2_2019/src/OCE/DOM/domain.F90 @ 12172

Last change on this file since 12172 was 12172, checked in by cetlod, 4 years ago

dev_merge_option2 : merge in ENHANCE-03_closea branch

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