source: branches/2012/dev_r3309_LOCEAN12_Ediag/NEMOGCM/NEMO/OPA_SRC/TRD/trdken.F90 @ 3325

Last change on this file since 3325 was 3325, checked in by gm, 9 years ago

Ediag branche: #927 add Kinetic Energy trend diagnostics (trdken.F90)

  • Property svn:keywords set to Id
File size: 10.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 zdf_oce        ! ocean vertical physics variables
16   USE trd_oce        ! trends: ocean variables
17   USE zdfbfr         ! bottom friction
18   USE ldftra_oce     ! ocean active tracers lateral physics
19   USE sbc_oce        ! surface boundary condition: ocean
20   USE phycst         ! physical constants
21   USE trdvor         ! ocean vorticity trends
22   USE trdglo         ! trends:global domain averaged
23   USE trdmld         ! ocean active mixed layer tracers trends
24   USE in_out_manager ! I/O manager
25   USE iom            ! I/O manager library
26   USE lib_mpp        ! MPP library
27   USE wrk_nemo       ! Memory allocation
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   trd_ken       ! called by trddyn module
33   PUBLIC   trd_ken_init  ! called by trdini module
34
35   INTEGER ::   nkstp       ! current time step
36   REAL(wp)::   r1_2_rau0   ! = 0.5 / rau0
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 lbc_lnk( putrd, 'U', -1. )   ;   CALL lbc_lnk( pvtrd, 'V', -1. )      ! lateral boundary conditions
92      !
93      IF ( lk_vvl .AND. kt /= nkstp ) THEN   ! Variable volume: set box volume at the 1st call of kt time step
94         nkstp = kt
95         DO jk = 1, jpkm1
96            bu   (:,:,jk) =  e1u(:,:) * e2u(:,:) * fse3u_n(:,:,jk)
97            bv   (:,:,jk) =  e1v(:,:) * e2v(:,:) * fse3v_n(:,:,jk)
98            r1_bt(:,:,jk) = 1._wp / ( e1e2t(:,:) * fse3t_n(:,:,jk) ) * tmask(:,:,jk)
99         END DO
100      ENDIF
101      !
102      zke(:,:,jpk) = 0._wp
103      zke(1,:, : ) = 0._wp
104      zke(:,1, : ) = 0._wp
105      DO jk = 1, jpkm1
106         DO jj = 2, jpj
107            DO ji = 2, jpj
108               zke(ji,jj,jk) = 0.5_wp * (   un(ji  ,jj,jk) * putrd(ji  ,jj,jk) * bu(ji  ,jj,jk)  &
109                  &                       + un(ji-1,jj,jk) * putrd(ji-1,jj,jk) * bu(ji-1,jj,jk)  &
110                  &                       + vn(ji,jj  ,jk) * pvtrd(ji,jj  ,jk) * bv(ji,jj  ,jk)  &
111                  &                       + vn(ji,jj-1,jk) * pvtrd(ji,jj-1,jk) * bv(ji,jj-1,jk)  ) * r1_bt(ji,jj,jk)
112            END DO
113         END DO
114      END DO
115      !
116      SELECT CASE( ktrd )
117      CASE( jpdyn_hpg )   ;   CALL iom_put( "ketrd_hpg", zke )    ! hydrostatic pressure gradient
118      CASE( jpdyn_spg )   ;   CALL iom_put( "ketrd_spg", zke )    ! surface pressure gradient
119      CASE( jpdyn_pvo )   ;   CALL iom_put( "ketrd_pvo", zke )    ! planetary vorticity
120      CASE( jpdyn_rvo )   ;   CALL iom_put( "ketrd_rvo", zke )    ! relative  vorticity     (or metric term)
121      CASE( jpdyn_keg )   ;   CALL iom_put( "ketrd_keg", zke )    ! Kinetic Energy gradient (or had)
122      CASE( jpdyn_zad )   ;   CALL iom_put( "ketrd_zad", zke )    ! vertical   advection
123      CASE( jpdyn_ldf )   ;   CALL iom_put( "ketrd_ldf", zke )    ! lateral diffusion
124      CASE( jpdyn_zdf )   ;   CALL iom_put( "ketrd_zdf", zke )    ! vertical diffusion
125                              !                                   ! wind stress trends
126         z2dx(:,:) = un(:,:,1) * ( utau_b(:,:) + utau(:,:) ) * e1u(:,:) * e2u(:,:) * umask(:,:,1)
127         z2dy(:,:) = vn(:,:,1) * ( vtau_b(:,:) + vtau(:,:) ) * e1v(:,:) * e2v(:,:) * vmask(:,:,1)
128         zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
129         DO jj = 2, jpj
130            DO ji = 2, jpj
131               zke2d(ji,jj) = r1_2_rau0 * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
132                  &                         + z2dy(ji,jj) + z2dy(ji,jj-1)   ) * r1_bt(ji,jj,1)
133            END DO            !
134         END DO               !
135                              CALL iom_put( "ketrd_tau", zke2d )
136      CASE( jpdyn_bfr )   ;   CALL iom_put( "ketrd_bfr", zke )    ! bottom friction (explicit)
137!!gm TO BE DONE properly
138!         IF( .NOT.ln_bfrimp ) THEN
139!            DO jj = 1, jpj    !   
140!               DO ji = 1, jpi
141!                  ikbu = mbku(ji,jj)         ! deepest ocean u- & v-levels
142!                  ikbv = mbkv(ji,jj)   
143!                  z2dx(ji,jj) = un(ji,jj,ikbu) * bfrua(ji,jj) * un(ji,jj,ikbu)
144!                  z2dy(ji,jj) = vn(ji,jj,ikbu) * bfrva(ji,jj) * vn(ji,jj,ikbv)
145!               END DO
146!            END DO
147!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
148!            DO jj = 2, jpj
149!               DO ji = 2, jpj
150!                  zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
151!                     &                      + z2dy(ji,jj) + z2dy(ji,jj-1)   ) * r1_bt(ji,jj,  BEURK!!!
152!               END DO
153!            END DO
154!                              CALL iom_put( "ketrd_bfr", zke2d )    ! bottom friction (explicit case)
155!!gm only valid if ln_bfrimp=T otherwise the bottom stress as to be recomputed at the end of the compuation....
156!         ENDIF
157!!gm end
158      CASE( jpdyn_atf )   ;   CALL iom_put( "ketrd_atf", zke )    ! asselin filter trends
159
160
161!! a faire !!!!  idee changer dynnxt pour avoir un appel a jpdynbfr avant le swap !!!
162!! reflechir à une possible sauvegarde du "vrai" un,vn pour le calcul de atf....
163!
164!         IF( ln_bfrimp ) THEN                                          ! bottom friction (implicit case)
165!            DO jj = 1, jpj                                                  ! after velocity known (now filed at this stage)
166!               DO ji = 1, jpi
167!                  ikbu = mbku(ji,jj)          ! deepest ocean u- & v-levels
168!                  ikbv = mbkv(ji,jj)
169!                  z2dx(ji,jj) = un(ji,jj,ikbu) * bfrua(ji,jj) * un(ji,jj,ikbu) / fse3u(ji,jj,ikbu)
170!                  z2dy(ji,jj) = un(ji,jj,ikbu) * bfrva(ji,jj) * vn(ji,jj,ikbv) / fse3v(ji,jj,ikbv)
171!               END DO
172!            END DO
173!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
174!            DO jj = 2, jpj
175!               DO ji = 2, jpj
176!                  zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
177!                     &                      + z2dy(ji,jj) + z2dy(ji,jj-1)   )
178!               END DO
179!            END DO
180!                              CALL iom_put( "ketrd_bfr", zke2d )
181!         ENDIF
182         !
183      END SELECT
184      !
185      CALL wrk_dealloc( jpi, jpj     , z2dx, z2dy, zke2d )
186      CALL wrk_dealloc( jpi, jpj, jpk, zke )
187      !
188   END SUBROUTINE trd_ken
189
190
191   SUBROUTINE trd_ken_init
192      !!---------------------------------------------------------------------
193      !!                  ***  ROUTINE trd_ken_init  ***
194      !!
195      !! ** Purpose :   initialisation of 3D Kinetic Energy trend diagnostic
196      !!----------------------------------------------------------------------
197      INTEGER  ::   ji, jj, jk   ! dummy loop indices
198      !!----------------------------------------------------------------------
199      !
200      IF(lwp) THEN
201         WRITE(numout,*)
202         WRITE(numout,*) 'trd_ken_init : 3D Kinetic Energy trends'
203         WRITE(numout,*) '~~~~~~~~~~~~~'
204      ENDIF
205      !                           ! allocate box volume arrays
206      IF ( trd_ken_alloc() /= 0 )   CALL ctl_stop('trd_ken_alloc: failed to allocate arrays')
207      !
208      IF ( .NOT.lk_vvl ) THEN     ! constant volume: bu, bv, 1/bt computed one for all
209         DO jk = 1, jpkm1
210            bu   (:,:,jk) =  e1u(:,:) * e2u(:,:) * fse3u_n(:,:,jk)
211            bv   (:,:,jk) =  e1v(:,:) * e2v(:,:) * fse3v_n(:,:,jk)
212            r1_bt(:,:,jk) = 1._wp / ( e1e2t(:,:) * fse3t_n(:,:,jk) )
213         END DO
214      ENDIF
215      !
216      nkstp     = 0
217      r1_2_rau0 = 0.5_wp / rau0
218      !
219   END SUBROUTINE trd_ken_init
220
221   !!======================================================================
222END MODULE trdken
Note: See TracBrowser for help on using the repository browser.