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.
Changeset 12482 for NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/OCE/DOM/domvvl.F90 – NEMO

Ignore:
Timestamp:
2020-02-28T11:26:52+01:00 (4 years ago)
Author:
techene
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/OCE/DOM/domvvl.F90

    r12377 r12482  
    22   !!====================================================================== 
    33   !!                       ***  MODULE domvvl   *** 
    4    !! Ocean :  
     4   !! Ocean : 
    55   !!====================================================================== 
    66   !! History :  2.0  !  2006-06  (B. Levier, L. Marie)  original code 
     
    99   !!            3.6  !  2014-11  (P. Mathiot) add ice shelf capability 
    1010   !!            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) introduce ssh to h0 ratio 
    1112   !!---------------------------------------------------------------------- 
    1213 
     
    9899      !!---------------------------------------------------------------------- 
    99100      !!                ***  ROUTINE dom_vvl_init  *** 
    100       !!                    
     101      !! 
    101102      !! ** Purpose :  Initialization of all scale factors, depths 
    102103      !!               and water column heights 
     
    107108      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b) 
    108109      !!              - Regrid: e3[u/v](:,:,:,Kmm) 
    109       !!                        e3[u/v](:,:,:,Kmm)        
    110       !!                        e3w(:,:,:,Kmm)            
     110      !!                        e3[u/v](:,:,:,Kmm) 
     111      !!                        e3w(:,:,:,Kmm) 
    111112      !!                        e3[u/v]w_b 
    112       !!                        e3[u/v]w_n       
     113      !!                        e3[u/v]w_n 
    113114      !!                        gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm) and gde3w 
    114115      !!              - h(t/u/v)_0 
     
    139140      !!---------------------------------------------------------------------- 
    140141      !!                ***  ROUTINE dom_vvl_init  *** 
    141       !!                    
    142       !! ** Purpose :  Interpolation of all scale factors,  
     142      !! 
     143      !! ** Purpose :  Interpolation of all scale factors, 
    143144      !!               depths and water column heights 
    144145      !! 
     
    147148      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b) 
    148149      !!              - 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       
     150      !!                        e3(u/v)_b 
     151      !!                        e3w_n 
     152      !!                        e3(u/v)w_b 
     153      !!                        e3(u/v)w_n 
    153154      !!                        gdept_n, gdepw_n and gde3w_n 
    154155      !!              - h(t/u/v)_0 
     
    168169      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3u(:,:,:,Kbb), 'U' )    ! from T to U 
    169170      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(:,:,:,Kbb), e3v(:,:,:,Kbb), 'V' )    ! from T to V 
    171172      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3v(:,:,:,Kmm), 'V' ) 
    172173      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F' )    ! from U to F 
    173       !                                ! Vertical interpolation of e3t,u,v  
     174      !                                ! Vertical interpolation of e3t,u,v 
    174175      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3w (:,:,:,Kmm), 'W'  )  ! from T to W 
    175176      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3w (:,:,:,Kbb), 'W'  ) 
     
    193194         !    zcoef = tmask - wmask    ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt 
    194195         !                             ! 1 everywhere from mbkt to mikt + 1 or 1 (if no isf) 
    195          !                             ! 0.5 where jk = mikt      
     196         !                             ! 0.5 where jk = mikt 
    196197!!gm ???????   BUG ?  gdept(:,:,:,Kmm) as well as gde3w  does not include the thickness of ISF ?? 
    197198         zcoef = ( tmask(ji,jj,jk) - wmask(ji,jj,jk) ) 
    198199         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm) 
    199200         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            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm)) 
    201202         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm) 
    202203         gdepw(ji,jj,jk,Kbb) = gdepw(ji,jj,jk-1,Kbb) + e3t(ji,jj,jk-1,Kbb) 
    203204         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            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kbb) +       e3w(ji,jj,jk,Kbb)) 
    205206      END_3D 
    206207      ! 
     
    261262            IF( cn_cfg == "orca" .OR. cn_cfg == "ORCA" ) THEN 
    262263               IF( nn_cfg == 3 ) THEN   ! ORCA2: Suppress ztilde in the Foxe Basin for ORCA2 
    263                   ii0 = 103   ;   ii1 = 111        
    264                   ij0 = 128   ;   ij1 = 135   ;    
     264                  ii0 = 103   ;   ii1 = 111 
     265                  ij0 = 128   ;   ij1 = 135   ; 
    265266                  frq_rst_e3t( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) =  0.0_wp 
    266267                  frq_rst_hdv( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) =  1.e0_wp / rdt 
     
    280281            CALL iom_set_rstw_var_active('tilde_e3t_n') 
    281282         END IF 
    282          !                                           ! -------------!     
     283         !                                           ! -------------! 
    283284         IF( ln_vvl_ztilde ) THEN                    ! z_tilde case ! 
    284285            !                                        ! ------------ ! 
     
    291292 
    292293 
    293    SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall )  
     294   SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall ) 
    294295      !!---------------------------------------------------------------------- 
    295296      !!                ***  ROUTINE dom_vvl_sf_nxt  *** 
    296       !!                    
     297      !! 
    297298      !! ** Purpose :  - compute the after scale factors used in tra_zdf, dynnxt, 
    298299      !!                 tranxt and dynspg routines 
    299300      !! 
    300301      !! ** Method  :  - z_star case:  Repartition of ssh INCREMENT proportionnaly to the level thickness. 
    301       !!               - z_tilde_case: after scale factor increment =  
     302      !!               - z_tilde_case: after scale factor increment = 
    302303      !!                                    high frequency part of horizontal divergence 
    303304      !!                                  + retsoring towards the background grid 
     
    307308      !! 
    308309      !! ** Action  :  - hdiv_lf    : restoring towards full baroclinic divergence in z_tilde case 
    309       !!               - tilde_e3t_a: after increment of vertical scale factor  
     310      !!               - tilde_e3t_a: after increment of vertical scale factor 
    310311      !!                              in z_tilde case 
    311312      !!               - e3(t/u/v)_a 
     
    410411            un_td(ji,jj,jk) = rn_ahe3 * umask(ji,jj,jk) * e2_e1u(ji,jj)           & 
    411412               &            * ( 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            vn_td(ji,jj,jk) = rn_ahe3 * vmask(ji,jj,jk) * e1_e2v(ji,jj)           & 
    413414               &            * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji  ,jj+1,jk) ) 
    414415            zwu(ji,jj) = zwu(ji,jj) + un_td(ji,jj,jk) 
     
    467468               WRITE(numout, *) 'at i, j, k=', ijk_max 
    468469               WRITE(numout, *) 'MIN( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmin 
    469                WRITE(numout, *) 'at i, j, k=', ijk_min             
     470               WRITE(numout, *) 'at i, j, k=', ijk_min 
    470471               CALL ctl_stop( 'STOP', 'MAX( ABS( tilde_e3t_a(:,:,: ) ) / e3t_0(:,:,:) ) too high') 
    471472            ENDIF 
     
    582583      !!---------------------------------------------------------------------- 
    583584      !!                ***  ROUTINE dom_vvl_sf_update  *** 
    584       !!                    
    585       !! ** Purpose :  for z tilde case: compute time filter and swap of scale factors  
     585      !! 
     586      !! ** Purpose :  for z tilde case: compute time filter and swap of scale factors 
    586587      !!               compute all depths and related variables for next time step 
    587588      !!               write outputs and restart file 
     
    593594      !! ** Action  :  - tilde_e3t_(b/n) ready for next time step 
    594595      !!               - Recompute: 
    595       !!                    e3(u/v)_b        
    596       !!                    e3w(:,:,:,Kmm)            
    597       !!                    e3(u/v)w_b       
    598       !!                    e3(u/v)w_n       
     596      !!                    e3(u/v)_b 
     597      !!                    e3w(:,:,:,Kmm) 
     598      !!                    e3(u/v)w_b 
     599      !!                    e3(u/v)w_n 
    599600      !!                    gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm)  and gde3w 
    600601      !!                    h(u/v) and h(u/v)r 
     
    627628            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) 
    628629         ELSE 
    629             tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) &  
     630            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) & 
    630631            &         + atfp * ( tilde_e3t_b(:,:,:) - 2.0_wp * tilde_e3t_n(:,:,:) + tilde_e3t_a(:,:,:) ) 
    631632         ENDIF 
     
    639640      ! - ML - e3u(:,:,:,Kbb) and e3v(:,:,:,Kbb) are already computed in dynnxt 
    640641      ! - JC - hu(:,:,:,Kbb), hv(:,:,:,:,Kbb), hur_b, hvr_b also 
    641        
     642 
    642643      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F'  ) 
    643        
     644 
    644645      ! Vertical scale factor interpolations 
    645646      CALL dom_vvl_interpol( e3t(:,:,:,Kmm),  e3w(:,:,:,Kmm), 'W'  ) 
     
    660661         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm) 
    661662         gdept(ji,jj,jk,Kmm) =    zcoef  * ( gdepw(ji,jj,jk  ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm) )  & 
    662              &             + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm) )  
     663             &             + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm) ) 
    663664         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm) 
    664665      END_3D 
     
    779780      !!--------------------------------------------------------------------- 
    780781      !!                   ***  ROUTINE dom_vvl_rst  *** 
    781       !!                      
     782      !! 
    782783      !! ** Purpose :   Read or write VVL file in restart file 
    783784      !! 
     
    796797      !!---------------------------------------------------------------------- 
    797798      ! 
    798       IF( TRIM(cdrw) == 'READ' ) THEN        ! Read/initialise  
     799      IF( TRIM(cdrw) == 'READ' ) THEN        ! Read/initialise 
    799800         !                                   ! =============== 
    800801         IF( ln_rstart ) THEN                   !* Read the restart file 
     
    815816               CALL iom_get( numror, jpdom_autoglo, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lrxios ) 
    816817               CALL iom_get( numror, jpdom_autoglo, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lrxios ) 
    817                ! needed to restart if land processor not computed  
     818               ! needed to restart if land processor not computed 
    818819               IF(lwp) write(numout,*) 'dom_vvl_rst : e3t(:,:,:,Kbb) and e3t(:,:,:,Kmm) found in restart files' 
    819                WHERE ( tmask(:,:,:) == 0.0_wp )  
     820               WHERE ( tmask(:,:,:) == 0.0_wp ) 
    820821                  e3t(:,:,:,Kmm) = e3t_0(:,:,:) 
    821822                  e3t(:,:,:,Kbb) = e3t_0(:,:,:) 
     
    880881            ! 
    881882 
    882             IF( ll_wd ) THEN   ! MJB ll_wd edits start here - these are essential  
     883            IF( ll_wd ) THEN   ! MJB ll_wd edits start here - these are essential 
    883884               ! 
    884885               IF( cn_cfg == 'wad' ) THEN 
     
    915916                       CALL ctl_stop( 'dom_vvl_rst: ht_0 must be positive at potentially wet points' ) 
    916917                     ENDIF 
    917                   END DO  
    918                END DO  
     918                  END DO 
     919               END DO 
    919920               ! 
    920921            ELSE 
     
    957958            CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_n', tilde_e3t_n(:,:,:), ldxios = lwxios) 
    958959         END IF 
    959          !                                           ! -------------!     
     960         !                                           ! -------------! 
    960961         IF( ln_vvl_ztilde ) THEN                    ! z_tilde case ! 
    961962            !                                        ! ------------ ! 
     
    972973      !!--------------------------------------------------------------------- 
    973974      !!                  ***  ROUTINE dom_vvl_ctl  *** 
    974       !!                 
     975      !! 
    975976      !! ** Purpose :   Control the consistency between namelist options 
    976977      !!                for vertical coordinate 
     
    981982         &              ln_vvl_zstar_at_eqtor      , rn_ahe3     , rn_rst_e3t            , & 
    982983         &              rn_lf_cutoff               , rn_zdef_max , ln_vvl_dbg                ! not yet implemented: ln_vvl_kepe 
    983       !!----------------------------------------------------------------------  
     984      !!---------------------------------------------------------------------- 
    984985      ! 
    985986      READ  ( numnam_ref, nam_vvl, IOSTAT = ios, ERR = 901) 
Note: See TracChangeset for help on using the changeset viewer.