source: branches/2015/dev_r5021_UKMO1_CICE_coupling/NEMOGCM/NEMO/OPA_SRC/TRD/trdken.F90 @ 5445

Last change on this file since 5445 was 5445, checked in by davestorkey, 5 years ago

Clear SVN keywords from 2015/dev_r5021_UKMO1_CICE_coupling branch.

File size: 13.5 KB
Line 
1MODULE trdken
2   !!======================================================================
3   !!                       ***  MODULE  trdken  ***
4   !! Ocean diagnostics:  compute and output 3D kinetic energy trends
5   !!=====================================================================
6   !! History :  3.5  !  2012-02  (G. Madec) original code
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   trd_ken       : compute and output 3D Kinetic energy trends using IOM
11   !!   trd_ken_init  : initialisation
12   !!----------------------------------------------------------------------
13   USE oce            ! ocean dynamics and tracers variables
14   USE dom_oce        ! ocean space and time domain variables
15   USE zdf_oce        ! ocean vertical physics variables
16   USE trd_oce        ! trends: ocean variables
17!!gm   USE dynhpg          ! hydrostatic pressure gradient   
18   USE zdfbfr         ! bottom friction
19   USE ldftra_oce     ! ocean active tracers lateral physics
20   USE sbc_oce        ! surface boundary condition: ocean
21   USE phycst         ! physical constants
22   USE trdvor         ! ocean vorticity trends
23   USE trdglo         ! trends:global domain averaged
24   USE trdmxl         ! ocean active mixed layer tracers trends
25   USE in_out_manager ! I/O manager
26   USE iom            ! I/O manager library
27   USE lib_mpp        ! MPP library
28   USE wrk_nemo       ! Memory allocation
29
30   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC   trd_ken       ! called by trddyn module
34   PUBLIC   trd_ken_init  ! called by trdini module
35
36   INTEGER ::   nkstp       ! current time step
37
38   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   bu, bv   ! volume of u- and v-boxes
39   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   r1_bt    ! inverse of t-box volume
40
41   !! * Substitutions
42#  include "domzgr_substitute.h90"
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
46   !! $Id$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   INTEGER FUNCTION trd_ken_alloc()
52      !!---------------------------------------------------------------------
53      !!                  ***  FUNCTION trd_ken_alloc  ***
54      !!---------------------------------------------------------------------
55      ALLOCATE( bu(jpi,jpj,jpk) , bv(jpi,jpj,jpk) , r1_bt(jpi,jpj,jpk) , STAT= trd_ken_alloc )
56      !
57      IF( lk_mpp             )   CALL mpp_sum ( trd_ken_alloc )
58      IF( trd_ken_alloc /= 0 )   CALL ctl_warn('trd_ken_alloc: failed to allocate arrays')
59   END FUNCTION trd_ken_alloc
60
61
62   SUBROUTINE trd_ken( putrd, pvtrd, ktrd, kt )
63      !!---------------------------------------------------------------------
64      !!                  ***  ROUTINE trd_ken  ***
65      !!
66      !! ** Purpose :   output 3D Kinetic Energy trends using IOM
67      !!
68      !! ** Method  : - apply lbc to the input masked velocity trends
69      !!              - compute the associated KE trend:
70      !!          zke = 0.5 * (  mi-1[ un * putrd * bu ] + mj-1[ vn * pvtrd * bv]  ) / bt
71      !!      where bu, bv, bt are the volume of u-, v- and t-boxes.
72      !!              - vertical diffusion case (jpdyn_zdf):
73      !!          diagnose separately the KE trend associated with wind stress
74      !!              - bottom friction case (jpdyn_bfr):
75      !!          explicit case (ln_bfrimp=F): bottom trend put in the 1st level
76      !!                                       of putrd, pvtrd
77      !
78      !
79      !!----------------------------------------------------------------------
80      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   putrd, pvtrd   ! U and V masked trends
81      INTEGER                   , INTENT(in   ) ::   ktrd           ! trend index
82      INTEGER                   , INTENT(in   ) ::   kt             ! time step
83      !
84      INTEGER ::   ji, jj, jk       ! dummy loop indices
85      INTEGER ::   ikbu  , ikbv     ! local integers
86      INTEGER ::   ikbum1, ikbvm1   !   -       -
87      REAL(wp), POINTER, DIMENSION(:,:)   ::   z2dx, z2dy, zke2d   ! 2D workspace
88      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zke                 ! 3D workspace
89      !!----------------------------------------------------------------------
90      !
91      CALL wrk_alloc( jpi, jpj, jpk, zke )
92      !
93      CALL lbc_lnk( putrd, 'U', -1. )   ;   CALL lbc_lnk( pvtrd, 'V', -1. )      ! lateral boundary conditions
94      !
95      IF ( lk_vvl .AND. kt /= nkstp ) THEN   ! Variable volume: set box volume at the 1st call of kt time step
96         nkstp = kt
97         DO jk = 1, jpkm1
98            bu   (:,:,jk) =  e1u(:,:) * e2u(:,:) * fse3u_n(:,:,jk)
99            bv   (:,:,jk) =  e1v(:,:) * e2v(:,:) * fse3v_n(:,:,jk)
100            r1_bt(:,:,jk) = 1._wp / ( e1e2t(:,:) * fse3t_n(:,:,jk) ) * tmask(:,:,jk)
101         END DO
102      ENDIF
103      !
104      zke(:,:,jpk) = 0._wp
105      zke(1,:, : ) = 0._wp
106      zke(:,1, : ) = 0._wp
107      DO jk = 1, jpkm1
108         DO jj = 2, jpj
109            DO ji = 2, jpi
110               zke(ji,jj,jk) = 0.5_wp * rau0 *( un(ji  ,jj,jk) * putrd(ji  ,jj,jk) * bu(ji  ,jj,jk)  &
111                  &                           + un(ji-1,jj,jk) * putrd(ji-1,jj,jk) * bu(ji-1,jj,jk)  &
112                  &                           + vn(ji,jj  ,jk) * pvtrd(ji,jj  ,jk) * bv(ji,jj  ,jk)  &
113                  &                           + vn(ji,jj-1,jk) * pvtrd(ji,jj-1,jk) * bv(ji,jj-1,jk)  ) * r1_bt(ji,jj,jk)
114            END DO
115         END DO
116      END DO
117      !
118      SELECT CASE( ktrd )
119         CASE( jpdyn_hpg )   ;   CALL iom_put( "ketrd_hpg", zke )    ! hydrostatic pressure gradient
120         CASE( jpdyn_spg )   ;   CALL iom_put( "ketrd_spg", zke )    ! surface pressure gradient
121         CASE( jpdyn_spgexp );   CALL iom_put( "ketrd_spgexp", zke ) ! surface pressure gradient (explicit)
122         CASE( jpdyn_spgflt );   CALL iom_put( "ketrd_spgflt", zke ) ! surface pressure gradient (filter)
123         CASE( jpdyn_pvo )   ;   CALL iom_put( "ketrd_pvo", zke )    ! planetary vorticity
124         CASE( jpdyn_rvo )   ;   CALL iom_put( "ketrd_rvo", zke )    ! relative  vorticity     (or metric term)
125         CASE( jpdyn_keg )   ;   CALL iom_put( "ketrd_keg", zke )    ! Kinetic Energy gradient (or had)
126         CASE( jpdyn_zad )   ;   CALL iom_put( "ketrd_zad", zke )    ! vertical   advection
127         CASE( jpdyn_ldf )   ;   CALL iom_put( "ketrd_ldf", zke )    ! lateral diffusion
128         CASE( jpdyn_zdf )   ;   CALL iom_put( "ketrd_zdf", zke )    ! vertical diffusion
129                                 !                                   ! wind stress trends
130                                 CALL wrk_alloc( jpi, jpj, z2dx, z2dy, zke2d )
131                           z2dx(:,:) = un(:,:,1) * ( utau_b(:,:) + utau(:,:) ) * e1u(:,:) * e2u(:,:) * umask(:,:,1)
132                           z2dy(:,:) = vn(:,:,1) * ( vtau_b(:,:) + vtau(:,:) ) * e1v(:,:) * e2v(:,:) * vmask(:,:,1)
133                           zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
134                           DO jj = 2, jpj
135                              DO ji = 2, jpi
136                                 zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
137                                 &                         + z2dy(ji,jj) + z2dy(ji,jj-1)   ) * r1_bt(ji,jj,1)
138                              END DO
139                           END DO
140                                 CALL iom_put( "ketrd_tau", zke2d )
141                                 CALL wrk_dealloc( jpi, jpj     , z2dx, z2dy, zke2d )
142         CASE( jpdyn_bfr )   ;   CALL iom_put( "ketrd_bfr", zke )    ! bottom friction (explicit case)
143!!gm TO BE DONE properly
144!!gm only valid if ln_bfrimp=F otherwise the bottom stress as to be recomputed at the end of the computation....
145!         IF(.NOT. ln_bfrimp) THEN
146!            DO jj = 1, jpj    !   
147!               DO ji = 1, jpi
148!                  ikbu = mbku(ji,jj)         ! deepest ocean u- & v-levels
149!                  ikbv = mbkv(ji,jj)   
150!                  z2dx(ji,jj) = un(ji,jj,ikbu) * bfrua(ji,jj) * un(ji,jj,ikbu)
151!                  z2dy(ji,jj) = vn(ji,jj,ikbu) * bfrva(ji,jj) * vn(ji,jj,ikbv)
152!               END DO
153!            END DO
154!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
155!            DO jj = 2, jpj
156!               DO ji = 2, jpi
157!                  zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
158!                     &                      + z2dy(ji,jj) + z2dy(ji,jj-1)   ) * r1_bt(ji,jj,  BEURK!!!
159!               END DO
160!            END DO
161!                              CALL iom_put( "ketrd_bfr", zke2d )    ! bottom friction (explicit case)
162!         ENDIF
163!!gm end
164         CASE( jpdyn_atf )   ;   CALL iom_put( "ketrd_atf", zke )    ! asselin filter trends
165!! a faire !!!!  idee changer dynnxt pour avoir un appel a jpdyn_bfr avant le swap !!!
166!! reflechir a une possible sauvegarde du "vrai" un,vn pour le calcul de atf....
167!
168!         IF( ln_bfrimp ) THEN                                          ! bottom friction (implicit case)
169!            DO jj = 1, jpj                                                  ! after velocity known (now filed at this stage)
170!               DO ji = 1, jpi
171!                  ikbu = mbku(ji,jj)          ! deepest ocean u- & v-levels
172!                  ikbv = mbkv(ji,jj)
173!                  z2dx(ji,jj) = un(ji,jj,ikbu) * bfrua(ji,jj) * un(ji,jj,ikbu) / fse3u(ji,jj,ikbu)
174!                  z2dy(ji,jj) = un(ji,jj,ikbu) * bfrva(ji,jj) * vn(ji,jj,ikbv) / fse3v(ji,jj,ikbv)
175!               END DO
176!            END DO
177!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
178!            DO jj = 2, jpj
179!               DO ji = 2, jpi
180!                  zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
181!                     &                      + z2dy(ji,jj) + z2dy(ji,jj-1)   )
182!               END DO
183!            END DO
184!                              CALL iom_put( "ketrd_bfri", zke2d )
185!         ENDIF
186         CASE( jpdyn_ken )   ;   ! kinetic energy
187                           ! called in dynnxt.F90 before asselin time filter
188                           ! with putrd=ua and pvtrd=va
189                           zke(:,:,:) = 0.5_wp * zke(:,:,:)
190                           CALL iom_put( "KE", zke )
191                           !
192                           CALL ken_p2k( kt , zke )
193                           CALL iom_put( "ketrd_convP2K", zke )     ! conversion -rau*g*w
194         !
195      END SELECT
196      !
197      CALL wrk_dealloc( jpi, jpj, jpk, zke )
198      !
199   END SUBROUTINE trd_ken
200
201
202   SUBROUTINE ken_p2k( kt , pconv )
203      !!---------------------------------------------------------------------
204      !!                 ***  ROUTINE ken_p2k  ***
205      !!                   
206      !! ** Purpose :   compute rate of conversion from potential to kinetic energy
207      !!
208      !! ** Method  : - compute conv defined as -rau*g*w on T-grid points
209      !!
210      !! ** Work only for full steps and partial steps (ln_hpg_zco or ln_hpg_zps)
211      !!----------------------------------------------------------------------
212      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
213      !!
214      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(  out) ::   pconv
215      !
216      INTEGER  ::   ji, jj, jk                       ! dummy loop indices
217      INTEGER  ::   iku, ikv                         ! temporary integers
218      REAL(wp) ::   zcoef                            ! temporary scalars
219      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zconv  ! temporary conv on W-grid
220      !!----------------------------------------------------------------------
221      !
222      CALL wrk_alloc( jpi,jpj,jpk, zconv )
223      !
224      ! Local constant initialization
225      zcoef = - rau0 * grav * 0.5_wp     
226     
227      !  Surface value (also valid in partial step case)
228      zconv(:,:,1) = zcoef * ( 2._wp * rhd(:,:,1) ) * wn(:,:,1) * fse3w(:,:,1)
229
230      ! interior value (2=<jk=<jpkm1)
231      DO jk = 2, jpk
232         zconv(:,:,jk) = zcoef * ( rhd(:,:,jk) + rhd(:,:,jk-1) ) * wn(:,:,jk) * fse3w(:,:,jk)
233      END DO
234
235      ! conv value on T-point
236      DO jk = 1, jpkm1
237         DO jj = 1, jpj
238            DO ji = 1, jpi
239               zcoef = 0.5_wp / fse3t(ji,jj,jk)
240               pconv(ji,jj,jk) = zcoef * ( zconv(ji,jj,jk) + zconv(ji,jj,jk+1) ) * tmask(ji,jj,jk)
241            END DO
242         END DO
243      END DO
244      !
245      CALL wrk_dealloc( jpi,jpj,jpk, zconv )     
246      !
247   END SUBROUTINE ken_p2k
248
249
250   SUBROUTINE trd_ken_init
251      !!---------------------------------------------------------------------
252      !!                  ***  ROUTINE trd_ken_init  ***
253      !!
254      !! ** Purpose :   initialisation of 3D Kinetic Energy trend diagnostic
255      !!----------------------------------------------------------------------
256      INTEGER  ::   ji, jj, jk   ! dummy loop indices
257      !!----------------------------------------------------------------------
258      !
259      IF(lwp) THEN
260         WRITE(numout,*)
261         WRITE(numout,*) 'trd_ken_init : 3D Kinetic Energy trends'
262         WRITE(numout,*) '~~~~~~~~~~~~~'
263      ENDIF
264      !                           ! allocate box volume arrays
265      IF ( trd_ken_alloc() /= 0 )   CALL ctl_stop('trd_ken_alloc: failed to allocate arrays')
266      !
267!!gm      IF( .NOT. (ln_hpg_zco.OR.ln_hpg_zps) )   &
268!!gm         &   CALL ctl_stop('trd_ken_init : only full and partial cells are coded for conversion rate')
269      !
270      IF ( .NOT.lk_vvl ) THEN     ! constant volume: bu, bv, 1/bt computed one for all
271         DO jk = 1, jpkm1
272            bu   (:,:,jk) =  e1u(:,:) * e2u(:,:) * fse3u_n(:,:,jk)
273            bv   (:,:,jk) =  e1v(:,:) * e2v(:,:) * fse3v_n(:,:,jk)
274            r1_bt(:,:,jk) = 1._wp / ( e1e2t(:,:) * fse3t_n(:,:,jk) )
275         END DO
276      ENDIF
277      !
278   END SUBROUTINE trd_ken_init
279
280   !!======================================================================
281END MODULE trdken
Note: See TracBrowser for help on using the repository browser.