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

source: NEMO/trunk/src/OCE/DOM/domain.F90 @ 10068

Last change on this file since 10068 was 10068, checked in by nicolasmartin, 6 years ago

First part of modifications to have a common default header : fix typos and SVN keywords properties

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