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 14086 for NEMO/trunk/src/OCE/DOM/domvvl.F90 – NEMO

Ignore:
Timestamp:
2020-12-04T12:37:14+01:00 (4 years ago)
Author:
cetlod
Message:

Adding AGRIF branches into the trunk

File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/src/OCE/DOM/domvvl.F90

    r14072 r14086  
    22   !!====================================================================== 
    33   !!                       ***  MODULE domvvl   *** 
    4    !! Ocean : 
     4   !! Ocean :  
    55   !!====================================================================== 
    66   !! History :  2.0  !  2006-06  (B. Levier, L. Marie)  original code 
     
    2626   USE timing          ! Timing 
    2727 
     28#if defined key_agrif 
     29   USE agrif_oce       ! initial state interpolation 
     30   USE agrif_oce_interp  
     31#endif 
     32 
    2833   IMPLICIT NONE 
    2934   PRIVATE 
     
    5863   !!   Default key      Old management of time varying vertical coordinate 
    5964   !!---------------------------------------------------------------------- 
    60  
     65    
    6166   !!---------------------------------------------------------------------- 
    6267   !!   dom_vvl_init     : define initial vertical scale factors, depths and column thickness 
     
    7378   PUBLIC  dom_vvl_sf_update  ! called by step.F90 
    7479   PUBLIC  dom_vvl_interpol   ! called by dynnxt.F90 
    75  
     80    
    7681   !! * Substitutions 
    7782#  include "do_loop_substitute.h90" 
     
    109114      !!---------------------------------------------------------------------- 
    110115      !!                ***  ROUTINE dom_vvl_init  *** 
    111       !! 
     116      !!                    
    112117      !! ** Purpose :  Initialization of all scale factors, depths 
    113118      !!               and water column heights 
     
    118123      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b) 
    119124      !!              - Regrid: e3[u/v](:,:,:,Kmm) 
    120       !!                        e3[u/v](:,:,:,Kmm) 
    121       !!                        e3w(:,:,:,Kmm) 
     125      !!                        e3[u/v](:,:,:,Kmm)        
     126      !!                        e3w(:,:,:,Kmm)            
    122127      !!                        e3[u/v]w_b 
    123       !!                        e3[u/v]w_n 
     128      !!                        e3[u/v]w_n       
    124129      !!                        gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm) and gde3w 
    125130      !!              - h(t/u/v)_0 
     
    151156      !!---------------------------------------------------------------------- 
    152157      !!                ***  ROUTINE dom_vvl_init  *** 
    153       !! 
    154       !! ** Purpose :  Interpolation of all scale factors, 
     158      !!                    
     159      !! ** Purpose :  Interpolation of all scale factors,  
    155160      !!               depths and water column heights 
    156161      !! 
     
    159164      !! ** Action  : - e3t_(n/b) and tilde_e3t_(n/b) 
    160165      !!              - Regrid: e3(u/v)_n 
    161       !!                        e3(u/v)_b 
    162       !!                        e3w_n 
    163       !!                        e3(u/v)w_b 
    164       !!                        e3(u/v)w_n 
     166      !!                        e3(u/v)_b        
     167      !!                        e3w_n            
     168      !!                        e3(u/v)w_b       
     169      !!                        e3(u/v)w_n       
    165170      !!                        gdept_n, gdepw_n and gde3w_n 
    166171      !!              - h(t/u/v)_0 
     
    180185      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3u(:,:,:,Kbb), 'U' )    ! from T to U 
    181186      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3u(:,:,:,Kmm), 'U' ) 
    182       CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3v(:,:,:,Kbb), 'V' )    ! from T to V 
     187      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3v(:,:,:,Kbb), 'V' )    ! from T to V  
    183188      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3v(:,:,:,Kmm), 'V' ) 
    184189      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F' )    ! from U to F 
    185       !                                ! Vertical interpolation of e3t,u,v 
     190      !                                ! Vertical interpolation of e3t,u,v  
    186191      CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3w (:,:,:,Kmm), 'W'  )  ! from T to W 
    187192      CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3w (:,:,:,Kbb), 'W'  ) 
     
    205210         !    zcoef = tmask - wmask    ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt 
    206211         !                             ! 1 everywhere from mbkt to mikt + 1 or 1 (if no isf) 
    207          !                             ! 0.5 where jk = mikt 
     212         !                             ! 0.5 where jk = mikt      
    208213!!gm ???????   BUG ?  gdept(:,:,:,Kmm) as well as gde3w  does not include the thickness of ISF ?? 
    209214         zcoef = ( tmask(ji,jj,jk) - wmask(ji,jj,jk) ) 
    210215         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm) 
    211216         gdept(ji,jj,jk,Kmm) =      zcoef  * ( gdepw(ji,jj,jk  ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm))  & 
    212             &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm)) 
     217            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm))  
    213218         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm) 
    214219         gdepw(ji,jj,jk,Kbb) = gdepw(ji,jj,jk-1,Kbb) + e3t(ji,jj,jk-1,Kbb) 
    215220         gdept(ji,jj,jk,Kbb) =      zcoef  * ( gdepw(ji,jj,jk  ,Kbb) + 0.5 * e3w(ji,jj,jk,Kbb))  & 
    216             &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kbb) +       e3w(ji,jj,jk,Kbb)) 
     221            &                + (1-zcoef) * ( gdept(ji,jj,jk-1,Kbb) +       e3w(ji,jj,jk,Kbb))  
    217222      END_3D 
    218223      ! 
     
    273278            IF( cn_cfg == "orca" .OR. cn_cfg == "ORCA" ) THEN 
    274279               IF( nn_cfg == 3 ) THEN   ! ORCA2: Suppress ztilde in the Foxe Basin for ORCA2 
    275                   ii0 = 103 + nn_hls - 1   ;   ii1 = 111 + nn_hls - 1 
     280                  ii0 = 103 + nn_hls - 1   ;   ii1 = 111 + nn_hls - 1       
    276281                  ij0 = 128 + nn_hls       ;   ij1 = 135 + nn_hls 
    277282                  frq_rst_e3t( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) =  0.0_wp 
     
    285290 
    286291 
    287    SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall ) 
     292   SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall )  
    288293      !!---------------------------------------------------------------------- 
    289294      !!                ***  ROUTINE dom_vvl_sf_nxt  *** 
    290       !! 
     295      !!                    
    291296      !! ** Purpose :  - compute the after scale factors used in tra_zdf, dynnxt, 
    292297      !!                 tranxt and dynspg routines 
    293298      !! 
    294299      !! ** Method  :  - z_star case:  Repartition of ssh INCREMENT proportionnaly to the level thickness. 
    295       !!               - z_tilde_case: after scale factor increment = 
     300      !!               - z_tilde_case: after scale factor increment =  
    296301      !!                                    high frequency part of horizontal divergence 
    297302      !!                                  + retsoring towards the background grid 
     
    301306      !! 
    302307      !! ** Action  :  - hdiv_lf    : restoring towards full baroclinic divergence in z_tilde case 
    303       !!               - tilde_e3t_a: after increment of vertical scale factor 
     308      !!               - tilde_e3t_a: after increment of vertical scale factor  
    304309      !!                              in z_tilde case 
    305310      !!               - e3(t/u/v)_a 
     
    405410            un_td(ji,jj,jk) = rn_ahe3 * umask(ji,jj,jk) * e2_e1u(ji,jj)           & 
    406411               &            * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji+1,jj  ,jk) ) 
    407             vn_td(ji,jj,jk) = rn_ahe3 * vmask(ji,jj,jk) * e1_e2v(ji,jj)           & 
     412            vn_td(ji,jj,jk) = rn_ahe3 * vmask(ji,jj,jk) * e1_e2v(ji,jj)           &  
    408413               &            * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji  ,jj+1,jk) ) 
    409414            zwu(ji,jj) = zwu(ji,jj) + un_td(ji,jj,jk) 
     
    450455               WRITE(numout, *) 'at i, j, k=', ijk_max 
    451456               WRITE(numout, *) 'MIN( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmin 
    452                WRITE(numout, *) 'at i, j, k=', ijk_min 
     457               WRITE(numout, *) 'at i, j, k=', ijk_min             
    453458               CALL ctl_stop( 'STOP', 'MAX( ABS( tilde_e3t_a(:,:,: ) ) / e3t_0(:,:,:) ) too high') 
    454459            ENDIF 
     
    566571      !!---------------------------------------------------------------------- 
    567572      !!                ***  ROUTINE dom_vvl_sf_update  *** 
    568       !! 
    569       !! ** Purpose :  for z tilde case: compute time filter and swap of scale factors 
     573      !!                    
     574      !! ** Purpose :  for z tilde case: compute time filter and swap of scale factors  
    570575      !!               compute all depths and related variables for next time step 
    571576      !!               write outputs and restart file 
     
    577582      !! ** Action  :  - tilde_e3t_(b/n) ready for next time step 
    578583      !!               - Recompute: 
    579       !!                    e3(u/v)_b 
    580       !!                    e3w(:,:,:,Kmm) 
    581       !!                    e3(u/v)w_b 
    582       !!                    e3(u/v)w_n 
     584      !!                    e3(u/v)_b        
     585      !!                    e3w(:,:,:,Kmm)            
     586      !!                    e3(u/v)w_b       
     587      !!                    e3(u/v)w_n       
    583588      !!                    gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm)  and gde3w 
    584589      !!                    h(u/v) and h(u/v)r 
     
    611616            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) 
    612617         ELSE 
    613             tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) & 
     618            tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) &  
    614619            &         + rn_atfp * ( tilde_e3t_b(:,:,:) - 2.0_wp * tilde_e3t_n(:,:,:) + tilde_e3t_a(:,:,:) ) 
    615620         ENDIF 
     
    623628      ! - ML - e3u(:,:,:,Kbb) and e3v(:,:,:,Kbb) are already computed in dynnxt 
    624629      ! - JC - hu(:,:,:,Kbb), hv(:,:,:,:,Kbb), hur_b, hvr_b also 
    625  
     630       
    626631      CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F'  ) 
    627  
     632       
    628633      ! Vertical scale factor interpolations 
    629634      CALL dom_vvl_interpol( e3t(:,:,:,Kmm),  e3w(:,:,:,Kmm), 'W'  ) 
     
    644649         gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm) 
    645650         gdept(ji,jj,jk,Kmm) =    zcoef  * ( gdepw(ji,jj,jk  ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm) )  & 
    646              &             + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm) ) 
     651             &             + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) +       e3w(ji,jj,jk,Kmm) )  
    647652         gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm) 
    648653      END_3D 
     
    763768      !!--------------------------------------------------------------------- 
    764769      !!                   ***  ROUTINE dom_vvl_rst  *** 
    765       !! 
     770      !!                      
    766771      !! ** Purpose :   Read or write VVL file in restart file 
    767772      !! 
     
    795800         IF( ln_rstart ) THEN                   !==  Read the restart file  ==! 
    796801            ! 
     802#if defined key_agrif 
     803            IF ( (.NOT.Agrif_root()).AND.(ln_init_chfrpar) ) THEN 
     804               ! skip reading restart if initialized from parent: 
     805               id3 = -1 ; id4 = -1 ; id5 = -1 
     806            ELSE 
     807#endif 
    797808            CALL rst_read_open                                          !*  open the restart file if necessary 
    798809            !                                         ! --------- ! 
     
    804815            id5 = iom_varid( numror, 'hdiv_lf'    , ldstop = .FALSE. ) 
    805816            ! 
     817#if defined key_agrif 
     818            ENDIF 
     819#endif 
    806820            !                                                           !*  scale factors 
    807821            IF(lwp) WRITE(numout,*)    '          Kmm scale factor read in the restart file' 
    808822            CALL iom_get( numror, jpdom_auto, 'e3t_n', e3t(:,:,:,Kmm) ) 
    809             WHERE ( tmask(:,:,:) == 0.0_wp ) 
     823            WHERE ( tmask(:,:,:) == 0.0_wp )  
    810824               e3t(:,:,:,Kmm) = e3t_0(:,:,:) 
    811825            END WHERE 
     
    816830               IF(lwp) WRITE(numout,*) '          Kbb scale factor read in the restart file' 
    817831               CALL iom_get( numror, jpdom_auto, 'e3t_b', e3t(:,:,:,Kbb) ) 
    818                WHERE ( tmask(:,:,:) == 0.0_wp ) 
     832               WHERE ( tmask(:,:,:) == 0.0_wp )  
    819833                  e3t(:,:,:,Kbb) = e3t_0(:,:,:) 
    820834               END WHERE 
     
    840854                     CALL iom_get( numror, jpdom_auto, 'tilde_e3t_b', tilde_e3t_b(:,:,:) ) 
    841855                  ENDIF 
    842                ELSE 
    843                   tilde_e3t_b(:,:,:) = 0.0_wp 
    844                   tilde_e3t_n(:,:,:) = 0.0_wp 
     856               ELSE  
     857                 tilde_e3t_b(:,:,:) = 0.0_wp 
     858                 tilde_e3t_n(:,:,:) = 0.0_wp 
    845859               ENDIF 
    846860               !                                      ! ------------ ! 
     
    850864                     CALL iom_get( numror, jpdom_auto, 'hdiv_lf', hdiv_lf(:,:,:) ) 
    851865                  ELSE                ! array is missing 
    852                      hdiv_lf(:,:,:) = 0.0_wp 
     866                     hdiv_lf(:,:,:) = 0.0_wp  
    853867                  ENDIF 
    854868               ENDIF 
     
    871885      ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN       !  Create restart file  ! 
    872886         !                                       !=======================! 
     887#if defined key_agrif 
     888         IF ( .NOT.Agrif_root().AND.(ln_init_chfrpar) ) THEN 
     889            ! Interpolate initial ssh from parent: 
     890            CALL Agrif_istate_ssh( Kbb, Kmm ) 
     891            ! 
     892            DO jk = 1, jpk 
     893               e3t(:,:,jk,Kmm) =  e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kmm)  ) & 
     894                 &                              / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk)   & 
     895                 &              + e3t_0(:,:,jk) * ( 1._wp - tmask(:,:,jk) ) 
     896            END DO 
     897            e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm) 
     898         ENDIF 
     899#endif 
    873900         ! 
    874901         IF(lwp) WRITE(numout,*) '---- dom_vvl_rst ----' 
     
    884911            CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_n', tilde_e3t_n(:,:,:)) 
    885912         END IF 
    886          !                                           ! -------------! 
     913         !                                           ! -------------!     
    887914         IF( ln_vvl_ztilde ) THEN                    ! z_tilde case ! 
    888915            !                                        ! ------------ ! 
     
    898925      !!--------------------------------------------------------------------- 
    899926      !!                  ***  ROUTINE dom_vvl_ctl  *** 
    900       !! 
     927      !!                 
    901928      !! ** Purpose :   Control the consistency between namelist options 
    902929      !!                for vertical coordinate 
     
    907934         &              ln_vvl_zstar_at_eqtor      , rn_ahe3     , rn_rst_e3t            , & 
    908935         &              rn_lf_cutoff               , rn_zdef_max , ln_vvl_dbg                ! not yet implemented: ln_vvl_kepe 
    909       !!---------------------------------------------------------------------- 
     936      !!----------------------------------------------------------------------  
    910937      ! 
    911938      READ  ( numnam_ref, nam_vvl, IOSTAT = ios, ERR = 901) 
Note: See TracChangeset for help on using the changeset viewer.