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 NEMO/branches/2020/dev_r13296_HPC-07_mocavero_mpi3/src/OCE/TRD – NEMO

source: NEMO/branches/2020/dev_r13296_HPC-07_mocavero_mpi3/src/OCE/TRD/trdken.F90 @ 13630

Last change on this file since 13630 was 13630, checked in by mocavero, 4 years ago

Add neighborhood collectives calls in the NEMO src - ticket #2496
  • Property svn:keywords set to Id
File size: 12.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 phycst         ! physical constants
16   USE sbc_oce        ! surface boundary condition: ocean
17   USE zdf_oce        ! ocean vertical physics variables
18!!gm   USE zdfdrg         ! ocean vertical physics: bottom friction
19   USE ldftra         ! ocean active tracers lateral physics
20   USE trd_oce        ! trends: ocean variables
21   USE trdvor         ! ocean vorticity trends
22   USE trdglo         ! trends:global domain averaged
23   USE trdmxl         ! ocean active mixed layer tracers trends
24   !
25   USE in_out_manager ! I/O manager
26   USE iom            ! I/O manager library
27   USE lib_mpp        ! MPP library
28   USE ldfslp         ! Isopycnal slopes
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 "do_loop_substitute.h90"
43#  include "domzgr_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
46   !! $Id$
47   !! Software governed by the CeCILL license (see ./LICENSE)
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      CALL mpp_sum ( 'trdken', trd_ken_alloc )
58      IF( trd_ken_alloc /= 0 )   CALL ctl_stop( 'STOP', 'trd_ken_alloc: failed to allocate arrays' )
59   END FUNCTION trd_ken_alloc
60
61
62   SUBROUTINE trd_ken( putrd, pvtrd, ktrd, kt, Kmm )
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[ uu(Kmm) * putrd * bu ] + mj-1[ vv(Kmm) * 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_drgimp=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      INTEGER                   , INTENT(in   ) ::   Kmm            ! time level index
84      !
85      INTEGER ::   ji, jj, jk       ! dummy loop indices
86      INTEGER ::   ikbu  , ikbv     ! local integers
87      INTEGER ::   ikbum1, ikbvm1   !   -       -
88      REAL(wp), DIMENSION(:,:), ALLOCATABLE ::   z2dx, z2dy, zke2d   ! 2D workspace
89      REAL(wp), DIMENSION(jpi,jpj,jpk)      ::   zke                 ! 3D workspace
90      !!----------------------------------------------------------------------
91      !
92#if defined key_mpi3
93      CALL lbc_lnk_nc_multi( 'trdken', putrd, 'U', -1.0_wp , pvtrd, 'V', -1.0_wp )      ! lateral boundary conditions
94#else
95      CALL lbc_lnk_multi( 'trdken', putrd, 'U', -1.0_wp , pvtrd, 'V', -1.0_wp )      ! lateral boundary conditions
96#endif
97      !
98      nkstp = kt
99      DO jk = 1, jpkm1
100         bu   (:,:,jk) =    e1e2u(:,:) * e3u(:,:,jk,Kmm)
101         bv   (:,:,jk) =    e1e2v(:,:) * e3v(:,:,jk,Kmm)
102         r1_bt(:,:,jk) = r1_e1e2t(:,:) / e3t(:,:,jk,Kmm) * tmask(:,:,jk)
103      END DO
104      !
105      zke(:,:,jpk) = 0._wp
106      zke(1,:, : ) = 0._wp
107      zke(:,1, : ) = 0._wp
108      DO_3D( 0, 1, 0, 1, 1, jpkm1 )
109         zke(ji,jj,jk) = 0.5_wp * rho0 *( uu(ji  ,jj,jk,Kmm) * putrd(ji  ,jj,jk) * bu(ji  ,jj,jk)  &
110            &                           + uu(ji-1,jj,jk,Kmm) * putrd(ji-1,jj,jk) * bu(ji-1,jj,jk)  &
111            &                           + vv(ji,jj  ,jk,Kmm) * pvtrd(ji,jj  ,jk) * bv(ji,jj  ,jk)  &
112            &                           + vv(ji,jj-1,jk,Kmm) * pvtrd(ji,jj-1,jk) * bv(ji,jj-1,jk)  ) * r1_bt(ji,jj,jk)
113      END_3D
114      !
115      SELECT CASE( ktrd )
116         CASE( jpdyn_hpg )   ;   CALL iom_put( "ketrd_hpg"   , zke )    ! hydrostatic pressure gradient
117         CASE( jpdyn_spg )   ;   CALL iom_put( "ketrd_spg"   , zke )    ! surface pressure gradient
118         CASE( jpdyn_pvo )   ;   CALL iom_put( "ketrd_pvo"   , zke )    ! planetary vorticity
119         CASE( jpdyn_rvo )   ;   CALL iom_put( "ketrd_rvo"   , zke )    ! relative  vorticity     (or metric term)
120         CASE( jpdyn_keg )   ;   CALL iom_put( "ketrd_keg"   , zke )    ! Kinetic Energy gradient (or had)
121         CASE( jpdyn_zad )   ;   CALL iom_put( "ketrd_zad"   , zke )    ! vertical   advection
122         CASE( jpdyn_ldf )   ;   CALL iom_put( "ketrd_ldf"   , zke )    ! lateral diffusion
123         CASE( jpdyn_zdf )   ;   CALL iom_put( "ketrd_zdf"   , zke )    ! vertical diffusion
124         !                   !                                          ! wind stress trends
125                                 ALLOCATE( z2dx(jpi,jpj) , z2dy(jpi,jpj) , zke2d(jpi,jpj) )
126                           z2dx(:,:) = uu(:,:,1,Kmm) * ( utau_b(:,:) + utau(:,:) ) * e1e2u(:,:) * umask(:,:,1)
127                           z2dy(:,:) = vv(:,:,1,Kmm) * ( vtau_b(:,:) + vtau(:,:) ) * e1e2v(:,:) * vmask(:,:,1)
128                           zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
129                           DO_2D( 0, 1, 0, 1 )
130                              zke2d(ji,jj) = r1_rho0 * 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
131                              &                                   + z2dy(ji,jj) + z2dy(ji,jj-1)   ) * r1_bt(ji,jj,1)
132                           END_2D
133                                 CALL iom_put( "ketrd_tau"   , zke2d )  !
134                                 DEALLOCATE( z2dx , z2dy , zke2d )
135         CASE( jpdyn_bfr )   ;   CALL iom_put( "ketrd_bfr"   , zke )    ! bottom friction (explicit case)
136!!gm TO BE DONE properly
137!!gm only valid if ln_drgimp=F otherwise the bottom stress as to be recomputed at the end of the computation....
138!         IF(.NOT. ln_drgimp) 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) = uu(ji,jj,ikbu,Kmm) * bfrua(ji,jj) * uu(ji,jj,ikbu,Kmm)
144!                  z2dy(ji,jj) = vv(ji,jj,ikbu,Kmm) * bfrva(ji,jj) * vv(ji,jj,ikbv,Kmm)
145!               END DO
146!            END DO
147!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
148!            DO jj = 2, jpj
149!               DO ji = 2, jpi
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!         ENDIF
156!!gm end
157         CASE( jpdyn_atf )   ;   CALL iom_put( "ketrd_atf"   , zke )    ! asselin filter trends
158!! a faire !!!!  idee changer dynnxt pour avoir un appel a jpdyn_bfr avant le swap !!!
159!! reflechir a une possible sauvegarde du "vrai" uu(Kmm),vv(Kmm) pour le calcul de atf....
160!
161!         IF( ln_drgimp ) THEN                                          ! bottom friction (implicit case)
162!            DO jj = 1, jpj                                                  ! after velocity known (now filed at this stage)
163!               DO ji = 1, jpi
164!                  ikbu = mbku(ji,jj)          ! deepest ocean u- & v-levels
165!                  ikbv = mbkv(ji,jj)
166!                  z2dx(ji,jj) = uu(ji,jj,ikbu,Kmm) * bfrua(ji,jj) * uu(ji,jj,ikbu,Kmm) / e3u(ji,jj,ikbu,Kmm)
167!                  z2dy(ji,jj) = uu(ji,jj,ikbu,Kmm) * bfrva(ji,jj) * vv(ji,jj,ikbv,Kmm) / e3v(ji,jj,ikbv,Kmm)
168!               END DO
169!            END DO
170!            zke2d(1,:) = 0._wp   ;   zke2d(:,1) = 0._wp
171!            DO jj = 2, jpj
172!               DO ji = 2, jpi
173!                  zke2d(ji,jj) = 0.5_wp * (   z2dx(ji,jj) + z2dx(ji-1,jj)   &
174!                     &                      + z2dy(ji,jj) + z2dy(ji,jj-1)   )
175!               END DO
176!            END DO
177!                              CALL iom_put( "ketrd_bfri", zke2d )
178!         ENDIF
179        CASE( jpdyn_ken )   ;   ! kinetic energy
180                    ! called in dynnxt.F90 before asselin time filter
181                    ! with putrd=uu(Krhs) and pvtrd=vv(Krhs)
182                    zke(:,:,:) = 0.5_wp * zke(:,:,:)
183                    CALL iom_put( "KE", zke )
184                    !
185                    CALL ken_p2k( kt , zke, Kmm )
186                      CALL iom_put( "ketrd_convP2K", zke )     ! conversion -rau*g*w
187         !
188      END SELECT
189      !
190   END SUBROUTINE trd_ken
191
192
193   SUBROUTINE ken_p2k( kt , pconv, Kmm )
194      !!---------------------------------------------------------------------
195      !!                 ***  ROUTINE ken_p2k  ***
196      !!                   
197      !! ** Purpose :   compute rate of conversion from potential to kinetic energy
198      !!
199      !! ** Method  : - compute conv defined as -rau*g*w on T-grid points
200      !!
201      !! ** Work only for full steps and partial steps (ln_hpg_zco or ln_hpg_zps)
202      !!----------------------------------------------------------------------
203      INTEGER                   , INTENT(in   ) ::   kt      ! ocean time-step index
204      INTEGER                   , INTENT(in   ) ::   Kmm     ! time level index
205      REAL(wp), DIMENSION(:,:,:), INTENT(  out) ::   pconv   !
206      !
207      INTEGER  ::   ji, jj, jk   ! dummy loop indices
208      INTEGER  ::   iku, ikv     ! local integers
209      REAL(wp) ::   zcoef        ! local scalars
210      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zconv  ! 3D workspace
211      !!----------------------------------------------------------------------
212      !
213      ! Local constant initialization
214      zcoef = - rho0 * grav * 0.5_wp     
215     
216      !  Surface value (also valid in partial step case)
217      zconv(:,:,1) = zcoef * ( 2._wp * rhd(:,:,1) ) * ww(:,:,1) * e3w(:,:,1,Kmm)
218
219      ! interior value (2=<jk=<jpkm1)
220      DO jk = 2, jpk
221         zconv(:,:,jk) = zcoef * ( rhd(:,:,jk) + rhd(:,:,jk-1) ) * ww(:,:,jk) * e3w(:,:,jk,Kmm)
222      END DO
223
224      ! conv value on T-point
225      DO_3D( 1, 1, 1, 1, 1, jpkm1 )
226         zcoef = 0.5_wp / e3t(ji,jj,jk,Kmm)
227         pconv(ji,jj,jk) = zcoef * ( zconv(ji,jj,jk) + zconv(ji,jj,jk+1) ) * tmask(ji,jj,jk)
228      END_3D
229      !
230   END SUBROUTINE ken_p2k
231
232
233   SUBROUTINE trd_ken_init
234      !!---------------------------------------------------------------------
235      !!                  ***  ROUTINE trd_ken_init  ***
236      !!
237      !! ** Purpose :   initialisation of 3D Kinetic Energy trend diagnostic
238      !!----------------------------------------------------------------------
239      INTEGER  ::   ji, jj, jk   ! dummy loop indices
240      !!----------------------------------------------------------------------
241      !
242      IF(lwp) THEN
243         WRITE(numout,*)
244         WRITE(numout,*) 'trd_ken_init : 3D Kinetic Energy trends'
245         WRITE(numout,*) '~~~~~~~~~~~~~'
246      ENDIF
247      !                           ! allocate box volume arrays
248      IF( trd_ken_alloc() /= 0 )   CALL ctl_stop('trd_ken_alloc: failed to allocate arrays')
249      !
250   END SUBROUTINE trd_ken_init
251
252   !!======================================================================
253END MODULE trdken
Note: See TracBrowser for help on using the repository browser.