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.
trdken.F90 in trunk/NEMOGCM/NEMO/OPA_SRC/TRD – NEMO

source: trunk/NEMOGCM/NEMO/OPA_SRC/TRD/trdken.F90 @ 5836

Last change on this file since 5836 was 5836, checked in by cetlod, 9 years ago

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