source: branches/UKMO/dev_r5518_GO6_starthour_obsoper/NEMOGCM/NEMO/OPA_SRC/DOM/domain.F90 @ 11883

Last change on this file since 11883 was 11883, checked in by timgraham, 10 months ago

Mergerd in changes from Chris' working copy (except for symlink changes)

File size: 25.0 KB
Line 
1MODULE domain
2   !!==============================================================================
3   !!                       ***  MODULE domain   ***
4   !! Ocean initialization : domain initialization
5   !!==============================================================================
6   !! History :  OPA  !  1990-10  (C. Levy - G. Madec)  Original code
7   !!                 !  1992-01  (M. Imbard) insert time step initialization
8   !!                 !  1996-06  (G. Madec) generalized vertical coordinate
9   !!                 !  1997-02  (G. Madec) creation of domwri.F
10   !!                 !  2001-05  (E.Durand - G. Madec) insert closed sea
11   !!   NEMO     1.0  !  2002-08  (G. Madec)  F90: Free form and module
12   !!            2.0  !  2005-11  (V. Garnier) Surface pressure gradient organization
13   !!            3.3  !  2010-11  (G. Madec)  initialisation in C1D configuration
14   !!            3.6  !  2013     ( J. Simeon, C. Calone, G. Madec, C. Ethe ) Online coarsening of outputs
15   !!----------------------------------------------------------------------
16   
17   !!----------------------------------------------------------------------
18   !!   dom_init       : initialize the space and time domain
19   !!   dom_nam        : read and contral domain namelists
20   !!   dom_ctl        : control print for the ocean domain
21   !!----------------------------------------------------------------------
22   USE oce             ! ocean variables
23   USE dom_oce         ! domain: ocean
24   USE sbc_oce         ! surface boundary condition: ocean
25   USE phycst          ! physical constants
26   USE closea          ! closed seas
27   USE in_out_manager  ! I/O manager
28   USE lib_mpp         ! distributed memory computing library
29
30   USE domhgr          ! domain: set the horizontal mesh
31   USE domzgr          ! domain: set the vertical mesh
32   USE domstp          ! domain: set the time-step
33   USE dommsk          ! domain: set the mask system
34   USE domwri          ! domain: write the meshmask file
35   USE domvvl          ! variable volume
36   USE c1d             ! 1D vertical configuration
37   USE dyncor_c1d      ! Coriolis term (c1d case)         (cor_c1d routine)
38   USE timing          ! Timing
39   USE lbclnk          ! ocean lateral boundary condition (or mpp link)
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   dom_init   ! called by opa.F90
45
46   !! * Substitutions
47#  include "domzgr_substitute.h90"
48   !!-------------------------------------------------------------------------
49   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
50   !! $Id$
51   !! Software governed by the CeCILL licence        (NEMOGCM/NEMO_CeCILL.txt)
52   !!-------------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE dom_init
56      !!----------------------------------------------------------------------
57      !!                  ***  ROUTINE dom_init  ***
58      !!                   
59      !! ** Purpose :   Domain initialization. Call the routines that are
60      !!              required to create the arrays which define the space
61      !!              and time domain of the ocean model.
62      !!
63      !! ** Method  : - dom_msk: compute the masks from the bathymetry file
64      !!              - dom_hgr: compute or read the horizontal grid-point position
65      !!                         and scale factors, and the coriolis factor
66      !!              - dom_zgr: define the vertical coordinate and the bathymetry
67      !!              - dom_stp: defined the model time step
68      !!              - dom_wri: create the meshmask file if nmsh=1
69      !!              - 1D configuration, move Coriolis, u and v at T-point
70      !!----------------------------------------------------------------------
71      INTEGER ::   jk          ! dummy loop argument
72      INTEGER ::   iconf = 0   ! local integers
73      !!----------------------------------------------------------------------
74      !
75      IF( nn_timing == 1 )   CALL timing_start('dom_init')
76      !
77      IF(lwp) THEN
78         WRITE(numout,*)
79         WRITE(numout,*) 'dom_init : domain initialization'
80         WRITE(numout,*) '~~~~~~~~'
81      ENDIF
82      !
83                             CALL dom_nam      ! read namelist ( namrun, namdom, namcla )
84                             CALL dom_clo      ! Closed seas and lake
85                             CALL dom_hgr      ! Horizontal mesh
86                             CALL dom_zgr      ! Vertical mesh and bathymetry
87                             CALL dom_msk      ! Masks
88      IF( ln_sco )           CALL dom_stiff    ! Maximum stiffness ratio/hydrostatic consistency
89      !
90      ht_0(:,:) = 0.0_wp                       ! Reference ocean depth at T-points
91      hu_0(:,:) = 0.0_wp                       ! Reference ocean depth at U-points
92      hv_0(:,:) = 0.0_wp                       ! Reference ocean depth at V-points
93      DO jk = 1, jpk
94         ht_0(:,:) = ht_0(:,:) + e3t_0(:,:,jk) * tmask(:,:,jk)
95         hu_0(:,:) = hu_0(:,:) + e3u_0(:,:,jk) * umask(:,:,jk)
96         hv_0(:,:) = hv_0(:,:) + e3v_0(:,:,jk) * vmask(:,:,jk)
97      END DO
98      !
99      IF( lk_vvl )           CALL dom_vvl_init ! Vertical variable mesh
100      !
101      IF( lk_c1d         )   CALL cor_c1d      ! 1D configuration: Coriolis set at T-point
102      !
103      !
104      hu(:,:) = 0._wp                          ! Ocean depth at U-points
105      hv(:,:) = 0._wp                          ! Ocean depth at V-points
106      ht(:,:) = 0._wp                          ! Ocean depth at T-points
107      DO jk = 1, jpkm1
108         hu(:,:) = hu(:,:) + fse3u_n(:,:,jk) * umask(:,:,jk)
109         hv(:,:) = hv(:,:) + fse3v_n(:,:,jk) * vmask(:,:,jk)
110         ht(:,:) = ht(:,:) + fse3t_n(:,:,jk) * tmask(:,:,jk)
111      END DO
112      !                                        ! Inverse of the local depth
113      hur(:,:) = 1._wp / ( hu(:,:) + 1._wp - umask_i(:,:) ) * umask_i(:,:)
114      hvr(:,:) = 1._wp / ( hv(:,:) + 1._wp - vmask_i(:,:) ) * vmask_i(:,:)
115
116                             CALL dom_stp      ! time step
117      IF( nmsh /= 0      )   CALL dom_wri      ! Create a domain file
118      IF( .NOT.ln_rstart )   CALL dom_ctl      ! Domain control
119      !
120      IF( nn_timing == 1 )   CALL timing_stop('dom_init')
121      !
122   END SUBROUTINE dom_init
123
124
125   SUBROUTINE dom_nam
126      !!----------------------------------------------------------------------
127      !!                     ***  ROUTINE dom_nam  ***
128      !!                   
129      !! ** Purpose :   read domaine namelists and print the variables.
130      !!
131      !! ** input   : - namrun namelist
132      !!              - namdom namelist
133      !!              - namcla namelist
134      !!              - namnc4 namelist   ! "key_netcdf4" only
135      !!----------------------------------------------------------------------
136      USE ioipsl
137      NAMELIST/namrun/ cn_ocerst_indir, cn_ocerst_outdir, nn_stocklist, ln_rst_list,               &
138         &             nn_no   , cn_exp    , cn_ocerst_in, cn_ocerst_out, ln_rstart , ln_rstdate, nn_rstctl,   &
139         &             nn_it000, nn_itend  , nn_date0    , nn_time0,      nn_leapy     , nn_istate , nn_abort, nn_stock ,   &
140         &             nn_write, ln_dimgnnn, ln_mskland  , ln_cfmeta    , ln_clobber, nn_chunksz, nn_euler
141      NAMELIST/namdom/ nn_bathy, rn_bathy , rn_e3zps_min, rn_e3zps_rat, nn_msh, rn_hmin,   &
142         &             nn_acc   , rn_atfp     , rn_rdt      , rn_rdtmin ,                  &
143         &             rn_rdtmax, rn_rdth     , nn_closea , ln_crs,    &
144         &             jphgr_msh, &
145         &             ppglam0, ppgphi0, ppe1_deg, ppe2_deg, ppe1_m, ppe2_m, &
146         &             ppsur, ppa0, ppa1, ppkth, ppacr, ppdzmin, pphmax, ldbletanh, &
147         &             ppa2, ppkth2, ppacr2
148      NAMELIST/namcla/ nn_cla
149#if defined key_netcdf4
150      NAMELIST/namnc4/ nn_nchunks_i, nn_nchunks_j, nn_nchunks_k, ln_nc4zip
151#endif
152      INTEGER  ::   ios                 ! Local integer output status for namelist read
153      !!----------------------------------------------------------------------
154
155      REWIND( numnam_ref )              ! Namelist namrun in reference namelist : Parameters of the run
156      READ  ( numnam_ref, namrun, IOSTAT = ios, ERR = 901)
157901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namrun in reference namelist', lwp )
158
159      REWIND( numnam_cfg )              ! Namelist namrun in configuration namelist : Parameters of the run
160      READ  ( numnam_cfg, namrun, IOSTAT = ios, ERR = 902 )
161902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namrun in configuration namelist', lwp )
162      IF(lwm) WRITE ( numond, namrun )
163      !
164      IF(lwp) THEN                  ! control print
165         WRITE(numout,*)
166         WRITE(numout,*) 'dom_nam  : domain initialization through namelist read'
167         WRITE(numout,*) '~~~~~~~ '
168         WRITE(numout,*) '   Namelist namrun'
169         WRITE(numout,*) '      job number                      nn_no      = ', nn_no
170         WRITE(numout,*) '      experiment name for output      cn_exp     = ', cn_exp
171         WRITE(numout,*) '      file prefix restart input       cn_ocerst_in= ', cn_ocerst_in
172         WRITE(numout,*) '      restart input directory         cn_ocerst_indir= ', cn_ocerst_indir
173         WRITE(numout,*) '      file prefix restart output      cn_ocerst_out= ', cn_ocerst_out
174         WRITE(numout,*) '      restart output directory        cn_ocerst_outdir= ', cn_ocerst_outdir
175         WRITE(numout,*) '      restart logical                 ln_rstart  = ' , ln_rstart
176         WRITE(numout,*) '      datestamping of restarts        ln_rstdate  = ', ln_rstdate
177         WRITE(numout,*) '      start with forward time step    nn_euler   = ', nn_euler
178         WRITE(numout,*) '      control of time step            nn_rstctl  = ', nn_rstctl
179         WRITE(numout,*) '      number of the first time step   nn_it000   = ', nn_it000
180         WRITE(numout,*) '      number of the last time step    nn_itend   = ', nn_itend
181         WRITE(numout,*) '      initial calendar date aammjj    nn_date0   = ', nn_date0
182         WRITE(numout,*) '      initial time of day in hhmm     nn_time0   = ', nn_time0
183         WRITE(numout,*) '      leap year calendar (0/1)        nn_leapy   = ', nn_leapy
184         WRITE(numout,*) '      initial state output            nn_istate  = ', nn_istate
185         WRITE(numout,*) '      abort state output              nn_abort   = ', nn_abort
186         IF( ln_rst_list ) THEN
187            WRITE(numout,*) '      list of restart dump times      nn_stocklist   =', nn_stocklist
188         ELSE
189            WRITE(numout,*) '      frequency of restart file       nn_stock   = ', nn_stock
190         ENDIF
191         WRITE(numout,*) '      frequency of output file        nn_write   = ', nn_write
192         WRITE(numout,*) '      multi file dimgout              ln_dimgnnn = ', ln_dimgnnn
193         WRITE(numout,*) '      mask land points                ln_mskland = ', ln_mskland
194         WRITE(numout,*) '      additional CF standard metadata ln_cfmeta  = ', ln_cfmeta
195         WRITE(numout,*) '      overwrite an existing file      ln_clobber = ', ln_clobber
196         WRITE(numout,*) '      NetCDF chunksize (bytes)        nn_chunksz = ', nn_chunksz
197      ENDIF
198
199      no = nn_no                    ! conversion DOCTOR names into model names (this should disappear soon)
200      cexper = cn_exp
201      nrstdt = nn_rstctl
202      nit000 = nn_it000
203      nitend = nn_itend
204      ndate0 = nn_date0
205      nleapy = nn_leapy
206      ninist = nn_istate
207      nstock = nn_stock
208      nstocklist = nn_stocklist
209      nwrite = nn_write
210      neuler = nn_euler
211      IF ( neuler == 1 .AND. .NOT. ln_rstart ) THEN
212         WRITE(ctmp1,*) 'ln_rstart =.FALSE., nn_euler is forced to 0 '
213         CALL ctl_warn( ctmp1 )
214         neuler = 0
215      ENDIF
216
217      !                             ! control of output frequency
218      IF ( nstock == 0 .OR. nstock > nitend ) THEN
219         WRITE(ctmp1,*) 'nstock = ', nstock, ' it is forced to ', nitend
220         CALL ctl_warn( ctmp1 )
221         nstock = nitend
222      ENDIF
223      IF ( nwrite == 0 ) THEN
224         WRITE(ctmp1,*) 'nwrite = ', nwrite, ' it is forced to ', nitend
225         CALL ctl_warn( ctmp1 )
226         nwrite = nitend
227      ENDIF
228
229#if defined key_agrif
230      IF( Agrif_Root() ) THEN
231#endif
232      SELECT CASE ( nleapy )        ! Choose calendar for IOIPSL
233      CASE (  1 ) 
234         CALL ioconf_calendar('gregorian')
235         IF(lwp) WRITE(numout,*) '   The IOIPSL calendar is "gregorian", i.e. leap year'
236      CASE (  0 )
237         CALL ioconf_calendar('noleap')
238         IF(lwp) WRITE(numout,*) '   The IOIPSL calendar is "noleap", i.e. no leap year'
239      CASE ( 30 )
240         CALL ioconf_calendar('360d')
241         IF(lwp) WRITE(numout,*) '   The IOIPSL calendar is "360d", i.e. 360 days in a year'
242      END SELECT
243#if defined key_agrif
244      ENDIF
245#endif
246
247      REWIND( numnam_ref )              ! Namelist namdom in reference namelist : space & time domain (bathymetry, mesh, timestep)
248      READ  ( numnam_ref, namdom, IOSTAT = ios, ERR = 903)
249903   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdom in reference namelist', lwp )
250 
251      !
252      REWIND( numnam_cfg )              ! Namelist namdom in configuration namelist : space & time domain (bathymetry, mesh, timestep)
253      READ  ( numnam_cfg, namdom, IOSTAT = ios, ERR = 904 )
254904   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdom in configuration namelist', lwp )
255      IF(lwm) WRITE ( numond, namdom )
256
257      IF(lwp) THEN
258         WRITE(numout,*)
259         WRITE(numout,*) '   Namelist namdom : space & time domain'
260         WRITE(numout,*) '      flag read/compute bathymetry      nn_bathy     = ', nn_bathy
261         WRITE(numout,*) '      Depth (if =0 bathy=jpkm1)         rn_bathy     = ', rn_bathy
262         WRITE(numout,*) '      min depth of the ocean    (>0) or    rn_hmin   = ', rn_hmin
263         WRITE(numout,*) '      min number of ocean level (<0)       '
264         WRITE(numout,*) '      minimum thickness of partial      rn_e3zps_min = ', rn_e3zps_min, ' (m)'
265         WRITE(numout,*) '         step level                     rn_e3zps_rat = ', rn_e3zps_rat
266         WRITE(numout,*) '      create mesh/mask file(s)          nn_msh       = ', nn_msh
267         WRITE(numout,*) '           = 0   no file created           '
268         WRITE(numout,*) '           = 1   mesh_mask                 '
269         WRITE(numout,*) '           = 2   mesh and mask             '
270         WRITE(numout,*) '           = 3   mesh_hgr, msh_zgr and mask'
271         WRITE(numout,*) '      ocean time step                       rn_rdt    = ', rn_rdt
272         WRITE(numout,*) '      asselin time filter parameter         rn_atfp   = ', rn_atfp
273         WRITE(numout,*) '      acceleration of converge              nn_acc    = ', nn_acc
274         WRITE(numout,*) '        nn_acc=1: surface tracer rdt        rn_rdtmin = ', rn_rdtmin
275         WRITE(numout,*) '                  bottom  tracer rdt        rdtmax    = ', rn_rdtmax
276         WRITE(numout,*) '                  depth of transition       rn_rdth   = ', rn_rdth
277         WRITE(numout,*) '      suppression of closed seas (=0)       nn_closea = ', nn_closea
278         WRITE(numout,*) '      online coarsening of dynamical fields ln_crs    = ', ln_crs
279         WRITE(numout,*) '      type of horizontal mesh jphgr_msh           = ', jphgr_msh
280         WRITE(numout,*) '      longitude of first raw and column T-point ppglam0 = ', ppglam0
281         WRITE(numout,*) '      latitude  of first raw and column T-point ppgphi0 = ', ppgphi0
282         WRITE(numout,*) '      zonal      grid-spacing (degrees) ppe1_deg        = ', ppe1_deg
283         WRITE(numout,*) '      meridional grid-spacing (degrees) ppe2_deg        = ', ppe2_deg
284         WRITE(numout,*) '      zonal      grid-spacing (degrees) ppe1_m          = ', ppe1_m
285         WRITE(numout,*) '      meridional grid-spacing (degrees) ppe2_m          = ', ppe2_m
286         WRITE(numout,*) '      ORCA r4, r2 and r05 coefficients  ppsur           = ', ppsur
287         WRITE(numout,*) '                                        ppa0            = ', ppa0
288         WRITE(numout,*) '                                        ppa1            = ', ppa1
289         WRITE(numout,*) '                                        ppkth           = ', ppkth
290         WRITE(numout,*) '                                        ppacr           = ', ppacr
291         WRITE(numout,*) '      Minimum vertical spacing ppdzmin                  = ', ppdzmin
292         WRITE(numout,*) '      Maximum depth pphmax                              = ', pphmax
293         WRITE(numout,*) '      Use double tanf function for vertical coordinates ldbletanh = ', ldbletanh
294         WRITE(numout,*) '      Double tanh function parameters ppa2              = ', ppa2
295         WRITE(numout,*) '                                      ppkth2            = ', ppkth2
296         WRITE(numout,*) '                                      ppacr2            = ', ppacr2
297      ENDIF
298
299      ntopo     = nn_bathy          ! conversion DOCTOR names into model names (this should disappear soon)
300      e3zps_min = rn_e3zps_min
301      e3zps_rat = rn_e3zps_rat
302      nmsh      = nn_msh
303      nacc      = nn_acc
304      atfp      = rn_atfp
305      rdt       = rn_rdt
306      rdtmin    = rn_rdtmin
307      rdtmax    = rn_rdtmin
308      rdth      = rn_rdth
309
310      REWIND( numnam_ref )              ! Namelist namcla in reference namelist : Cross land advection
311      READ  ( numnam_ref, namcla, IOSTAT = ios, ERR = 905)
312905   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcla in reference namelist', lwp )
313
314      REWIND( numnam_cfg )              ! Namelist namcla in configuration namelist : Cross land advection
315      READ  ( numnam_cfg, namcla, IOSTAT = ios, ERR = 906 )
316906   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcla in configuration namelist', lwp )
317      IF(lwm) WRITE( numond, namcla )
318
319      IF(lwp) THEN
320         WRITE(numout,*)
321         WRITE(numout,*) '   Namelist namcla'
322         WRITE(numout,*) '      cross land advection                 nn_cla    = ', nn_cla
323      ENDIF
324      IF ( nn_cla .EQ. 1 ) THEN
325         IF  ( cp_cfg == "orca" .AND. jp_cfg == 2 ) THEN   ! ORCA R2
326            CONTINUE
327         ELSE
328            CALL ctl_stop( 'STOP', 'Cross land advation iplemented only for ORCA2 configuration: cp_cfg = "orca" and jp_cfg = 2 ' )
329         ENDIF
330      ENDIF
331
332#if defined key_netcdf4
333      !                             ! NetCDF 4 case   ("key_netcdf4" defined)
334      REWIND( numnam_ref )              ! Namelist namnc4 in reference namelist : NETCDF
335      READ  ( numnam_ref, namnc4, IOSTAT = ios, ERR = 907)
336907   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namnc4 in reference namelist', lwp )
337
338      REWIND( numnam_cfg )              ! Namelist namnc4 in configuration namelist : NETCDF
339      READ  ( numnam_cfg, namnc4, IOSTAT = ios, ERR = 908 )
340908   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namnc4 in configuration namelist', lwp )
341      IF(lwm) WRITE( numond, namnc4 )
342
343      IF(lwp) THEN                        ! control print
344         WRITE(numout,*)
345         WRITE(numout,*) '   Namelist namnc4 - Netcdf4 chunking parameters'
346         WRITE(numout,*) '      number of chunks in i-dimension      nn_nchunks_i   = ', nn_nchunks_i
347         WRITE(numout,*) '      number of chunks in j-dimension      nn_nchunks_j   = ', nn_nchunks_j
348         WRITE(numout,*) '      number of chunks in k-dimension      nn_nchunks_k   = ', nn_nchunks_k
349         WRITE(numout,*) '      apply netcdf4/hdf5 chunking & compression ln_nc4zip = ', ln_nc4zip
350      ENDIF
351
352      ! Put the netcdf4 settings into a simple structure (snc4set, defined in in_out_manager module)
353      ! Note the chunk size in the unlimited (time) dimension will be fixed at 1
354      snc4set%ni   = nn_nchunks_i
355      snc4set%nj   = nn_nchunks_j
356      snc4set%nk   = nn_nchunks_k
357      snc4set%luse = ln_nc4zip
358#else
359      snc4set%luse = .FALSE.        ! No NetCDF 4 case
360#endif
361      !
362   END SUBROUTINE dom_nam
363
364
365   SUBROUTINE dom_ctl
366      !!----------------------------------------------------------------------
367      !!                     ***  ROUTINE dom_ctl  ***
368      !!
369      !! ** Purpose :   Domain control.
370      !!
371      !! ** Method  :   compute and print extrema of masked scale factors
372      !!----------------------------------------------------------------------
373      INTEGER ::   iimi1, ijmi1, iimi2, ijmi2, iima1, ijma1, iima2, ijma2
374      INTEGER, DIMENSION(2) ::   iloc   !
375      REAL(wp) ::   ze1min, ze1max, ze2min, ze2max
376      !!----------------------------------------------------------------------
377      !
378      IF(lk_mpp) THEN
379         CALL mpp_minloc( e1t(:,:), tmask_i(:,:), ze1min, iimi1,ijmi1 )
380         CALL mpp_minloc( e2t(:,:), tmask_i(:,:), ze2min, iimi2,ijmi2 )
381         CALL mpp_maxloc( e1t(:,:), tmask_i(:,:), ze1max, iima1,ijma1 )
382         CALL mpp_maxloc( e2t(:,:), tmask_i(:,:), ze2max, iima2,ijma2 )
383      ELSE
384         ze1min = MINVAL( e1t(:,:), mask = tmask_i(:,:) == 1._wp )   
385         ze2min = MINVAL( e2t(:,:), mask = tmask_i(:,:) == 1._wp )   
386         ze1max = MAXVAL( e1t(:,:), mask = tmask_i(:,:) == 1._wp )   
387         ze2max = MAXVAL( e2t(:,:), mask = tmask_i(:,:) == 1._wp )   
388
389         iloc  = MINLOC( e1t(:,:), mask = tmask_i(:,:) == 1._wp )
390         iimi1 = iloc(1) + nimpp - 1
391         ijmi1 = iloc(2) + njmpp - 1
392         iloc  = MINLOC( e2t(:,:), mask = tmask_i(:,:) == 1._wp )
393         iimi2 = iloc(1) + nimpp - 1
394         ijmi2 = iloc(2) + njmpp - 1
395         iloc  = MAXLOC( e1t(:,:), mask = tmask_i(:,:) == 1._wp )
396         iima1 = iloc(1) + nimpp - 1
397         ijma1 = iloc(2) + njmpp - 1
398         iloc  = MAXLOC( e2t(:,:), mask = tmask_i(:,:) == 1._wp )
399         iima2 = iloc(1) + nimpp - 1
400         ijma2 = iloc(2) + njmpp - 1
401      ENDIF
402      IF(lwp) THEN
403         WRITE(numout,*)
404         WRITE(numout,*) 'dom_ctl : extrema of the masked scale factors'
405         WRITE(numout,*) '~~~~~~~'
406         WRITE(numout,"(14x,'e1t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1max, iima1, ijma1
407         WRITE(numout,"(14x,'e1t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze1min, iimi1, ijmi1
408         WRITE(numout,"(14x,'e2t maxi: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2max, iima2, ijma2
409         WRITE(numout,"(14x,'e2t mini: ',1f10.2,' at i = ',i5,' j= ',i5)") ze2min, iimi2, ijmi2
410      ENDIF
411      !
412   END SUBROUTINE dom_ctl
413
414   SUBROUTINE dom_stiff
415      !!----------------------------------------------------------------------
416      !!                  ***  ROUTINE dom_stiff  ***
417      !!                     
418      !! ** Purpose :   Diagnose maximum grid stiffness/hydrostatic consistency
419      !!
420      !! ** Method  :   Compute Haney (1991) hydrostatic condition ratio
421      !!                Save the maximum in the vertical direction
422      !!                (this number is only relevant in s-coordinates)
423      !!
424      !!                Haney, R. L., 1991: On the pressure gradient force
425      !!                over steep topography in sigma coordinate ocean models.
426      !!                J. Phys. Oceanogr., 21, 610???619.
427      !!----------------------------------------------------------------------
428      INTEGER  ::   ji, jj, jk 
429      REAL(wp) ::   zrxmax
430      REAL(wp), DIMENSION(4) :: zr1
431      !!----------------------------------------------------------------------
432      rx1(:,:) = 0.e0
433      zrxmax   = 0.e0
434      zr1(:)   = 0.e0
435     
436      DO ji = 2, jpim1
437         DO jj = 2, jpjm1
438            DO jk = 1, jpkm1
439               zr1(1) = umask(ji-1,jj  ,jk) *abs( (gdepw_0(ji  ,jj  ,jk  )-gdepw_0(ji-1,jj  ,jk  )  & 
440                    &                         +gdepw_0(ji  ,jj  ,jk+1)-gdepw_0(ji-1,jj  ,jk+1)) &
441                    &                        /(gdepw_0(ji  ,jj  ,jk  )+gdepw_0(ji-1,jj  ,jk  )  &
442                    &                         -gdepw_0(ji  ,jj  ,jk+1)-gdepw_0(ji-1,jj  ,jk+1) + rsmall) )
443               zr1(2) = umask(ji  ,jj  ,jk) *abs( (gdepw_0(ji+1,jj  ,jk  )-gdepw_0(ji  ,jj  ,jk  )  &
444                    &                         +gdepw_0(ji+1,jj  ,jk+1)-gdepw_0(ji  ,jj  ,jk+1)) &
445                    &                        /(gdepw_0(ji+1,jj  ,jk  )+gdepw_0(ji  ,jj  ,jk  )  &
446                    &                         -gdepw_0(ji+1,jj  ,jk+1)-gdepw_0(ji  ,jj  ,jk+1) + rsmall) )
447               zr1(3) = vmask(ji  ,jj  ,jk) *abs( (gdepw_0(ji  ,jj+1,jk  )-gdepw_0(ji  ,jj  ,jk  )  &
448                    &                         +gdepw_0(ji  ,jj+1,jk+1)-gdepw_0(ji  ,jj  ,jk+1)) &
449                    &                        /(gdepw_0(ji  ,jj+1,jk  )+gdepw_0(ji  ,jj  ,jk  )  &
450                    &                         -gdepw_0(ji  ,jj+1,jk+1)-gdepw_0(ji  ,jj  ,jk+1) + rsmall) )
451               zr1(4) = vmask(ji  ,jj-1,jk) *abs( (gdepw_0(ji  ,jj  ,jk  )-gdepw_0(ji  ,jj-1,jk  )  &
452                    &                         +gdepw_0(ji  ,jj  ,jk+1)-gdepw_0(ji  ,jj-1,jk+1)) &
453                    &                        /(gdepw_0(ji  ,jj  ,jk  )+gdepw_0(ji  ,jj-1,jk  )  &
454                    &                         -gdepw_0(ji,  jj  ,jk+1)-gdepw_0(ji  ,jj-1,jk+1) + rsmall) )
455               zrxmax = MAXVAL(zr1(1:4))
456               rx1(ji,jj) = MAX(rx1(ji,jj), zrxmax)
457            END DO
458         END DO
459      END DO
460
461      CALL lbc_lnk( rx1, 'T', 1. )
462
463      zrxmax = MAXVAL(rx1)
464
465      IF( lk_mpp )   CALL mpp_max( zrxmax ) ! max over the global domain
466
467      IF(lwp) THEN
468         WRITE(numout,*)
469         WRITE(numout,*) 'dom_stiff : maximum grid stiffness ratio: ', zrxmax
470         WRITE(numout,*) '~~~~~~~~~'
471      ENDIF
472
473   END SUBROUTINE dom_stiff
474
475
476
477   !!======================================================================
478END MODULE domain
Note: See TracBrowser for help on using the repository browser.