source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/DYN/dynkeg.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 12 months ago

The Dr Hook changes from my perl code.

File size: 7.8 KB
Line 
1MODULE dynkeg
2   !!======================================================================
3   !!                       ***  MODULE  dynkeg  ***
4   !! Ocean dynamics:  kinetic energy gradient trend
5   !!======================================================================
6   !! History :  1.0  !  1987-09  (P. Andrich, M.-A. Foujols)  Original code
7   !!            7.0  !  1997-05  (G. Madec)  Split dynber into dynkeg and dynhpg
8   !!  NEMO      1.0  !  2002-07  (G. Madec)  F90: Free form and module
9   !!            3.6  !  2015-05  (N. Ducousso, G. Madec)  add Hollingsworth scheme as an option
10   !!----------------------------------------------------------------------
11   
12   !!----------------------------------------------------------------------
13   !!   dyn_keg      : update the momentum trend with the horizontal tke
14   !!----------------------------------------------------------------------
15   USE oce             ! ocean dynamics and tracers
16   USE dom_oce         ! ocean space and time domain
17   USE trd_oce         ! trends: ocean variables
18   USE trddyn          ! trend manager: dynamics
19   !
20   USE in_out_manager  ! I/O manager
21   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
22   USE lib_mpp         ! MPP library
23   USE prtctl          ! Print control
24   USE wrk_nemo        ! Memory Allocation
25   USE timing          ! Timing
26
27   USE yomhook, ONLY: lhook, dr_hook
28   USE parkind1, ONLY: jprb, jpim
29
30   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC   dyn_keg    ! routine called by step module
34   
35   INTEGER, PARAMETER, PUBLIC  ::   nkeg_C2  = 0   !: 2nd order centered scheme (standard scheme)
36   INTEGER, PARAMETER, PUBLIC  ::   nkeg_HW  = 1   !: Hollingsworth et al., QJRMS, 1983
37   !
38   REAL(wp) ::   r1_48 = 1._wp / 48._wp   !: =1/(4*2*6)
39   
40   !! * Substitutions
41#  include "vectopt_loop_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/OPA 3.6 , NEMO Consortium (2015)
44   !! $Id$
45   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   SUBROUTINE dyn_keg( kt, kscheme )
50      !!----------------------------------------------------------------------
51      !!                  ***  ROUTINE dyn_keg  ***
52      !!
53      !! ** Purpose :   Compute the now momentum trend due to the horizontal
54      !!      gradient of the horizontal kinetic energy and add it to the
55      !!      general momentum trend.
56      !!
57      !! ** Method  : * kscheme = nkeg_C2 : 2nd order centered scheme that
58      !!      conserve kinetic energy. Compute the now horizontal kinetic energy
59      !!         zhke = 1/2 [ mi-1( un^2 ) + mj-1( vn^2 ) ]
60      !!              * kscheme = nkeg_HW : Hollingsworth correction following
61      !!      Arakawa (2001). The now horizontal kinetic energy is given by:
62      !!         zhke = 1/6 [ mi-1(  2 * un^2 + ((un(j+1)+un(j-1))/2)^2  )
63      !!                    + mj-1(  2 * vn^2 + ((vn(i+1)+vn(i-1))/2)^2  ) ]
64      !!     
65      !!      Take its horizontal gradient and add it to the general momentum
66      !!      trend (ua,va).
67      !!         ua = ua - 1/e1u di[ zhke ]
68      !!         va = va - 1/e2v dj[ zhke ]
69      !!
70      !! ** Action : - Update the (ua, va) with the hor. ke gradient trend
71      !!             - send this trends to trd_dyn (l_trddyn=T) for post-processing
72      !!
73      !! ** References : Arakawa, A., International Geophysics 2001.
74      !!                 Hollingsworth et al., Quart. J. Roy. Meteor. Soc., 1983.
75      !!----------------------------------------------------------------------
76      INTEGER, INTENT( in ) ::   kt        ! ocean time-step index
77      INTEGER, INTENT( in ) ::   kscheme   ! =0/1   type of KEG scheme
78      !
79      INTEGER  ::   ji, jj, jk   ! dummy loop indices
80      REAL(wp) ::   zu, zv       ! temporary scalars
81      REAL(wp), POINTER, DIMENSION(:,:,:) :: zhke
82      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdu, ztrdv 
83      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
84      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
85      REAL(KIND=jprb)               :: zhook_handle
86
87      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_KEG'
88
89      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
90
91      !!----------------------------------------------------------------------
92      !
93      IF( nn_timing == 1 )   CALL timing_start('dyn_keg')
94      !
95      CALL wrk_alloc( jpi,jpj,jpk,   zhke )
96      !
97      IF( kt == nit000 ) THEN
98         IF(lwp) WRITE(numout,*)
99         IF(lwp) WRITE(numout,*) 'dyn_keg : kinetic energy gradient trend, scheme number=', kscheme
100         IF(lwp) WRITE(numout,*) '~~~~~~~'
101      ENDIF
102
103      IF( l_trddyn ) THEN           ! Save ua and va trends
104         CALL wrk_alloc( jpi,jpj,jpk,   ztrdu, ztrdv )
105         ztrdu(:,:,:) = ua(:,:,:) 
106         ztrdv(:,:,:) = va(:,:,:) 
107      ENDIF
108     
109      zhke(:,:,jpk) = 0._wp
110     
111      SELECT CASE ( kscheme )             !== Horizontal kinetic energy at T-point  ==!
112      !
113      CASE ( nkeg_C2 )                          !--  Standard scheme  --!
114         DO jk = 1, jpkm1
115            DO jj = 2, jpj
116               DO ji = fs_2, jpi   ! vector opt.
117                  zu =    un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)   &
118                     &  + un(ji  ,jj  ,jk) * un(ji  ,jj  ,jk)
119                  zv =    vn(ji  ,jj-1,jk) * vn(ji  ,jj-1,jk)   &
120                     &  + vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk)
121                  zhke(ji,jj,jk) = 0.25_wp * ( zv + zu )
122               END DO 
123            END DO
124         END DO
125         !
126      CASE ( nkeg_HW )                          !--  Hollingsworth scheme  --!
127         DO jk = 1, jpkm1
128            DO jj = 2, jpjm1       
129               DO ji = fs_2, jpim1   ! vector opt.
130                  zu = 8._wp * ( un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)    &
131                     &         + un(ji  ,jj  ,jk) * un(ji  ,jj  ,jk) )  &
132                     &   +     ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) ) * ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) )   &
133                     &   +     ( un(ji  ,jj-1,jk) + un(ji  ,jj+1,jk) ) * ( un(ji  ,jj-1,jk) + un(ji  ,jj+1,jk) )
134                     !
135                  zv = 8._wp * ( vn(ji  ,jj-1,jk) * vn(ji  ,jj-1,jk)    &
136                     &         + vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk) )  &
137                     &  +      ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) ) * ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) )   &
138                     &  +      ( vn(ji-1,jj  ,jk) + vn(ji+1,jj  ,jk) ) * ( vn(ji-1,jj  ,jk) + vn(ji+1,jj  ,jk) )
139                  zhke(ji,jj,jk) = r1_48 * ( zv + zu )
140               END DO 
141            END DO
142         END DO
143         CALL lbc_lnk( zhke, 'T', 1. )
144         !
145      END SELECT
146      !
147      DO jk = 1, jpkm1                    !==  grad( KE ) added to the general momentum trends  ==!
148         DO jj = 2, jpjm1
149            DO ji = fs_2, fs_jpim1   ! vector opt.
150               ua(ji,jj,jk) = ua(ji,jj,jk) - ( zhke(ji+1,jj  ,jk) - zhke(ji,jj,jk) ) / e1u(ji,jj)
151               va(ji,jj,jk) = va(ji,jj,jk) - ( zhke(ji  ,jj+1,jk) - zhke(ji,jj,jk) ) / e2v(ji,jj)
152            END DO
153         END DO
154      END DO
155      !
156      IF( l_trddyn ) THEN                 ! save the Kinetic Energy trends for diagnostic
157         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
158         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
159         CALL trd_dyn( ztrdu, ztrdv, jpdyn_keg, kt )
160         CALL wrk_dealloc( jpi,jpj,jpk,   ztrdu, ztrdv )
161      ENDIF
162      !
163      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' keg  - Ua: ', mask1=umask,   &
164         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
165      !
166      CALL wrk_dealloc( jpi,jpj,jpk,   zhke )
167      !
168      IF( nn_timing == 1 )   CALL timing_stop('dyn_keg')
169      !
170      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
171   END SUBROUTINE dyn_keg
172
173   !!======================================================================
174END MODULE dynkeg
Note: See TracBrowser for help on using the repository browser.