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.
domvvl.F90 in NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/src/OCE/DOM – NEMO

source: NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/src/OCE/DOM/domvvl.F90 @ 13159

Last change on this file since 13159 was 13159, checked in by gsamson, 4 years ago

merge trunk@r13136 into ASINTER-06 branch; pass all SETTE tests; results identical to trunk@r13136; ticket #2419

  • Property svn:keywords set to Id
File size: 55.3 KB
RevLine 
[592]1MODULE domvvl
2   !!======================================================================
3   !!                       ***  MODULE domvvl   ***
4   !! Ocean :
5   !!======================================================================
[1438]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
[9019]8   !!            3.3  !  2011-10  (M. Leclair) totally rewrote domvvl: vvl option includes z_star and z_tilde coordinates
[5120]9   !!            3.6  !  2014-11  (P. Mathiot) add ice shelf capability
[12377]10   !!            4.1  !  2019-08  (A. Coward, D. Storkey) rename dom_vvl_sf_swp -> dom_vvl_sf_update for new timestepping
[592]11   !!----------------------------------------------------------------------
[5836]12
[592]13   !!----------------------------------------------------------------------
[4292]14   !!   dom_vvl_init     : define initial vertical scale factors, depths and column thickness
15   !!   dom_vvl_sf_nxt   : Compute next vertical scale factors
[12377]16   !!   dom_vvl_sf_update   : Swap vertical scale factors and update the vertical grid
[4292]17   !!   dom_vvl_interpol : Interpolate vertical scale factors from one grid point to another
18   !!   dom_vvl_rst      : read/write restart file
19   !!   dom_vvl_ctl      : Check the vvl options
20   !!----------------------------------------------------------------------
[592]21   USE oce             ! ocean dynamics and tracers
[6140]22   USE phycst          ! physical constant
[592]23   USE dom_oce         ! ocean space and time domain
[4292]24   USE sbc_oce         ! ocean surface boundary condition
[6152]25   USE wet_dry         ! wetting and drying
[7646]26   USE usrdef_istate   ! user defined initial state (wad only)
[6140]27   USE restart         ! ocean restart
28   !
[592]29   USE in_out_manager  ! I/O manager
[4292]30   USE iom             ! I/O manager library
[592]31   USE lib_mpp         ! distributed memory computing library
32   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
[3294]33   USE timing          ! Timing
[592]34
35   IMPLICIT NONE
36   PRIVATE
37
[4292]38   PUBLIC  dom_vvl_init       ! called by domain.F90
[12377]39   PUBLIC  dom_vvl_zgr        ! called by isfcpl.F90
[4292]40   PUBLIC  dom_vvl_sf_nxt     ! called by step.F90
[12377]41   PUBLIC  dom_vvl_sf_update  ! called by step.F90
[4292]42   PUBLIC  dom_vvl_interpol   ! called by dynnxt.F90
[592]43
[5836]44   !                                                      !!* Namelist nam_vvl
45   LOGICAL , PUBLIC :: ln_vvl_zstar           = .FALSE.    ! zstar  vertical coordinate
46   LOGICAL , PUBLIC :: ln_vvl_ztilde          = .FALSE.    ! ztilde vertical coordinate
47   LOGICAL , PUBLIC :: ln_vvl_layer           = .FALSE.    ! level  vertical coordinate
48   LOGICAL , PUBLIC :: ln_vvl_ztilde_as_zstar = .FALSE.    ! ztilde vertical coordinate
49   LOGICAL , PUBLIC :: ln_vvl_zstar_at_eqtor  = .FALSE.    ! ztilde vertical coordinate
50   LOGICAL , PUBLIC :: ln_vvl_kepe            = .FALSE.    ! kinetic/potential energy transfer
51   !                                                       ! conservation: not used yet
52   REAL(wp)         :: rn_ahe3                             ! thickness diffusion coefficient
53   REAL(wp)         :: rn_rst_e3t                          ! ztilde to zstar restoration timescale [days]
54   REAL(wp)         :: rn_lf_cutoff                        ! cutoff frequency for low-pass filter  [days]
55   REAL(wp)         :: rn_zdef_max                         ! maximum fractional e3t deformation
56   LOGICAL , PUBLIC :: ln_vvl_dbg = .FALSE.                ! debug control prints
[592]57
[5836]58   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: un_td, vn_td                ! thickness diffusion transport
59   REAL(wp)        , ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdiv_lf                     ! low frequency part of hz divergence
60   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tilde_e3t_b, tilde_e3t_n    ! baroclinic scale factors
61   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tilde_e3t_a, dtilde_e3t_a   ! baroclinic scale factors
62   REAL(wp)        , ALLOCATABLE, SAVE, DIMENSION(:,:)   :: frq_rst_e3t                 ! retoring period for scale factors
63   REAL(wp)        , ALLOCATABLE, SAVE, DIMENSION(:,:)   :: frq_rst_hdv                 ! retoring period for low freq. divergence
[1438]64
[592]65   !! * Substitutions
[12377]66#  include "do_loop_substitute.h90"
[592]67   !!----------------------------------------------------------------------
[10068]68   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[888]69   !! $Id$
[10068]70   !! Software governed by the CeCILL license (see ./LICENSE)
[592]71   !!----------------------------------------------------------------------
[4292]72CONTAINS
73
[2715]74   INTEGER FUNCTION dom_vvl_alloc()
75      !!----------------------------------------------------------------------
[4292]76      !!                ***  FUNCTION dom_vvl_alloc  ***
[2715]77      !!----------------------------------------------------------------------
[6140]78      IF( ln_vvl_zstar )   dom_vvl_alloc = 0
[4292]79      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
[4338]80         ALLOCATE( tilde_e3t_b(jpi,jpj,jpk)  , tilde_e3t_n(jpi,jpj,jpk) , tilde_e3t_a(jpi,jpj,jpk) ,   &
81            &      dtilde_e3t_a(jpi,jpj,jpk) , un_td  (jpi,jpj,jpk)     , vn_td  (jpi,jpj,jpk)     ,   &
82            &      STAT = dom_vvl_alloc        )
[10425]83         CALL mpp_sum ( 'domvvl', dom_vvl_alloc )
84         IF( dom_vvl_alloc /= 0 )   CALL ctl_stop( 'STOP', 'dom_vvl_alloc: failed to allocate arrays' )
[6140]85         un_td = 0._wp
86         vn_td = 0._wp
[4292]87      ENDIF
88      IF( ln_vvl_ztilde ) THEN
89         ALLOCATE( frq_rst_e3t(jpi,jpj) , frq_rst_hdv(jpi,jpj) , hdiv_lf(jpi,jpj,jpk) , STAT= dom_vvl_alloc )
[10425]90         CALL mpp_sum ( 'domvvl', dom_vvl_alloc )
91         IF( dom_vvl_alloc /= 0 )   CALL ctl_stop( 'STOP', 'dom_vvl_alloc: failed to allocate arrays' )
[4292]92      ENDIF
[6140]93      !
[2715]94   END FUNCTION dom_vvl_alloc
95
96
[12377]97   SUBROUTINE dom_vvl_init( Kbb, Kmm, Kaa )
[592]98      !!----------------------------------------------------------------------
[4292]99      !!                ***  ROUTINE dom_vvl_init  ***
[592]100      !!                   
[4292]101      !! ** Purpose :  Initialization of all scale factors, depths
102      !!               and water column heights
103      !!
104      !! ** Method  :  - use restart file and/or initialize
105      !!               - interpolate scale factors
106      !!
[6140]107      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b)
[12377]108      !!              - Regrid: e3[u/v](:,:,:,Kmm)
109      !!                        e3[u/v](:,:,:,Kmm)       
110      !!                        e3w(:,:,:,Kmm)           
111      !!                        e3[u/v]w_b
112      !!                        e3[u/v]w_n     
113      !!                        gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm) and gde3w
[4292]114      !!              - h(t/u/v)_0
115      !!              - frq_rst_e3t and frq_rst_hdv
116      !!
117      !! Reference  : Leclair, M., and G. Madec, 2011, Ocean Modelling.
[592]118      !!----------------------------------------------------------------------
[12377]119      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
[6140]120      !
[4292]121      IF(lwp) WRITE(numout,*)
122      IF(lwp) WRITE(numout,*) 'dom_vvl_init : Variable volume activated'
123      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~'
[6140]124      !
125      CALL dom_vvl_ctl     ! choose vertical coordinate (z_star, z_tilde or layer)
126      !
127      !                    ! Allocate module arrays
[4292]128      IF( dom_vvl_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'dom_vvl_init : unable to allocate arrays' )
[6140]129      !
130      !                    ! Read or initialize e3t_(b/n), tilde_e3t_(b/n) and hdiv_lf
[12377]131      CALL dom_vvl_rst( nit000, Kbb, Kmm, 'READ' )
132      e3t(:,:,jpk,Kaa) = e3t_0(:,:,jpk)  ! last level always inside the sea floor set one for all
[6140]133      !
[12377]134      CALL dom_vvl_zgr(Kbb, Kmm, Kaa) ! interpolation scale factor, depth and water column
135      !
136   END SUBROUTINE dom_vvl_init
137   !
138   SUBROUTINE dom_vvl_zgr(Kbb, Kmm, Kaa)
139      !!----------------------------------------------------------------------
140      !!                ***  ROUTINE dom_vvl_init  ***
141      !!                   
142      !! ** Purpose :  Interpolation of all scale factors,
143      !!               depths and water column heights
144      !!
145      !! ** Method  :  - interpolate scale factors
146      !!
147      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b)
148      !!              - Regrid: e3(u/v)_n
149      !!                        e3(u/v)_b       
150      !!                        e3w_n           
151      !!                        e3(u/v)w_b     
152      !!                        e3(u/v)w_n     
153      !!                        gdept_n, gdepw_n and gde3w_n
154      !!              - h(t/u/v)_0
155      !!              - frq_rst_e3t and frq_rst_hdv
156      !!
157      !! Reference  : Leclair, M., and G. Madec, 2011, Ocean Modelling.
158      !!----------------------------------------------------------------------
159      INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
160      !!----------------------------------------------------------------------
161      INTEGER ::   ji, jj, jk
162      INTEGER ::   ii0, ii1, ij0, ij1
163      REAL(wp)::   zcoef
164      !!----------------------------------------------------------------------
165      !
[6140]166      !                    !== Set of all other vertical scale factors  ==!  (now and before)
167      !                                ! Horizontal interpolation of e3t
[12377]168      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3u(:,:,:,Kbb), 'U' )    ! from T to U
169      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3u(:,:,:,Kmm), 'U' )
170      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3v(:,:,:,Kbb), 'V' )    ! from T to V
171      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3v(:,:,:,Kmm), 'V' )
172      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F' )    ! from U to F
[6140]173      !                                ! Vertical interpolation of e3t,u,v
[12377]174      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3w (:,:,:,Kmm), 'W'  )  ! from T to W
175      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3w (:,:,:,Kbb), 'W'  )
176      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3uw(:,:,:,Kmm), 'UW' )  ! from U to UW
177      CALL dom_vvl_interpol( e3u(:,:,:,Kbb), e3uw(:,:,:,Kbb), 'UW' )
178      CALL dom_vvl_interpol( e3v(:,:,:,Kmm), e3vw(:,:,:,Kmm), 'VW' )  ! from V to UW
179      CALL dom_vvl_interpol( e3v(:,:,:,Kbb), e3vw(:,:,:,Kbb), 'VW' )
[9449]180
181      ! We need to define e3[tuv]_a for AGRIF initialisation (should not be a problem for the restartability...)
[12377]182      e3t(:,:,:,Kaa) = e3t(:,:,:,Kmm)
183      e3u(:,:,:,Kaa) = e3u(:,:,:,Kmm)
184      e3v(:,:,:,Kaa) = e3v(:,:,:,Kmm)
[6140]185      !
186      !                    !==  depth of t and w-point  ==!   (set the isf depth as it is in the initial timestep)
[12377]187      gdept(:,:,1,Kmm) = 0.5_wp * e3w(:,:,1,Kmm)       ! reference to the ocean surface (used for MLD and light penetration)
188      gdepw(:,:,1,Kmm) = 0.0_wp
189      gde3w(:,:,1) = gdept(:,:,1,Kmm) - ssh(:,:,Kmm)  ! reference to a common level z=0 for hpg
190      gdept(:,:,1,Kbb) = 0.5_wp * e3w(:,:,1,Kbb)
191      gdepw(:,:,1,Kbb) = 0.0_wp
192      DO_3D_11_11( 2, jpk )
193         !    zcoef = tmask - wmask    ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt
194         !                             ! 1 everywhere from mbkt to mikt + 1 or 1 (if no isf)
195         !                             ! 0.5 where jk = mikt     
196!!gm ???????   BUG ?  gdept(:,:,:,Kmm) as well as gde3w  does not include the thickness of ISF ??
197         zcoef = ( tmask(ji,jj,jk) - wmask(ji,jj,jk) )
198         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm)
199         gdept(ji,jj,jk,Kmm) =      zcoef  * ( gdepw(ji,jj,jk  ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm))  &
200            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm)) 
201         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm)
202         gdepw(ji,jj,jk,Kbb) = gdepw(ji,jj,jk-1,Kbb) + e3t(ji,jj,jk-1,Kbb)
203         gdept(ji,jj,jk,Kbb) =      zcoef  * ( gdepw(ji,jj,jk  ,Kbb) + 0.5 * e3w(ji,jj,jk,Kbb))  &
204            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kbb) +       e3w(ji,jj,jk,Kbb)) 
205      END_3D
[6140]206      !
207      !                    !==  thickness of the water column  !!   (ocean portion only)
[12377]208      ht(:,:) = e3t(:,:,1,Kmm) * tmask(:,:,1)   !!gm  BUG  :  this should be 1/2 * e3w(k=1) ....
209      hu(:,:,Kbb) = e3u(:,:,1,Kbb) * umask(:,:,1)
210      hu(:,:,Kmm) = e3u(:,:,1,Kmm) * umask(:,:,1)
211      hv(:,:,Kbb) = e3v(:,:,1,Kbb) * vmask(:,:,1)
212      hv(:,:,Kmm) = e3v(:,:,1,Kmm) * vmask(:,:,1)
[6140]213      DO jk = 2, jpkm1
[12377]214         ht(:,:) = ht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
215         hu(:,:,Kbb) = hu(:,:,Kbb) + e3u(:,:,jk,Kbb) * umask(:,:,jk)
216         hu(:,:,Kmm) = hu(:,:,Kmm) + e3u(:,:,jk,Kmm) * umask(:,:,jk)
217         hv(:,:,Kbb) = hv(:,:,Kbb) + e3v(:,:,jk,Kbb) * vmask(:,:,jk)
218         hv(:,:,Kmm) = hv(:,:,Kmm) + e3v(:,:,jk,Kmm) * vmask(:,:,jk)
[4370]219      END DO
[6140]220      !
221      !                    !==  inverse of water column thickness   ==!   (u- and v- points)
[12377]222      r1_hu(:,:,Kbb) = ssumask(:,:) / ( hu(:,:,Kbb) + 1._wp - ssumask(:,:) )    ! _i mask due to ISF
223      r1_hu(:,:,Kmm) = ssumask(:,:) / ( hu(:,:,Kmm) + 1._wp - ssumask(:,:) )
224      r1_hv(:,:,Kbb) = ssvmask(:,:) / ( hv(:,:,Kbb) + 1._wp - ssvmask(:,:) )
225      r1_hv(:,:,Kmm) = ssvmask(:,:) / ( hv(:,:,Kmm) + 1._wp - ssvmask(:,:) )
[7753]226
[6140]227      !                    !==   z_tilde coordinate case  ==!   (Restoring frequencies)
[4292]228      IF( ln_vvl_ztilde ) THEN
[6140]229!!gm : idea: add here a READ in a file of custumized restoring frequency
230         !                                   ! Values in days provided via the namelist
231         !                                   ! use rsmall to avoid possible division by zero errors with faulty settings
[7753]232         frq_rst_e3t(:,:) = 2._wp * rpi / ( MAX( rn_rst_e3t  , rsmall ) * 86400.0_wp )
233         frq_rst_hdv(:,:) = 2._wp * rpi / ( MAX( rn_lf_cutoff, rsmall ) * 86400.0_wp )
[6140]234         !
235         IF( ln_vvl_ztilde_as_zstar ) THEN   ! z-star emulation using z-tile
[7753]236            frq_rst_e3t(:,:) = 0._wp               !Ignore namelist settings
[12489]237            frq_rst_hdv(:,:) = 1._wp / rn_Dt
[4292]238         ENDIF
[6140]239         IF ( ln_vvl_zstar_at_eqtor ) THEN   ! use z-star in vicinity of the Equator
[12377]240            DO_2D_11_11
[6140]241!!gm  case |gphi| >= 6 degrees is useless   initialized just above by default
[12377]242               IF( ABS(gphit(ji,jj)) >= 6.) THEN
243                  ! values outside the equatorial band and transition zone (ztilde)
244                  frq_rst_e3t(ji,jj) =  2.0_wp * rpi / ( MAX( rn_rst_e3t  , rsmall ) * 86400.e0_wp )
245                  frq_rst_hdv(ji,jj) =  2.0_wp * rpi / ( MAX( rn_lf_cutoff, rsmall ) * 86400.e0_wp )
246               ELSEIF( ABS(gphit(ji,jj)) <= 2.5) THEN    ! Equator strip ==> z-star
247                  ! values inside the equatorial band (ztilde as zstar)
248                  frq_rst_e3t(ji,jj) =  0.0_wp
[12489]249                  frq_rst_hdv(ji,jj) =  1.0_wp / rn_Dt
[12377]250               ELSE                                      ! transition band (2.5 to 6 degrees N/S)
251                  !                                      ! (linearly transition from z-tilde to z-star)
252                  frq_rst_e3t(ji,jj) = 0.0_wp + (frq_rst_e3t(ji,jj)-0.0_wp)*0.5_wp   &
253                     &            * (  1.0_wp - COS( rad*(ABS(gphit(ji,jj))-2.5_wp)  &
254                     &                                          * 180._wp / 3.5_wp ) )
[12489]255                  frq_rst_hdv(ji,jj) = (1.0_wp / rn_Dt)                                &
256                     &            + (  frq_rst_hdv(ji,jj)-(1.e0_wp / rn_Dt) )*0.5_wp   &
[12377]257                     &            * (  1._wp  - COS( rad*(ABS(gphit(ji,jj))-2.5_wp)  &
258                     &                                          * 180._wp / 3.5_wp ) )
259               ENDIF
260            END_2D
[10213]261            IF( cn_cfg == "orca" .OR. cn_cfg == "ORCA" ) THEN
262               IF( nn_cfg == 3 ) THEN   ! ORCA2: Suppress ztilde in the Foxe Basin for ORCA2
263                  ii0 = 103   ;   ii1 = 111       
264                  ij0 = 128   ;   ij1 = 135   ;   
265                  frq_rst_e3t( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) =  0.0_wp
[12489]266                  frq_rst_hdv( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) =  1.e0_wp / rn_Dt
[10213]267               ENDIF
[4292]268            ENDIF
269         ENDIF
270      ENDIF
[6140]271      !
[9367]272      IF(lwxios) THEN
273! define variables in restart file when writing with XIOS
274         CALL iom_set_rstw_var_active('e3t_b')
275         CALL iom_set_rstw_var_active('e3t_n')
276         !                                           ! ----------------------- !
277         IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN  ! z_tilde and layer cases !
278            !                                        ! ----------------------- !
279            CALL iom_set_rstw_var_active('tilde_e3t_b')
280            CALL iom_set_rstw_var_active('tilde_e3t_n')
281         END IF
282         !                                           ! -------------!   
283         IF( ln_vvl_ztilde ) THEN                    ! z_tilde case !
284            !                                        ! ------------ !
285            CALL iom_set_rstw_var_active('hdiv_lf')
286         ENDIF
287         !
288      ENDIF
289      !
[12377]290   END SUBROUTINE dom_vvl_zgr
[4292]291
292
[12377]293   SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall ) 
[4292]294      !!----------------------------------------------------------------------
295      !!                ***  ROUTINE dom_vvl_sf_nxt  ***
296      !!                   
297      !! ** Purpose :  - compute the after scale factors used in tra_zdf, dynnxt,
298      !!                 tranxt and dynspg routines
299      !!
300      !! ** Method  :  - z_star case:  Repartition of ssh INCREMENT proportionnaly to the level thickness.
301      !!               - z_tilde_case: after scale factor increment =
302      !!                                    high frequency part of horizontal divergence
303      !!                                  + retsoring towards the background grid
304      !!                                  + thickness difusion
305      !!                               Then repartition of ssh INCREMENT proportionnaly
306      !!                               to the "baroclinic" level thickness.
307      !!
308      !! ** Action  :  - hdiv_lf    : restoring towards full baroclinic divergence in z_tilde case
309      !!               - tilde_e3t_a: after increment of vertical scale factor
310      !!                              in z_tilde case
[6140]311      !!               - e3(t/u/v)_a
[4292]312      !!
313      !! Reference  : Leclair, M., and Madec, G. 2011, Ocean Modelling.
314      !!----------------------------------------------------------------------
[12377]315      INTEGER, INTENT( in )           ::   kt             ! time step
316      INTEGER, INTENT( in )           ::   Kbb, Kmm, Kaa  ! time step
317      INTEGER, INTENT( in ), OPTIONAL ::   kcall          ! optional argument indicating call sequence
[6140]318      !
319      INTEGER                ::   ji, jj, jk            ! dummy loop indices
320      INTEGER , DIMENSION(3) ::   ijk_max, ijk_min      ! temporary integers
[12489]321      REAL(wp)               ::   z_tmin, z_tmax        ! local scalars
[6140]322      LOGICAL                ::   ll_do_bclinic         ! local logical
[9019]323      REAL(wp), DIMENSION(jpi,jpj)     ::   zht, z_scale, zwu, zwv, zhdiv
324      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   ze3t
[4292]325      !!----------------------------------------------------------------------
[6140]326      !
327      IF( ln_linssh )   RETURN      ! No calculation in linear free surface
328      !
[9019]329      IF( ln_timing )   CALL timing_start('dom_vvl_sf_nxt')
[6140]330      !
331      IF( kt == nit000 ) THEN
[4292]332         IF(lwp) WRITE(numout,*)
333         IF(lwp) WRITE(numout,*) 'dom_vvl_sf_nxt : compute after scale factors'
334         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~'
335      ENDIF
336
[4338]337      ll_do_bclinic = .TRUE.
338      IF( PRESENT(kcall) ) THEN
[6140]339         IF( kcall == 2 .AND. ln_vvl_ztilde )   ll_do_bclinic = .FALSE.
[4338]340      ENDIF
341
[4292]342      ! ******************************* !
343      ! After acale factors at t-points !
344      ! ******************************* !
[4338]345      !                                                ! --------------------------------------------- !
[6140]346      !                                                ! z_star coordinate and barotropic z-tilde part !
[4338]347      !                                                ! --------------------------------------------- !
[6140]348      !
[12377]349      z_scale(:,:) = ( ssh(:,:,Kaa) - ssh(:,:,Kbb) ) * ssmask(:,:) / ( ht_0(:,:) + ssh(:,:,Kmm) + 1. - ssmask(:,:) )
[4338]350      DO jk = 1, jpkm1
[12377]351         ! formally this is the same as e3t(:,:,:,Kaa) = e3t_0*(1+ssha/ht_0)
352         e3t(:,:,jk,Kaa) = e3t(:,:,jk,Kbb) + e3t(:,:,jk,Kmm) * z_scale(:,:) * tmask(:,:,jk)
[4338]353      END DO
[6140]354      !
[11415]355      IF( (ln_vvl_ztilde .OR. ln_vvl_layer) .AND. ll_do_bclinic ) THEN   ! z_tilde or layer coordinate !
356         !                                                               ! ------baroclinic part------ !
[4292]357         ! I - initialization
358         ! ==================
359
360         ! 1 - barotropic divergence
361         ! -------------------------
[7753]362         zhdiv(:,:) = 0._wp
363         zht(:,:)   = 0._wp
[4292]364         DO jk = 1, jpkm1
[12377]365            zhdiv(:,:) = zhdiv(:,:) + e3t(:,:,jk,Kmm) * hdiv(:,:,jk)
366            zht  (:,:) = zht  (:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[592]367         END DO
[7753]368         zhdiv(:,:) = zhdiv(:,:) / ( zht(:,:) + 1. - tmask_i(:,:) )
[2528]369
[4292]370         ! 2 - Low frequency baroclinic horizontal divergence  (z-tilde case only)
371         ! --------------------------------------------------
372         IF( ln_vvl_ztilde ) THEN
[6140]373            IF( kt > nit000 ) THEN
[4292]374               DO jk = 1, jpkm1
[12489]375                  hdiv_lf(:,:,jk) = hdiv_lf(:,:,jk) - rn_Dt * frq_rst_hdv(:,:)   &
[12377]376                     &          * ( hdiv_lf(:,:,jk) - e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) )
[4292]377               END DO
378            ENDIF
[6140]379         ENDIF
[3294]380
[4292]381         ! II - after z_tilde increments of vertical scale factors
382         ! =======================================================
[7753]383         tilde_e3t_a(:,:,:) = 0._wp  ! tilde_e3t_a used to store tendency terms
[4292]384
385         ! 1 - High frequency divergence term
386         ! ----------------------------------
387         IF( ln_vvl_ztilde ) THEN     ! z_tilde case
388            DO jk = 1, jpkm1
[12377]389               tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - ( e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) - hdiv_lf(:,:,jk) )
[4292]390            END DO
391         ELSE                         ! layer case
392            DO jk = 1, jpkm1
[12377]393               tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) -   e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) * tmask(:,:,jk)
[4292]394            END DO
[6140]395         ENDIF
[4292]396
397         ! 2 - Restoring term (z-tilde case only)
398         ! ------------------
399         IF( ln_vvl_ztilde ) THEN
400            DO jk = 1, jpk
[7753]401               tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - frq_rst_e3t(:,:) * tilde_e3t_b(:,:,jk)
[4292]402            END DO
[6140]403         ENDIF
[4292]404
405         ! 3 - Thickness diffusion term
406         ! ----------------------------
[7753]407         zwu(:,:) = 0._wp
408         zwv(:,:) = 0._wp
[12377]409         DO_3D_10_10( 1, jpkm1 )
410            un_td(ji,jj,jk) = rn_ahe3 * umask(ji,jj,jk) * e2_e1u(ji,jj)           &
411               &            * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji+1,jj  ,jk) )
412            vn_td(ji,jj,jk) = rn_ahe3 * vmask(ji,jj,jk) * e1_e2v(ji,jj)           & 
413               &            * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji  ,jj+1,jk) )
414            zwu(ji,jj) = zwu(ji,jj) + un_td(ji,jj,jk)
415            zwv(ji,jj) = zwv(ji,jj) + vn_td(ji,jj,jk)
416         END_3D
417         DO_2D_11_11
418            un_td(ji,jj,mbku(ji,jj)) = un_td(ji,jj,mbku(ji,jj)) - zwu(ji,jj)
419            vn_td(ji,jj,mbkv(ji,jj)) = vn_td(ji,jj,mbkv(ji,jj)) - zwv(ji,jj)
420         END_2D
421         DO_3D_00_00( 1, jpkm1 )
422            tilde_e3t_a(ji,jj,jk) = tilde_e3t_a(ji,jj,jk) + (   un_td(ji-1,jj  ,jk) - un_td(ji,jj,jk)    &
423               &                                          +     vn_td(ji  ,jj-1,jk) - vn_td(ji,jj,jk)    &
424               &                                            ) * r1_e1e2t(ji,jj)
425         END_3D
[6140]426         !                       ! d - thickness diffusion transport: boundary conditions
427         !                             (stored for tracer advction and continuity equation)
[10425]428         CALL lbc_lnk_multi( 'domvvl', un_td , 'U' , -1._wp, vn_td , 'V' , -1._wp)
[4292]429
430         ! 4 - Time stepping of baroclinic scale factors
431         ! ---------------------------------------------
[10425]432         CALL lbc_lnk( 'domvvl', tilde_e3t_a(:,:,:), 'T', 1._wp )
[12489]433         tilde_e3t_a(:,:,:) = tilde_e3t_b(:,:,:) + rDt * tmask(:,:,:) * tilde_e3t_a(:,:,:)
[4292]434
435         ! Maximum deformation control
436         ! ~~~~~~~~~~~~~~~~~~~~~~~~~~~
[7753]437         ze3t(:,:,jpk) = 0._wp
[4292]438         DO jk = 1, jpkm1
[7753]439            ze3t(:,:,jk) = tilde_e3t_a(:,:,jk) / e3t_0(:,:,jk) * tmask(:,:,jk) * tmask_i(:,:)
[4292]440         END DO
441         z_tmax = MAXVAL( ze3t(:,:,:) )
[10425]442         CALL mpp_max( 'domvvl', z_tmax )                 ! max over the global domain
[4292]443         z_tmin = MINVAL( ze3t(:,:,:) )
[10425]444         CALL mpp_min( 'domvvl', z_tmin )                 ! min over the global domain
[4292]445         ! - ML - test: for the moment, stop simulation for too large e3_t variations
[6140]446         IF( ( z_tmax >  rn_zdef_max ) .OR. ( z_tmin < - rn_zdef_max ) ) THEN
[4292]447            IF( lk_mpp ) THEN
[10425]448               CALL mpp_maxloc( 'domvvl', ze3t, tmask, z_tmax, ijk_max )
449               CALL mpp_minloc( 'domvvl', ze3t, tmask, z_tmin, ijk_min )
[4292]450            ELSE
451               ijk_max = MAXLOC( ze3t(:,:,:) )
452               ijk_max(1) = ijk_max(1) + nimpp - 1
453               ijk_max(2) = ijk_max(2) + njmpp - 1
454               ijk_min = MINLOC( ze3t(:,:,:) )
455               ijk_min(1) = ijk_min(1) + nimpp - 1
456               ijk_min(2) = ijk_min(2) + njmpp - 1
457            ENDIF
458            IF (lwp) THEN
459               WRITE(numout, *) 'MAX( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmax
460               WRITE(numout, *) 'at i, j, k=', ijk_max
461               WRITE(numout, *) 'MIN( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmin
462               WRITE(numout, *) 'at i, j, k=', ijk_min           
[10425]463               CALL ctl_stop( 'STOP', 'MAX( ABS( tilde_e3t_a(:,:,: ) ) / e3t_0(:,:,:) ) too high')
[4292]464            ENDIF
465         ENDIF
466         ! - ML - end test
467         ! - ML - Imposing these limits will cause a baroclinicity error which is corrected for below
[7753]468         tilde_e3t_a(:,:,:) = MIN( tilde_e3t_a(:,:,:),   rn_zdef_max * e3t_0(:,:,:) )
469         tilde_e3t_a(:,:,:) = MAX( tilde_e3t_a(:,:,:), - rn_zdef_max * e3t_0(:,:,:) )
[4292]470
[4338]471         !
472         ! "tilda" change in the after scale factor
[4292]473         ! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[4338]474         DO jk = 1, jpkm1
[7753]475            dtilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - tilde_e3t_b(:,:,jk)
[4338]476         END DO
[4292]477         ! III - Barotropic repartition of the sea surface height over the baroclinic profile
478         ! ==================================================================================
[4338]479         ! add ( ssh increment + "baroclinicity error" ) proportionly to e3t(n)
[4292]480         ! - ML - baroclinicity error should be better treated in the future
481         !        i.e. locally and not spread over the water column.
482         !        (keep in mind that the idea is to reduce Eulerian velocity as much as possible)
[7753]483         zht(:,:) = 0.
[4292]484         DO jk = 1, jpkm1
[7753]485            zht(:,:)  = zht(:,:) + tilde_e3t_a(:,:,jk) * tmask(:,:,jk)
[4292]486         END DO
[12377]487         z_scale(:,:) =  - zht(:,:) / ( ht_0(:,:) + ssh(:,:,Kmm) + 1. - ssmask(:,:) )
[4292]488         DO jk = 1, jpkm1
[12377]489            dtilde_e3t_a(:,:,jk) = dtilde_e3t_a(:,:,jk) + e3t(:,:,jk,Kmm) * z_scale(:,:) * tmask(:,:,jk)
[4292]490         END DO
[7753]491
[4292]492      ENDIF
493
[4338]494      IF( ln_vvl_ztilde .OR. ln_vvl_layer )  THEN   ! z_tilde or layer coordinate !
495      !                                           ! ---baroclinic part--------- !
496         DO jk = 1, jpkm1
[12377]497            e3t(:,:,jk,Kaa) = e3t(:,:,jk,Kaa) + dtilde_e3t_a(:,:,jk) * tmask(:,:,jk)
[4338]498         END DO
499      ENDIF
500
501      IF( ln_vvl_dbg .AND. .NOT. ll_do_bclinic ) THEN   ! - ML - test: control prints for debuging
[4292]502         !
503         IF( lwp ) WRITE(numout, *) 'kt =', kt
504         IF ( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
505            z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( zht(:,:) ) )
[10425]506            CALL mpp_max( 'domvvl', z_tmax )                             ! max over the global domain
[4292]507            IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(SUM(tilde_e3t_a))) =', z_tmax
508         END IF
509         !
[7753]510         zht(:,:) = 0.0_wp
[4292]511         DO jk = 1, jpkm1
[12377]512            zht(:,:) = zht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[4292]513         END DO
[12377]514         z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kmm) - zht(:,:) ) )
[10425]515         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]516         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+sshn-SUM(e3t(:,:,:,Kmm)))) =', z_tmax
[4292]517         !
[7753]518         zht(:,:) = 0.0_wp
[4292]519         DO jk = 1, jpkm1
[12377]520            zht(:,:) = zht(:,:) + e3t(:,:,jk,Kaa) * tmask(:,:,jk)
[4292]521         END DO
[12377]522         z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kaa) - zht(:,:) ) )
[10425]523         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]524         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+ssha-SUM(e3t(:,:,:,Kaa)))) =', z_tmax
[4292]525         !
[7753]526         zht(:,:) = 0.0_wp
[4292]527         DO jk = 1, jpkm1
[12377]528            zht(:,:) = zht(:,:) + e3t(:,:,jk,Kbb) * tmask(:,:,jk)
[4292]529         END DO
[12377]530         z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kbb) - zht(:,:) ) )
[10425]531         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]532         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+sshb-SUM(e3t(:,:,:,Kbb)))) =', z_tmax
[4292]533         !
[12377]534         z_tmax = MAXVAL( tmask(:,:,1) *  ABS( ssh(:,:,Kbb) ) )
[10425]535         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]536         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kbb)))) =', z_tmax
[4292]537         !
[12377]538         z_tmax = MAXVAL( tmask(:,:,1) *  ABS( ssh(:,:,Kmm) ) )
[10425]539         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]540         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kmm)))) =', z_tmax
[4292]541         !
[12377]542         z_tmax = MAXVAL( tmask(:,:,1) *  ABS( ssh(:,:,Kaa) ) )
[10425]543         CALL mpp_max( 'domvvl', z_tmax )                                ! max over the global domain
[12377]544         IF( lwp    ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kaa)))) =', z_tmax
[4292]545      END IF
546
547      ! *********************************** !
548      ! After scale factors at u- v- points !
549      ! *********************************** !
550
[12377]551      CALL dom_vvl_interpol( e3t(:,:,:,Kaa), e3u(:,:,:,Kaa), 'U' )
552      CALL dom_vvl_interpol( e3t(:,:,:,Kaa), e3v(:,:,:,Kaa), 'V' )
[4292]553
[4370]554      ! *********************************** !
555      ! After depths at u- v points         !
556      ! *********************************** !
557
[12377]558      hu(:,:,Kaa) = e3u(:,:,1,Kaa) * umask(:,:,1)
559      hv(:,:,Kaa) = e3v(:,:,1,Kaa) * vmask(:,:,1)
[6140]560      DO jk = 2, jpkm1
[12377]561         hu(:,:,Kaa) = hu(:,:,Kaa) + e3u(:,:,jk,Kaa) * umask(:,:,jk)
562         hv(:,:,Kaa) = hv(:,:,Kaa) + e3v(:,:,jk,Kaa) * vmask(:,:,jk)
[4370]563      END DO
564      !                                        ! Inverse of the local depth
[6140]565!!gm BUG ?  don't understand the use of umask_i here .....
[12377]566      r1_hu(:,:,Kaa) = ssumask(:,:) / ( hu(:,:,Kaa) + 1._wp - ssumask(:,:) )
567      r1_hv(:,:,Kaa) = ssvmask(:,:) / ( hv(:,:,Kaa) + 1._wp - ssvmask(:,:) )
[6140]568      !
[9019]569      IF( ln_timing )   CALL timing_stop('dom_vvl_sf_nxt')
[6140]570      !
[4292]571   END SUBROUTINE dom_vvl_sf_nxt
572
573
[12377]574   SUBROUTINE dom_vvl_sf_update( kt, Kbb, Kmm, Kaa )
[3294]575      !!----------------------------------------------------------------------
[12377]576      !!                ***  ROUTINE dom_vvl_sf_update  ***
[3294]577      !!                   
[12377]578      !! ** Purpose :  for z tilde case: compute time filter and swap of scale factors
[4292]579      !!               compute all depths and related variables for next time step
580      !!               write outputs and restart file
[3294]581      !!
[12377]582      !! ** Method  :  - swap of e3t with trick for volume/tracer conservation (ONLY FOR Z TILDE CASE)
[4292]583      !!               - reconstruct scale factor at other grid points (interpolate)
584      !!               - recompute depths and water height fields
585      !!
[12377]586      !! ** Action  :  - tilde_e3t_(b/n) ready for next time step
[4292]587      !!               - Recompute:
[6140]588      !!                    e3(u/v)_b       
[12377]589      !!                    e3w(:,:,:,Kmm)           
[6140]590      !!                    e3(u/v)w_b     
591      !!                    e3(u/v)w_n     
[12377]592      !!                    gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm)  and gde3w
[4292]593      !!                    h(u/v) and h(u/v)r
594      !!
595      !! Reference  : Leclair, M., and G. Madec, 2009, Ocean Modelling.
596      !!              Leclair, M., and G. Madec, 2011, Ocean Modelling.
[3294]597      !!----------------------------------------------------------------------
[12377]598      INTEGER, INTENT( in ) ::   kt              ! time step
599      INTEGER, INTENT( in ) ::   Kbb, Kmm, Kaa   ! time level indices
[6140]600      !
601      INTEGER  ::   ji, jj, jk   ! dummy loop indices
602      REAL(wp) ::   zcoef        ! local scalar
[3294]603      !!----------------------------------------------------------------------
[6140]604      !
605      IF( ln_linssh )   RETURN      ! No calculation in linear free surface
606      !
[12377]607      IF( ln_timing )   CALL timing_start('dom_vvl_sf_update')
[3294]608      !
[4292]609      IF( kt == nit000 )   THEN
610         IF(lwp) WRITE(numout,*)
[12377]611         IF(lwp) WRITE(numout,*) 'dom_vvl_sf_update : - interpolate scale factors and compute depths for next time step'
612         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~~~'
[3294]613      ENDIF
[4292]614      !
615      ! Time filter and swap of scale factors
616      ! =====================================
[6140]617      ! - ML - e3(t/u/v)_b are allready computed in dynnxt.
[4292]618      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
[12489]619         IF( l_1st_euler ) THEN
[7753]620            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:)
[4292]621         ELSE
[7753]622            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) & 
[12489]623            &         + rn_atfp * ( tilde_e3t_b(:,:,:) - 2.0_wp * tilde_e3t_n(:,:,:) + tilde_e3t_a(:,:,:) )
[4292]624         ENDIF
[7753]625         tilde_e3t_n(:,:,:) = tilde_e3t_a(:,:,:)
[4292]626      ENDIF
[4488]627
[4292]628      ! Compute all missing vertical scale factor and depths
629      ! ====================================================
630      ! Horizontal scale factor interpolations
631      ! --------------------------------------
[12377]632      ! - ML - e3u(:,:,:,Kbb) and e3v(:,:,:,Kbb) are already computed in dynnxt
633      ! - JC - hu(:,:,:,Kbb), hv(:,:,:,:,Kbb), hur_b, hvr_b also
[6140]634     
[12377]635      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F'  )
[6140]636     
[4292]637      ! Vertical scale factor interpolations
[12377]638      CALL dom_vvl_interpol( e3t(:,:,:,Kmm),  e3w(:,:,:,Kmm), 'W'  )
639      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3uw(:,:,:,Kmm), 'UW' )
640      CALL dom_vvl_interpol( e3v(:,:,:,Kmm), e3vw(:,:,:,Kmm), 'VW' )
641      CALL dom_vvl_interpol( e3t(:,:,:,Kbb),  e3w(:,:,:,Kbb), 'W'  )
642      CALL dom_vvl_interpol( e3u(:,:,:,Kbb), e3uw(:,:,:,Kbb), 'UW' )
643      CALL dom_vvl_interpol( e3v(:,:,:,Kbb), e3vw(:,:,:,Kbb), 'VW' )
[5120]644
[6140]645      ! t- and w- points depth (set the isf depth as it is in the initial step)
[12377]646      gdept(:,:,1,Kmm) = 0.5_wp * e3w(:,:,1,Kmm)
647      gdepw(:,:,1,Kmm) = 0.0_wp
648      gde3w(:,:,1) = gdept(:,:,1,Kmm) - ssh(:,:,Kmm)
649      DO_3D_11_11( 2, jpk )
650        !    zcoef = (tmask(ji,jj,jk) - wmask(ji,jj,jk))   ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt
651                                                           ! 1 for jk = mikt
652         zcoef = (tmask(ji,jj,jk) - wmask(ji,jj,jk))
653         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm)
654         gdept(ji,jj,jk,Kmm) =    zcoef  * ( gdepw(ji,jj,jk  ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm) )  &
655             &             + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm) ) 
656         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm)
657      END_3D
[5120]658
[6140]659      ! Local depth and Inverse of the local depth of the water
660      ! -------------------------------------------------------
[7753]661      !
[12377]662      ht(:,:) = e3t(:,:,1,Kmm) * tmask(:,:,1)
[6140]663      DO jk = 2, jpkm1
[12377]664         ht(:,:) = ht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[4370]665      END DO
[7753]666
[4292]667      ! write restart file
668      ! ==================
[12377]669      IF( lrst_oce  )   CALL dom_vvl_rst( kt, Kbb, Kmm, 'WRITE' )
[4292]670      !
[12377]671      IF( ln_timing )   CALL timing_stop('dom_vvl_sf_update')
[6140]672      !
[12377]673   END SUBROUTINE dom_vvl_sf_update
[4292]674
675
676   SUBROUTINE dom_vvl_interpol( pe3_in, pe3_out, pout )
677      !!---------------------------------------------------------------------
678      !!                  ***  ROUTINE dom_vvl__interpol  ***
679      !!
680      !! ** Purpose :   interpolate scale factors from one grid point to another
681      !!
682      !! ** Method  :   e3_out = e3_0 + interpolation(e3_in - e3_0)
683      !!                - horizontal interpolation: grid cell surface averaging
684      !!                - vertical interpolation: simple averaging
685      !!----------------------------------------------------------------------
[5836]686      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in   ) ::  pe3_in    ! input e3 to be interpolated
687      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout) ::  pe3_out   ! output interpolated e3
688      CHARACTER(LEN=*)                , INTENT(in   ) ::  pout      ! grid point of out scale factors
689      !                                                             !   =  'U', 'V', 'W, 'F', 'UW' or 'VW'
690      !
[6152]691      INTEGER ::   ji, jj, jk                                       ! dummy loop indices
[9023]692      REAL(wp) ::  zlnwd                                            ! =1./0. when ln_wd_il = T/F
[4292]693      !!----------------------------------------------------------------------
[5836]694      !
[9023]695      IF(ln_wd_il) THEN
[6152]696        zlnwd = 1.0_wp
697      ELSE
698        zlnwd = 0.0_wp
699      END IF
700      !
[5836]701      SELECT CASE ( pout )    !==  type of interpolation  ==!
[4292]702         !
[5836]703      CASE( 'U' )                   !* from T- to U-point : hor. surface weighted mean
[12377]704         DO_3D_10_10( 1, jpk )
705            pe3_out(ji,jj,jk) = 0.5_wp * (  umask(ji,jj,jk) * (1.0_wp - zlnwd) + zlnwd ) * r1_e1e2u(ji,jj)   &
706               &                       * (   e1e2t(ji  ,jj) * ( pe3_in(ji  ,jj,jk) - e3t_0(ji  ,jj,jk) )     &
707               &                           + e1e2t(ji+1,jj) * ( pe3_in(ji+1,jj,jk) - e3t_0(ji+1,jj,jk) ) )
708         END_3D
[10425]709         CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'U', 1._wp )
[7753]710         pe3_out(:,:,:) = pe3_out(:,:,:) + e3u_0(:,:,:)
[5836]711         !
712      CASE( 'V' )                   !* from T- to V-point : hor. surface weighted mean
[12377]713         DO_3D_10_10( 1, jpk )
714            pe3_out(ji,jj,jk) = 0.5_wp * ( vmask(ji,jj,jk)  * (1.0_wp - zlnwd) + zlnwd ) * r1_e1e2v(ji,jj)   &
715               &                       * (   e1e2t(ji,jj  ) * ( pe3_in(ji,jj  ,jk) - e3t_0(ji,jj  ,jk) )     &
716               &                           + e1e2t(ji,jj+1) * ( pe3_in(ji,jj+1,jk) - e3t_0(ji,jj+1,jk) ) )
717         END_3D
[10425]718         CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'V', 1._wp )
[7753]719         pe3_out(:,:,:) = pe3_out(:,:,:) + e3v_0(:,:,:)
[5836]720         !
721      CASE( 'F' )                   !* from U-point to F-point : hor. surface weighted mean
[12377]722         DO_3D_10_10( 1, jpk )
723            pe3_out(ji,jj,jk) = 0.5_wp * (  umask(ji,jj,jk) * umask(ji,jj+1,jk) * (1.0_wp - zlnwd) + zlnwd ) &
724               &                       *    r1_e1e2f(ji,jj)                                                  &
725               &                       * (   e1e2u(ji,jj  ) * ( pe3_in(ji,jj  ,jk) - e3u_0(ji,jj  ,jk) )     &
726               &                           + e1e2u(ji,jj+1) * ( pe3_in(ji,jj+1,jk) - e3u_0(ji,jj+1,jk) ) )
727         END_3D
[10425]728         CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'F', 1._wp )
[7753]729         pe3_out(:,:,:) = pe3_out(:,:,:) + e3f_0(:,:,:)
[5836]730         !
731      CASE( 'W' )                   !* from T- to W-point : vertical simple mean
732         !
[7753]733         pe3_out(:,:,1) = e3w_0(:,:,1) + pe3_in(:,:,1) - e3t_0(:,:,1)
[5836]734         ! - ML - The use of mask in this formulea enables the special treatment of the last w-point without indirect adressing
735!!gm BUG? use here wmask in case of ISF ?  to be checked
[4292]736         DO jk = 2, jpk
[7753]737            pe3_out(:,:,jk) = e3w_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( tmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) )   &
738               &                            * ( pe3_in(:,:,jk-1) - e3t_0(:,:,jk-1) )                               &
739               &                            +            0.5_wp * ( tmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd )     &
740               &                            * ( pe3_in(:,:,jk  ) - e3t_0(:,:,jk  ) )
[4292]741         END DO
[5836]742         !
743      CASE( 'UW' )                  !* from U- to UW-point : vertical simple mean
744         !
[7753]745         pe3_out(:,:,1) = e3uw_0(:,:,1) + pe3_in(:,:,1) - e3u_0(:,:,1)
[4292]746         ! - ML - The use of mask in this formaula enables the special treatment of the last w- point without indirect adressing
[5836]747!!gm BUG? use here wumask in case of ISF ?  to be checked
[4292]748         DO jk = 2, jpk
[7753]749            pe3_out(:,:,jk) = e3uw_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( umask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) )  &
750               &                             * ( pe3_in(:,:,jk-1) - e3u_0(:,:,jk-1) )                              &
751               &                             +            0.5_wp * ( umask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd )    &
752               &                             * ( pe3_in(:,:,jk  ) - e3u_0(:,:,jk  ) )
[4292]753         END DO
[5836]754         !
755      CASE( 'VW' )                  !* from V- to VW-point : vertical simple mean
756         !
[7753]757         pe3_out(:,:,1) = e3vw_0(:,:,1) + pe3_in(:,:,1) - e3v_0(:,:,1)
[4292]758         ! - ML - The use of mask in this formaula enables the special treatment of the last w- point without indirect adressing
[5836]759!!gm BUG? use here wvmask in case of ISF ?  to be checked
[4292]760         DO jk = 2, jpk
[7753]761            pe3_out(:,:,jk) = e3vw_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( vmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) )  &
762               &                             * ( pe3_in(:,:,jk-1) - e3v_0(:,:,jk-1) )                              &
763               &                             +            0.5_wp * ( vmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd )    &
764               &                             * ( pe3_in(:,:,jk  ) - e3v_0(:,:,jk  ) )
[4292]765         END DO
766      END SELECT
767      !
768   END SUBROUTINE dom_vvl_interpol
769
[5836]770
[12377]771   SUBROUTINE dom_vvl_rst( kt, Kbb, Kmm, cdrw )
[4292]772      !!---------------------------------------------------------------------
773      !!                   ***  ROUTINE dom_vvl_rst  ***
774      !!                     
775      !! ** Purpose :   Read or write VVL file in restart file
776      !!
777      !! ** Method  :   use of IOM library
778      !!                if the restart does not contain vertical scale factors,
779      !!                they are set to the _0 values
780      !!                if the restart does not contain vertical scale factors increments (z_tilde),
781      !!                they are set to 0.
782      !!----------------------------------------------------------------------
[12377]783      INTEGER         , INTENT(in) ::   kt        ! ocean time-step
784      INTEGER         , INTENT(in) ::   Kbb, Kmm  ! ocean time level indices
785      CHARACTER(len=*), INTENT(in) ::   cdrw      ! "READ"/"WRITE" flag
[5836]786      !
[6152]787      INTEGER ::   ji, jj, jk
[4292]788      INTEGER ::   id1, id2, id3, id4, id5     ! local integers
789      !!----------------------------------------------------------------------
790      !
791      IF( TRIM(cdrw) == 'READ' ) THEN        ! Read/initialise
792         !                                   ! ===============
793         IF( ln_rstart ) THEN                   !* Read the restart file
794            CALL rst_read_open                  !  open the restart file if necessary
[12377]795            CALL iom_get( numror, jpdom_autoglo, 'sshn'   , ssh(:,:,Kmm), ldxios = lrxios    )
[4366]796            !
[6140]797            id1 = iom_varid( numror, 'e3t_b', ldstop = .FALSE. )
798            id2 = iom_varid( numror, 'e3t_n', ldstop = .FALSE. )
[4292]799            id3 = iom_varid( numror, 'tilde_e3t_b', ldstop = .FALSE. )
800            id4 = iom_varid( numror, 'tilde_e3t_n', ldstop = .FALSE. )
[4795]801            id5 = iom_varid( numror, 'hdiv_lf', ldstop = .FALSE. )
[12377]802            !
[4292]803            !                             ! --------- !
804            !                             ! all cases !
805            !                             ! --------- !
[12377]806            !
[4292]807            IF( MIN( id1, id2 ) > 0 ) THEN       ! all required arrays exist
[12377]808               CALL iom_get( numror, jpdom_autoglo, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lrxios )
809               CALL iom_get( numror, jpdom_autoglo, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lrxios )
[4990]810               ! needed to restart if land processor not computed
[12377]811               IF(lwp) write(numout,*) 'dom_vvl_rst : e3t(:,:,:,Kbb) and e3t(:,:,:,Kmm) found in restart files'
[4990]812               WHERE ( tmask(:,:,:) == 0.0_wp ) 
[12377]813                  e3t(:,:,:,Kmm) = e3t_0(:,:,:)
814                  e3t(:,:,:,Kbb) = e3t_0(:,:,:)
[4990]815               END WHERE
[12489]816               IF( l_1st_euler ) THEN
[12377]817                  e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[4292]818               ENDIF
819            ELSE IF( id1 > 0 ) THEN
[12377]820               IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kmm) not found in restart files'
[6140]821               IF(lwp) write(numout,*) 'e3t_n set equal to e3t_b.'
[12489]822               IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[12377]823               CALL iom_get( numror, jpdom_autoglo, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lrxios )
824               e3t(:,:,:,Kmm) = e3t(:,:,:,Kbb)
[12489]825               l_1st_euler = .true.
[4990]826            ELSE IF( id2 > 0 ) THEN
[12377]827               IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kbb) not found in restart files'
[6140]828               IF(lwp) write(numout,*) 'e3t_b set equal to e3t_n.'
[12489]829               IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[12377]830               CALL iom_get( numror, jpdom_autoglo, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lrxios )
831               e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[12489]832               l_1st_euler = .true.
[4490]833            ELSE
[12377]834               IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kmm) not found in restart file'
[4490]835               IF(lwp) write(numout,*) 'Compute scale factor from sshn'
[12489]836               IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[6140]837               DO jk = 1, jpk
[12377]838                  e3t(:,:,jk,Kmm) =  e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kmm) ) &
[6140]839                      &                          / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk)   &
840                      &          + e3t_0(:,:,jk)                               * (1._wp -tmask(:,:,jk))
[4490]841               END DO
[12377]842               e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[12489]843               l_1st_euler = .true.
[4292]844            ENDIF
845            !                             ! ----------- !
846            IF( ln_vvl_zstar ) THEN       ! z_star case !
847               !                          ! ----------- !
848               IF( MIN( id3, id4 ) > 0 ) THEN
849                  CALL ctl_stop( 'dom_vvl_rst: z_star cannot restart from a z_tilde or layer run' )
850               ENDIF
851               !                          ! ----------------------- !
852            ELSE                          ! z_tilde and layer cases !
853               !                          ! ----------------------- !
854               IF( MIN( id3, id4 ) > 0 ) THEN  ! all required arrays exist
[9367]855                  CALL iom_get( numror, jpdom_autoglo, 'tilde_e3t_b', tilde_e3t_b(:,:,:), ldxios = lrxios )
856                  CALL iom_get( numror, jpdom_autoglo, 'tilde_e3t_n', tilde_e3t_n(:,:,:), ldxios = lrxios )
[4292]857               ELSE                            ! one at least array is missing
858                  tilde_e3t_b(:,:,:) = 0.0_wp
859                  tilde_e3t_n(:,:,:) = 0.0_wp
860               ENDIF
861               !                          ! ------------ !
862               IF( ln_vvl_ztilde ) THEN   ! z_tilde case !
863                  !                       ! ------------ !
864                  IF( id5 > 0 ) THEN  ! required array exists
[9367]865                     CALL iom_get( numror, jpdom_autoglo, 'hdiv_lf', hdiv_lf(:,:,:), ldxios = lrxios )
[4292]866                  ELSE                ! array is missing
867                     hdiv_lf(:,:,:) = 0.0_wp
868                  ENDIF
869               ENDIF
870            ENDIF
871            !
872         ELSE                                   !* Initialize at "rest"
[7646]873            !
[9023]874
875            IF( ll_wd ) THEN   ! MJB ll_wd edits start here - these are essential
876               !
877               IF( cn_cfg == 'wad' ) THEN
878                  ! Wetting and drying test case
[12377]879                  CALL usr_def_istate( gdept(:,:,:,Kbb), tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb)  )
880                  ts  (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb)       ! set now values from to before ones
881                  ssh (:,:,Kmm)     = ssh(:,:,Kbb)
882                  uu   (:,:,:,Kmm)   = uu  (:,:,:,Kbb)
883                  vv   (:,:,:,Kmm)   = vv  (:,:,:,Kbb)
[9023]884               ELSE
885                  ! if not test case
[12377]886                  ssh(:,:,Kmm) = -ssh_ref
887                  ssh(:,:,Kbb) = -ssh_ref
[9023]888
[12377]889                  DO_2D_11_11
890                     IF( ht_0(ji,jj)-ssh_ref <  rn_wdmin1 ) THEN ! if total depth is less than min depth
891                        ssh(ji,jj,Kbb) = rn_wdmin1 - (ht_0(ji,jj) )
892                        ssh(ji,jj,Kmm) = rn_wdmin1 - (ht_0(ji,jj) )
893                     ENDIF
894                  END_2D
[9023]895               ENDIF !If test case else
896
897               ! Adjust vertical metrics for all wad
[7646]898               DO jk = 1, jpk
[12377]899                  e3t(:,:,jk,Kmm) =  e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kmm)  ) &
[7646]900                    &                            / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk)   &
[9023]901                    &            + e3t_0(:,:,jk) * ( 1._wp - tmask(:,:,jk) )
[7646]902               END DO
[12377]903               e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[9023]904
[13159]905               DO_2D_11_11
906                  IF ( ht_0(ji,jj) .LE. 0.0 .AND. NINT( ssmask(ji,jj) ) .EQ. 1) THEN
907                     CALL ctl_stop( 'dom_vvl_rst: ht_0 must be positive at potentially wet points' )
908                  ENDIF
909               END_2D
[7646]910               !
911            ELSE
912               !
[9059]913               ! Just to read set ssh in fact, called latter once vertical grid
914               ! is set up:
[12377]915!               CALL usr_def_istate( gdept_0, tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb)  )
[9065]916!               !
917!               DO jk=1,jpk
[12377]918!                  e3t(:,:,jk,Kbb) =  e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kbb) ) &
[9065]919!                     &            / ( ht_0(:,:) + 1._wp -ssmask(:,:) ) * tmask(:,:,jk)
920!               END DO
[12377]921!               e3t(:,:,:,Kmm) = e3t(:,:,:,Kbb)
922                ssh(:,:,Kmm)=0._wp
923                e3t(:,:,:,Kmm)=e3t_0(:,:,:)
924                e3t(:,:,:,Kbb)=e3t_0(:,:,:)
[7646]925               !
[9023]926            END IF           ! end of ll_wd edits
[6152]927
[4292]928            IF( ln_vvl_ztilde .OR. ln_vvl_layer) THEN
[7646]929               tilde_e3t_b(:,:,:) = 0._wp
930               tilde_e3t_n(:,:,:) = 0._wp
931               IF( ln_vvl_ztilde ) hdiv_lf(:,:,:) = 0._wp
[4292]932            END IF
933         ENDIF
[5836]934         !
[4292]935      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN   ! Create restart file
936         !                                   ! ===================
937         IF(lwp) WRITE(numout,*) '---- dom_vvl_rst ----'
[9367]938         IF( lwxios ) CALL iom_swap(      cwxios_context          )
[4292]939         !                                           ! --------- !
940         !                                           ! all cases !
941         !                                           ! --------- !
[12377]942         CALL iom_rstput( kt, nitrst, numrow, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lwxios )
943         CALL iom_rstput( kt, nitrst, numrow, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lwxios )
[4292]944         !                                           ! ----------------------- !
945         IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN  ! z_tilde and layer cases !
946            !                                        ! ----------------------- !
[9367]947            CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_b', tilde_e3t_b(:,:,:), ldxios = lwxios)
948            CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_n', tilde_e3t_n(:,:,:), ldxios = lwxios)
[4292]949         END IF
950         !                                           ! -------------!   
951         IF( ln_vvl_ztilde ) THEN                    ! z_tilde case !
952            !                                        ! ------------ !
[9367]953            CALL iom_rstput( kt, nitrst, numrow, 'hdiv_lf', hdiv_lf(:,:,:), ldxios = lwxios)
[4292]954         ENDIF
[5836]955         !
[9367]956         IF( lwxios ) CALL iom_swap(      cxios_context          )
[4292]957      ENDIF
[5836]958      !
[4292]959   END SUBROUTINE dom_vvl_rst
960
961
962   SUBROUTINE dom_vvl_ctl
963      !!---------------------------------------------------------------------
964      !!                  ***  ROUTINE dom_vvl_ctl  ***
965      !!               
966      !! ** Purpose :   Control the consistency between namelist options
967      !!                for vertical coordinate
968      !!----------------------------------------------------------------------
[5836]969      INTEGER ::   ioptio, ios
970      !!
[4292]971      NAMELIST/nam_vvl/ ln_vvl_zstar, ln_vvl_ztilde, ln_vvl_layer, ln_vvl_ztilde_as_zstar, &
[5836]972         &              ln_vvl_zstar_at_eqtor      , rn_ahe3     , rn_rst_e3t            , &
973         &              rn_lf_cutoff               , rn_zdef_max , ln_vvl_dbg                ! not yet implemented: ln_vvl_kepe
[4292]974      !!----------------------------------------------------------------------
[5836]975      !
[4294]976      READ  ( numnam_ref, nam_vvl, IOSTAT = ios, ERR = 901)
[11536]977901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'nam_vvl in reference namelist' )
[4294]978      READ  ( numnam_cfg, nam_vvl, IOSTAT = ios, ERR = 902 )
[11536]979902   IF( ios >  0 ) CALL ctl_nam ( ios , 'nam_vvl in configuration namelist' )
[4624]980      IF(lwm) WRITE ( numond, nam_vvl )
[5836]981      !
[4292]982      IF(lwp) THEN                    ! Namelist print
983         WRITE(numout,*)
984         WRITE(numout,*) 'dom_vvl_ctl : choice/control of the variable vertical coordinate'
985         WRITE(numout,*) '~~~~~~~~~~~'
[9168]986         WRITE(numout,*) '   Namelist nam_vvl : chose a vertical coordinate'
987         WRITE(numout,*) '      zstar                      ln_vvl_zstar   = ', ln_vvl_zstar
988         WRITE(numout,*) '      ztilde                     ln_vvl_ztilde  = ', ln_vvl_ztilde
989         WRITE(numout,*) '      layer                      ln_vvl_layer   = ', ln_vvl_layer
990         WRITE(numout,*) '      ztilde as zstar   ln_vvl_ztilde_as_zstar  = ', ln_vvl_ztilde_as_zstar
[4292]991         WRITE(numout,*) '      ztilde near the equator    ln_vvl_zstar_at_eqtor  = ', ln_vvl_zstar_at_eqtor
[9168]992         WRITE(numout,*) '      !'
993         WRITE(numout,*) '      thickness diffusion coefficient                      rn_ahe3      = ', rn_ahe3
994         WRITE(numout,*) '      maximum e3t deformation fractional change            rn_zdef_max  = ', rn_zdef_max
[4292]995         IF( ln_vvl_ztilde_as_zstar ) THEN
[9168]996            WRITE(numout,*) '      ztilde running in zstar emulation mode (ln_vvl_ztilde_as_zstar=T) '
997            WRITE(numout,*) '         ignoring namelist timescale parameters and using:'
998            WRITE(numout,*) '            hard-wired : z-tilde to zstar restoration timescale (days)'
999            WRITE(numout,*) '                         rn_rst_e3t     = 0.e0'
1000            WRITE(numout,*) '            hard-wired : z-tilde cutoff frequency of low-pass filter (days)'
[12489]1001            WRITE(numout,*) '                         rn_lf_cutoff   = 1.0/rn_Dt'
[4292]1002         ELSE
[9168]1003            WRITE(numout,*) '      z-tilde to zstar restoration timescale (days)        rn_rst_e3t   = ', rn_rst_e3t
1004            WRITE(numout,*) '      z-tilde cutoff frequency of low-pass filter (days)   rn_lf_cutoff = ', rn_lf_cutoff
[4292]1005         ENDIF
[9168]1006         WRITE(numout,*) '         debug prints flag                                 ln_vvl_dbg   = ', ln_vvl_dbg
[4292]1007      ENDIF
[5836]1008      !
[4292]1009      ioptio = 0                      ! Parameter control
[5836]1010      IF( ln_vvl_ztilde_as_zstar )   ln_vvl_ztilde = .true.
1011      IF( ln_vvl_zstar           )   ioptio = ioptio + 1
1012      IF( ln_vvl_ztilde          )   ioptio = ioptio + 1
1013      IF( ln_vvl_layer           )   ioptio = ioptio + 1
1014      !
[4292]1015      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE vertical coordinate in namelist nam_vvl' )
[5836]1016      !
[4292]1017      IF(lwp) THEN                   ! Print the choice
1018         WRITE(numout,*)
[9168]1019         IF( ln_vvl_zstar           ) WRITE(numout,*) '      ==>>>   zstar vertical coordinate is used'
1020         IF( ln_vvl_ztilde          ) WRITE(numout,*) '      ==>>>   ztilde vertical coordinate is used'
1021         IF( ln_vvl_layer           ) WRITE(numout,*) '      ==>>>   layer vertical coordinate is used'
1022         IF( ln_vvl_ztilde_as_zstar ) WRITE(numout,*) '      ==>>>   to emulate a zstar coordinate'
[4292]1023      ENDIF
[5836]1024      !
[4486]1025#if defined key_agrif
[9190]1026      IF( (.NOT.Agrif_Root()).AND.(.NOT.ln_vvl_zstar) )   CALL ctl_stop( 'AGRIF is implemented with zstar coordinate only' )
[4486]1027#endif
[5836]1028      !
[4292]1029   END SUBROUTINE dom_vvl_ctl
1030
[592]1031   !!======================================================================
1032END MODULE domvvl
Note: See TracBrowser for help on using the repository browser.