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

Last change on this file since 12732 was 12732, checked in by techene, 11 months ago

some cleaning and proper module/routine name, mini bug introduced and corrected in sbcice_cice

File size: 19.3 KB
Line 
1MODULE domqco
2   !!======================================================================
3   !!                       ***  MODULE domqco   ***
4   !! Ocean :
5   !!======================================================================
6   !! History :  2.0  !  2006-06  (B. Levier, L. Marie)  original code
7   !!            3.1  !  2009-02  (G. Madec, M. Leclair, R. Benshila)  pure z* coordinate
8   !!            3.3  !  2011-10  (M. Leclair) totally rewrote domvvl: vvl option includes z_star and z_tilde coordinates
9   !!            3.6  !  2014-11  (P. Mathiot) add ice shelf capability
10   !!            4.1  !  2019-08  (A. Coward, D. Storkey) rename dom_vvl_sf_swp -> dom_vvl_sf_update for new timestepping
11   !!            4.x  !  2020-02  (G. Madec, S. Techene) pure z* (quasi-eulerian) coordinate
12   !!----------------------------------------------------------------------
13
14   !!----------------------------------------------------------------------
15   !!   dom_qe_init   : define initial vertical scale factors, depths and column thickness
16   !!   dom_qe_r3c    : Compute ssh/h_0 ratioat t-, u-, v-, and optionally f-points
17   !!       qe_rst_read : read/write restart file
18   !!   dom_qe_ctl    : Check the vvl options
19   !!----------------------------------------------------------------------
20   USE oce            ! ocean dynamics and tracers
21   USE phycst         ! physical constant
22   USE dom_oce        ! ocean space and time domain
23   USE dynadv  , ONLY : ln_dynadv_vec
24   USE isf_oce        ! iceshelf cavities
25   USE sbc_oce        ! ocean surface boundary condition
26   USE wet_dry        ! wetting and drying
27   USE usrdef_istate  ! user defined initial state (wad only)
28   USE restart        ! ocean restart
29   !
30   USE in_out_manager ! I/O manager
31   USE iom            ! I/O manager library
32   USE lib_mpp        ! distributed memory computing library
33   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
34   USE timing         ! Timing
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC  dom_qco_init       ! called by domain.F90
40   PUBLIC  dom_qco_zgr        ! called by isfcpl.F90
41   PUBLIC  dom_qco_r3c        ! called by steplf.F90
42
43   !                                                      !!* Namelist nam_vvl
44   LOGICAL , PUBLIC :: ln_vvl_zstar           = .FALSE.    ! zstar  vertical coordinate
45   LOGICAL , PUBLIC :: ln_vvl_ztilde          = .FALSE.    ! ztilde vertical coordinate
46   LOGICAL , PUBLIC :: ln_vvl_layer           = .FALSE.    ! level  vertical coordinate
47   LOGICAL , PUBLIC :: ln_vvl_ztilde_as_zstar = .FALSE.    ! ztilde vertical coordinate
48   LOGICAL , PUBLIC :: ln_vvl_zstar_at_eqtor  = .FALSE.    ! ztilde vertical coordinate
49   LOGICAL , PUBLIC :: ln_vvl_kepe            = .FALSE.    ! kinetic/potential energy transfer
50   !                                                       ! conservation: not used yet
51   REAL(wp)         :: rn_ahe3                             ! thickness diffusion coefficient
52   REAL(wp)         :: rn_rst_e3t                          ! ztilde to zstar restoration timescale [days]
53   REAL(wp)         :: rn_lf_cutoff                        ! cutoff frequency for low-pass filter  [days]
54   REAL(wp)         :: rn_zdef_max                         ! maximum fractional e3t deformation
55   LOGICAL , PUBLIC :: ln_vvl_dbg = .FALSE.                ! debug control prints
56
57   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: un_td, vn_td                ! thickness diffusion transport
58
59   !! * Substitutions
60#  include "do_loop_substitute.h90"
61   !!----------------------------------------------------------------------
62   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
63   !! $Id: domvvl.F90 12377 2020-02-12 14:39:06Z acc $
64   !! Software governed by the CeCILL license (see ./LICENSE)
65   !!----------------------------------------------------------------------
66CONTAINS
67
68   SUBROUTINE dom_qco_init( Kbb, Kmm, Kaa )
69      !!----------------------------------------------------------------------
70      !!                ***  ROUTINE dom_qco_init  ***
71      !!
72      !! ** Purpose :  Initialization of all ssh. to h._0 ratio
73      !!
74      !! ** Method  :  - use restart file and/or initialize
75      !!               - compute ssh. to h._0 ratio
76      !!
77      !! ** Action  : - r3(t/u/v)_b
78      !!              - r3(t/u/v/f)_n
79      !!
80      !!----------------------------------------------------------------------
81      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
82      !
83      IF(lwp) WRITE(numout,*)
84      IF(lwp) WRITE(numout,*) 'dom_qco_init : Variable volume activated'
85      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~'
86      !
87      CALL dom_qco_ctl     ! choose vertical coordinate (z_star, z_tilde or layer)
88      !
89      !                    ! Read or initialize e3t_(b/n), tilde_e3t_(b/n) and hdiv_lf
90      CALL qe_rst_read( nit000, Kbb, Kmm )
91      !
92      CALL dom_qco_zgr(Kbb, Kmm, Kaa) ! interpolation scale factor, depth and water column
93      !
94      ! IF(lwxios) THEN   ! define variables in restart file when writing with XIOS
95      !    CALL iom_set_rstw_var_active('e3t_b')
96      !    CALL iom_set_rstw_var_active('e3t_n')
97      ! ENDIF
98      !
99   END SUBROUTINE dom_qco_init
100
101
102   SUBROUTINE dom_qco_zgr(Kbb, Kmm, Kaa)
103      !!----------------------------------------------------------------------
104      !!                ***  ROUTINE dom_qco_init  ***
105      !!
106      !! ** Purpose :  Initialization of all ssh. to h._0 ratio
107      !!
108      !! ** Method  :  - interpolate scale factors
109      !!
110      !! ** Action  : - r3(t/u/v)_b
111      !!              - r3(t/u/v/f)_n
112      !!
113      !! Reference  : Leclair, M., and G. Madec, 2011, Ocean Modelling.
114      !!----------------------------------------------------------------------
115      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
116      !!----------------------------------------------------------------------
117      INTEGER ::   ji, jj, jk
118      INTEGER ::   ii0, ii1, ij0, ij1
119      REAL(wp)::   zcoef
120      !!----------------------------------------------------------------------
121      !
122      !                    !== Set of all other vertical scale factors  ==!  (now and before)
123      !                                ! Horizontal interpolation of e3t
124      CALL dom_qco_r3c( ssh(:,:,Kbb), r3t(:,:,Kbb), r3u(:,:,Kbb), r3v(:,:,Kbb) )
125      CALL dom_qco_r3c( ssh(:,:,Kmm), r3t(:,:,Kmm), r3u(:,:,Kmm), r3v(:,:,Kmm), r3f(:,:) )
126      !
127   END SUBROUTINE dom_qco_zgr
128
129
130   SUBROUTINE dom_qco_r3c( pssh, pr3t, pr3u, pr3v, pr3f )
131      !!---------------------------------------------------------------------
132      !!                   ***  ROUTINE r3c  ***
133      !!
134      !! ** Purpose :   compute the filtered ratio ssh/h_0 at t-,u-,v-,f-points
135      !!
136      !! ** Method  : - compute the ssh at u- and v-points (f-point optional)
137      !!                   Vector Form : surface weighted averaging
138      !!                   Flux   Form : simple           averaging
139      !!              - compute the ratio ssh/h_0 at t-,u-,v-pts, (f-pt optional)
140      !!----------------------------------------------------------------------
141      REAL(wp), DIMENSION(:,:)          , INTENT(in   )  ::   pssh               ! sea surface height   [m]
142      REAL(wp), DIMENSION(:,:)          , INTENT(  out)  ::   pr3t, pr3u, pr3v   ! ssh/h0 ratio at t-, u-, v-,points  [-]
143      REAL(wp), DIMENSION(:,:), OPTIONAL, INTENT(  out)  ::   pr3f               ! ssh/h0 ratio at f-point   [-]
144      !
145      INTEGER ::   ji, jj   ! dummy loop indices
146      !!----------------------------------------------------------------------
147      !
148      !
149      pr3t(:,:) = pssh(:,:) * r1_ht_0(:,:)   !==  ratio at t-point  ==!
150      !
151      !
152      !                                      !==  ratio at u-,v-point  ==!
153      !
154      IF( ln_dynadv_vec ) THEN                     !- Vector Form   (thickness weighted averaging)
155         DO_2D_00_00
156            pr3u(ji,jj) = 0.5_wp * (  e1e2t(ji  ,jj) * pssh(ji  ,jj)  &
157               &                    + e1e2t(ji+1,jj) * pssh(ji+1,jj)  ) * r1_hu_0(ji,jj) * r1_e1e2u(ji,jj)
158            pr3v(ji,jj) = 0.5_wp * (  e1e2t(ji,jj  ) * pssh(ji,jj  )  &
159               &                    + e1e2t(ji,jj+1) * pssh(ji,jj+1)  ) * r1_hv_0(ji,jj) * r1_e1e2v(ji,jj)
160         END_2D
161      ELSE                                         !- Flux Form   (simple averaging)
162         DO_2D_00_00
163            pr3u(ji,jj) = 0.5_wp * (  pssh(ji  ,jj) + pssh(ji+1,jj)  ) * r1_hu_0(ji,jj)
164            pr3v(ji,jj) = 0.5_wp * (  pssh(ji,jj  ) + pssh(ji,jj+1)  ) * r1_hv_0(ji,jj)
165         END_2D
166      ENDIF
167      !
168      IF( .NOT.PRESENT( pr3f ) ) THEN              !- lbc on ratio at u-, v-points only
169         CALL lbc_lnk_multi( 'dom_qco_r3c', pr3u, 'U', 1._wp, pr3v, 'V', 1._wp )
170         !
171         !
172      ELSE                                   !==  ratio at f-point  ==!
173         !
174         IF( ln_dynadv_vec )   THEN                !- Vector Form   (thickness weighted averaging)
175            DO_2D_10_10                               ! start from 1 since lbc_lnk('F') doesn't update the 1st row/line
176               pr3f(ji,jj) = 0.25_wp * (  e1e2t(ji  ,jj  ) * pssh(ji  ,jj  )  &
177                  &                     + e1e2t(ji+1,jj  ) * pssh(ji+1,jj  )  &
178                  &                     + e1e2t(ji  ,jj+1) * pssh(ji  ,jj+1)  &
179                  &                     + e1e2t(ji+1,jj+1) * pssh(ji+1,jj+1)  ) * r1_hf_0(ji,jj) * r1_e1e2f(ji,jj)
180            END_2D
181         ELSE                                      !- Flux Form   (simple averaging)
182            DO_2D_10_10                               ! start from 1 since lbc_lnk('F') doesn't update the 1st row/line
183               pr3f(ji,jj) = 0.25_wp * (  pssh(ji  ,jj  ) + pssh(ji+1,jj  )  &
184                  &                     + pssh(ji  ,jj+1) + pssh(ji+1,jj+1)  ) * r1_hf_0(ji,jj)
185            END_2D
186         ENDIF
187         !                                                 ! lbc on ratio at u-,v-,f-points
188         CALL lbc_lnk_multi( 'dom_qco_r3c', pr3u, 'U', 1._wp, pr3v, 'V', 1._wp, pr3f, 'F', 1._wp )
189         !
190      ENDIF
191      !
192   END SUBROUTINE dom_qco_r3c
193
194
195   SUBROUTINE qe_rst_read( kt, Kbb, Kmm )
196      !!---------------------------------------------------------------------
197      !!                   ***  ROUTINE qe_rst_read  ***
198      !!
199      !! ** Purpose :   Read ssh in restart file
200      !!
201      !! ** Method  :   use of IOM library
202      !!                if the restart does not contain ssh,
203      !!                it is set to the _0 values.
204      !!----------------------------------------------------------------------
205      INTEGER         , INTENT(in) ::   kt        ! ocean time-step
206      INTEGER         , INTENT(in) ::   Kbb, Kmm  ! ocean time level indices
207      !
208      INTEGER ::   ji, jj, jk
209      INTEGER ::   id1, id2     ! local integers
210      !!----------------------------------------------------------------------
211      !
212         IF( ln_rstart ) THEN                   !* Read the restart file
213            CALL rst_read_open                  !  open the restart file if necessary
214            !
215            id1 = iom_varid( numror, 'sshb', ldstop = .FALSE. )
216            id2 = iom_varid( numror, 'sshn', ldstop = .FALSE. )
217            !
218            !                             ! --------- !
219            !                             ! all cases !
220            !                             ! --------- !
221            !
222            IF( MIN( id1, id2 ) > 0 ) THEN       ! all required arrays exist
223               CALL iom_get( numror, jpdom_autoglo, 'sshb'   , ssh(:,:,Kbb), ldxios = lrxios    )
224               CALL iom_get( numror, jpdom_autoglo, 'sshn'   , ssh(:,:,Kmm), ldxios = lrxios    )
225               ! needed to restart if land processor not computed
226               IF(lwp) write(numout,*) 'qe_rst_read : ssh(:,:,Kbb) and ssh(:,:,Kmm) found in restart files'
227               WHERE ( ssmask(:,:) == 0.0_wp )   !!gm/st ==> sm should not be necessary on ssh when it was required on e3
228                  ssh(:,:,Kmm) = 0._wp
229                  ssh(:,:,Kbb) = 0._wp
230               END WHERE
231               IF( l_1st_euler ) THEN
232                  ssh(:,:,Kbb) = ssh(:,:,Kmm)
233               ENDIF
234            ELSE IF( id1 > 0 ) THEN
235               IF(lwp) write(numout,*) 'qe_rst_read WARNING : ssh(:,:,Kmm) not found in restart files'
236               IF(lwp) write(numout,*) 'sshn set equal to sshb.'
237               IF(lwp) write(numout,*) 'neuler is forced to 0'
238               CALL iom_get( numror, jpdom_autoglo, 'sshb', ssh(:,:,Kbb), ldxios = lrxios )
239               ssh(:,:,Kmm) = ssh(:,:,Kbb)
240               l_1st_euler = .TRUE.
241            ELSE IF( id2 > 0 ) THEN
242               IF(lwp) write(numout,*) 'qe_rst_read WARNING : ssh(:,:,Kbb) not found in restart files'
243               IF(lwp) write(numout,*) 'sshb set equal to sshn.'
244               IF(lwp) write(numout,*) 'neuler is forced to 0'
245               CALL iom_get( numror, jpdom_autoglo, 'sshn', ssh(:,:,Kmm), ldxios = lrxios )
246               ssh(:,:,Kbb) = ssh(:,:,Kmm)
247               l_1st_euler = .TRUE.
248            ELSE
249               IF(lwp) write(numout,*) 'qe_rst_read WARNING : ssh(:,:,Kmm) not found in restart file'
250               IF(lwp) write(numout,*) 'ssh_b and ssh_n set to zero'
251               IF(lwp) write(numout,*) 'neuler is forced to 0'
252               ssh(:,:,:) = 0._wp
253               l_1st_euler = .TRUE.
254            ENDIF
255            !
256         ELSE                                   !* Initialize at "rest"
257            !
258            IF( ll_wd ) THEN   ! MJB ll_wd edits start here - these are essential
259               !
260               IF( cn_cfg == 'wad' ) THEN            ! Wetting and drying test case
261                  CALL usr_def_istate( gdept(:,:,:,Kbb), tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb)  )
262                  ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb)       ! set now values from to before ones
263                  ssh(:,:    ,Kmm) = ssh(:,:    ,Kbb)
264                  uu (:,:,:  ,Kmm) = uu (:,:,:  ,Kbb)
265                  vv (:,:,:  ,Kmm) = vv (:,:,:  ,Kbb)
266               ELSE                                  ! if not test case
267                  ssh(:,:,Kmm) = -ssh_ref
268                  ssh(:,:,Kbb) = -ssh_ref
269                  !
270                  DO_2D_11_11
271                     IF( ht_0(ji,jj)-ssh_ref <  rn_wdmin1 ) THEN ! if total depth is less than min depth
272                        ssh(ji,jj,Kbb) = rn_wdmin1 - (ht_0(ji,jj) )
273                        ssh(ji,jj,Kmm) = rn_wdmin1 - (ht_0(ji,jj) )
274                     ENDIF
275                  END_2D
276               ENDIF
277
278               DO ji = 1, jpi
279                  DO jj = 1, jpj
280                     IF ( ht_0(ji,jj) .LE. 0.0 .AND. NINT( ssmask(ji,jj) ) .EQ. 1) THEN
281                       CALL ctl_stop( 'qe_rst_read: ht_0 must be positive at potentially wet points' )
282                     ENDIF
283                  END DO
284               END DO
285               !
286            ELSE
287               !
288               ! Just to read set ssh in fact, called latter once vertical grid
289               ! is set up:
290!               CALL usr_def_istate( gdept_0, tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb)  )
291!               !
292                ssh(:,:,:) = 0._wp
293               !
294            ENDIF           ! end of ll_wd edits
295            !
296         ENDIF
297      !
298   END SUBROUTINE qe_rst_read
299
300
301   SUBROUTINE dom_qco_ctl
302      !!---------------------------------------------------------------------
303      !!                  ***  ROUTINE dom_qco_ctl  ***
304      !!
305      !! ** Purpose :   Control the consistency between namelist options
306      !!                for vertical coordinate
307      !!----------------------------------------------------------------------
308      INTEGER ::   ioptio, ios
309      !!
310      NAMELIST/nam_vvl/ ln_vvl_zstar, ln_vvl_ztilde, ln_vvl_layer, ln_vvl_ztilde_as_zstar, &
311         &              ln_vvl_zstar_at_eqtor      , rn_ahe3     , rn_rst_e3t            , &
312         &              rn_lf_cutoff               , rn_zdef_max , ln_vvl_dbg                ! not yet implemented: ln_vvl_kepe
313      !!----------------------------------------------------------------------
314      !
315      READ  ( numnam_ref, nam_vvl, IOSTAT = ios, ERR = 901)
316901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'nam_vvl in reference namelist' )
317      READ  ( numnam_cfg, nam_vvl, IOSTAT = ios, ERR = 902 )
318902   IF( ios >  0 ) CALL ctl_nam ( ios , 'nam_vvl in configuration namelist' )
319      IF(lwm) WRITE ( numond, nam_vvl )
320      !
321      IF(lwp) THEN                    ! Namelist print
322         WRITE(numout,*)
323         WRITE(numout,*) 'dom_qco_ctl : choice/control of the variable vertical coordinate'
324         WRITE(numout,*) '~~~~~~~~~~~'
325         WRITE(numout,*) '   Namelist nam_vvl : chose a vertical coordinate'
326         WRITE(numout,*) '      zstar                      ln_vvl_zstar   = ', ln_vvl_zstar
327         WRITE(numout,*) '      ztilde                     ln_vvl_ztilde  = ', ln_vvl_ztilde
328         WRITE(numout,*) '      layer                      ln_vvl_layer   = ', ln_vvl_layer
329         WRITE(numout,*) '      ztilde as zstar   ln_vvl_ztilde_as_zstar  = ', ln_vvl_ztilde_as_zstar
330         WRITE(numout,*) '      ztilde near the equator    ln_vvl_zstar_at_eqtor  = ', ln_vvl_zstar_at_eqtor
331         WRITE(numout,*) '      !'
332         WRITE(numout,*) '      thickness diffusion coefficient                      rn_ahe3      = ', rn_ahe3
333         WRITE(numout,*) '      maximum e3t deformation fractional change            rn_zdef_max  = ', rn_zdef_max
334         IF( ln_vvl_ztilde_as_zstar ) THEN
335            WRITE(numout,*) '      ztilde running in zstar emulation mode (ln_vvl_ztilde_as_zstar=T) '
336            WRITE(numout,*) '         ignoring namelist timescale parameters and using:'
337            WRITE(numout,*) '            hard-wired : z-tilde to zstar restoration timescale (days)'
338            WRITE(numout,*) '                         rn_rst_e3t     = 0.e0'
339            WRITE(numout,*) '            hard-wired : z-tilde cutoff frequency of low-pass filter (days)'
340            WRITE(numout,*) '                         rn_lf_cutoff   = 1.0/rn_Dt'
341         ELSE
342            WRITE(numout,*) '      z-tilde to zstar restoration timescale (days)        rn_rst_e3t   = ', rn_rst_e3t
343            WRITE(numout,*) '      z-tilde cutoff frequency of low-pass filter (days)   rn_lf_cutoff = ', rn_lf_cutoff
344         ENDIF
345         WRITE(numout,*) '         debug prints flag                                 ln_vvl_dbg   = ', ln_vvl_dbg
346      ENDIF
347      !
348      ioptio = 0                      ! Parameter control
349      IF( ln_vvl_ztilde_as_zstar )   ln_vvl_ztilde = .true.
350      IF( ln_vvl_zstar           )   ioptio = ioptio + 1
351      IF( ln_vvl_ztilde          )   ioptio = ioptio + 1
352      IF( ln_vvl_layer           )   ioptio = ioptio + 1
353      !
354      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE vertical coordinate in namelist nam_vvl' )
355      !
356      IF(lwp) THEN                   ! Print the choice
357         WRITE(numout,*)
358         IF( ln_vvl_zstar           ) WRITE(numout,*) '      ==>>>   zstar vertical coordinate is used'
359         IF( ln_vvl_ztilde          ) WRITE(numout,*) '      ==>>>   ztilde vertical coordinate is used'
360         IF( ln_vvl_layer           ) WRITE(numout,*) '      ==>>>   layer vertical coordinate is used'
361         IF( ln_vvl_ztilde_as_zstar ) WRITE(numout,*) '      ==>>>   to emulate a zstar coordinate'
362      ENDIF
363      !
364#if defined key_agrif
365      IF( (.NOT.Agrif_Root()).AND.(.NOT.ln_vvl_zstar) )   CALL ctl_stop( 'AGRIF is implemented with zstar coordinate only' )
366#endif
367      !
368   END SUBROUTINE dom_qco_ctl
369
370   !!======================================================================
371END MODULE domqco
Note: See TracBrowser for help on using the repository browser.