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.
dynkeg.F90 in branches/2014/dev_r4650_UKMO3_masked_damping/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/2014/dev_r4650_UKMO3_masked_damping/NEMOGCM/NEMO/OPA_SRC/DYN/dynkeg.F90 @ 5086

Last change on this file since 5086 was 5086, checked in by timgraham, 9 years ago

Merged head of trunk into branch in preparation for putting code back onto the trunk
In working copy ran the command:
svn merge svn+sshtimgraham@…/ipsl/forge/projets/nemo/svn/trunk

Also recompiled NEMO_book.pdf with merged input files

  • Property svn:keywords set to Id
File size: 7.3 KB
Line 
1MODULE dynkeg
2   !!======================================================================
3   !!                       ***  MODULE  dynkeg  ***
4   !! Ocean dynamics:  kinetic energy gradient trend
5   !!======================================================================
6   !! History :  1.0  !  87-09  (P. Andrich, m.-a. Foujols)  Original code
7   !!            7.0  !  97-05  (G. Madec)  Split dynber into dynkeg and dynhpg
8   !!            9.0  !  02-07  (G. Madec)  F90: Free form and module
9   !!----------------------------------------------------------------------
10   
11   !!----------------------------------------------------------------------
12   !!   dyn_keg      : update the momentum trend with the horizontal tke
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE trd_oce         ! trends: ocean variables
17   USE trddyn          ! trend manager: dynamics
18   !
19   USE in_out_manager  ! I/O manager
20   USE lib_mpp         ! MPP library
21   USE prtctl          ! Print control
22   USE wrk_nemo        ! Memory Allocation
23   USE timing          ! Timing
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   dyn_keg    ! routine called by step module
29   
30   !! * Substitutions
31#  include "vectopt_loop_substitute.h90"
32   !!----------------------------------------------------------------------
33   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
34   !! $Id$
35   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE dyn_keg( kt )
40      !!----------------------------------------------------------------------
41      !!                  ***  ROUTINE dyn_keg  ***
42      !!
43      !! ** Purpose :   Compute the now momentum trend due to the horizontal
44      !!      gradient of the horizontal kinetic energy and add it to the
45      !!      general momentum trend.
46      !!
47      !! ** Method  :   Compute the now horizontal kinetic energy
48      !!         zhke = 1/2 [ mi-1( un^2 ) + mj-1( vn^2 ) ]
49      !!      Take its horizontal gradient and add it to the general momentum
50      !!      trend (ua,va).
51      !!         ua = ua - 1/e1u di[ zhke ]
52      !!         va = va - 1/e2v dj[ zhke ]
53      !!
54      !! ** Action : - Update the (ua, va) with the hor. ke gradient trend
55      !!             - send this trends to trd_dyn (l_trddyn=T) for post-processing
56      !!----------------------------------------------------------------------
57      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
58      !
59      INTEGER  ::   ji, jj, jk   ! dummy loop indices
60      REAL(wp) ::   zu, zv       ! temporary scalars
61      REAL(wp), POINTER, DIMENSION(:,:,:) :: zhke
62      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdu, ztrdv 
63      !!----------------------------------------------------------------------
64      !
65      IF( nn_timing == 1 )  CALL timing_start('dyn_keg')
66      !
67      CALL wrk_alloc( jpi, jpj, jpk, zhke )
68      !
69      IF( kt == nit000 ) THEN
70         IF(lwp) WRITE(numout,*)
71         IF(lwp) WRITE(numout,*) 'dyn_keg : kinetic energy gradient trend'
72         IF(lwp) WRITE(numout,*) '~~~~~~~'
73      ENDIF
74
75      IF( l_trddyn ) THEN           ! Save ua and va trends
76         CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv )
77         ztrdu(:,:,:) = ua(:,:,:) 
78         ztrdv(:,:,:) = va(:,:,:) 
79      ENDIF
80     
81      !                                                ! ===============
82      DO jk = 1, jpkm1                                 ! Horizontal slab
83         !                                             ! ===============
84         DO jj = 2, jpj         ! Horizontal kinetic energy at T-point
85            DO ji = fs_2, jpi   ! vector opt.
86               zu = 0.25 * (  un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)   &
87                  &         + un(ji  ,jj  ,jk) * un(ji  ,jj  ,jk)  )
88               zv = 0.25 * (  vn(ji  ,jj-1,jk) * vn(ji  ,jj-1,jk)   &
89                  &         + vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk)  )
90               zhke(ji,jj,jk) = zv + zu
91!!gm simplier coding  ==>>   ~ faster
92!    don't forget to suppress local zu zv scalars
93!               zhke(ji,jj,jk) = 0.25 * (   un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)   &
94!                  &                      + un(ji  ,jj  ,jk) * un(ji  ,jj  ,jk)   &
95!                  &                      + vn(ji  ,jj-1,jk) * vn(ji  ,jj-1,jk)   &
96!                  &                      + vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk)   )
97!!gm end <<==
98            END DO 
99         END DO 
100         DO jj = 2, jpjm1       ! add the gradient of kinetic energy to the general momentum trends
101            DO ji = fs_2, fs_jpim1   ! vector opt.
102               ua(ji,jj,jk) = ua(ji,jj,jk) - ( zhke(ji+1,jj  ,jk) - zhke(ji,jj,jk) ) / e1u(ji,jj)
103               va(ji,jj,jk) = va(ji,jj,jk) - ( zhke(ji  ,jj+1,jk) - zhke(ji,jj,jk) ) / e2v(ji,jj)
104            END DO
105         END DO
106!!gm idea to be tested  ==>>   is it faster on scalar computers ?
107!         DO jj = 2, jpjm1       ! add the gradient of kinetic energy to the general momentum trends
108!            DO ji = fs_2, fs_jpim1   ! vector opt.
109!               ua(ji,jj,jk) = ua(ji,jj,jk) - 0.25 * ( + un(ji+1,jj  ,jk) * un(ji+1,jj  ,jk)   &
110!                  &                                   + vn(ji+1,jj-1,jk) * vn(ji+1,jj-1,jk)   &
111!                  &                                   + vn(ji+1,jj  ,jk) * vn(ji+1,jj  ,jk)   &
112!                  !
113!                  &                                   - un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)   &
114!                  &                                   - vn(ji  ,jj-1,jk) * vn(ji  ,jj-1,jk)   &
115!                  &                                   - vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk)   ) / e1u(ji,jj)
116!                  !
117!               va(ji,jj,jk) = va(ji,jj,jk) - 0.25 * (   un(ji-1,jj+1,jk) * un(ji-1,jj+1,jk)   &
118!                  &                                   + un(ji  ,jj+1,jk) * un(ji  ,jj+1,jk)   &
119!                  &                                   + vn(ji  ,jj+1,jk) * vn(ji  ,jj+1,jk)   &
120!                  !
121!                  &                                   - un(ji-1,jj  ,jk) * un(ji-1,jj  ,jk)   &
122!                  &                                   - un(ji  ,jj  ,jk) * un(ji  ,jj  ,jk)   &
123!                  &                                   - vn(ji  ,jj  ,jk) * vn(ji  ,jj  ,jk)   ) / e2v(ji,jj)
124!            END DO
125!         END DO
126!!gm en idea            <<==
127         !                                             ! ===============
128      END DO                                           !   End of slab
129      !                                                ! ===============
130
131      IF( l_trddyn ) THEN      ! save the Kinetic Energy trends for diagnostic
132         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
133         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
134         CALL trd_dyn( ztrdu, ztrdv, jpdyn_keg, kt )
135         CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv )
136      ENDIF
137      !
138      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' keg  - Ua: ', mask1=umask,   &
139         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
140      !
141      CALL wrk_dealloc( jpi, jpj, jpk, zhke )
142      !
143      IF( nn_timing == 1 )  CALL timing_stop('dyn_keg')
144      !
145   END SUBROUTINE dyn_keg
146
147   !!======================================================================
148END MODULE dynkeg
Note: See TracBrowser for help on using the repository browser.