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/dev_r12377_KERNEL-06_techene_e3/src/OCE/DOM – NEMO

source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/OCE/DOM/domain.F90 @ 12482

Last change on this file since 12482 was 12482, checked in by techene, 4 years ago

new reference without ztilde, duplicated modules and routines to be modified from zstar MLF to zstar LF

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