source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/DYN/dynbfr.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 13 months ago

The Dr Hook changes from my perl code.

File size: 5.9 KB
Line 
1MODULE dynbfr
2   !!==============================================================================
3   !!                 ***  MODULE  dynbfr  ***
4   !! Ocean dynamics :  bottom friction component of the momentum mixing trend
5   !!==============================================================================
6   !! History :  3.2  ! 2008-11  (A. C. Coward)  Original code
7   !!            3.4  ! 2011-09  (H. Liu) Make it consistent with semi-implicit
8   !!                            Bottom friction (ln_bfrimp = .true.)
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   dyn_bfr       : Update the momentum trend with the bottom friction contribution
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers variables
15   USE dom_oce        ! ocean space and time domain variables
16   USE zdf_oce        ! ocean vertical physics variables
17   USE zdfbfr         ! ocean bottom friction variables
18   USE trd_oce        ! trends: ocean variables
19   USE trddyn         ! trend manager: dynamics
20   USE in_out_manager ! I/O manager
21   USE prtctl         ! Print control
22   USE timing         ! Timing
23   USE wrk_nemo       ! Memory Allocation
24
25   USE yomhook, ONLY: lhook, dr_hook
26   USE parkind1, ONLY: jprb, jpim
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   dyn_bfr   !  routine called by step.F90
32
33   !! * Substitutions
34#  include "domzgr_substitute.h90"
35#  include "zdfddm_substitute.h90"
36#  include "vectopt_loop_substitute.h90"
37   !!----------------------------------------------------------------------
38   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
39   !! $Id$
40   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
41   !!----------------------------------------------------------------------
42CONTAINS
43   
44   SUBROUTINE dyn_bfr( kt )
45      !!----------------------------------------------------------------------
46      !!                  ***  ROUTINE dyn_bfr  ***
47      !!
48      !! ** Purpose :   compute the bottom friction ocean dynamics physics.
49      !!
50      !! ** Action  :   (ua,va)   momentum trend increased by bottom friction trend
51      !!---------------------------------------------------------------------
52      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
53      !!
54      INTEGER  ::   ji, jj       ! dummy loop indexes
55      INTEGER  ::   ikbu, ikbv   ! local integers
56      REAL(wp) ::   zm1_2dt      ! local scalar
57      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
58      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
59      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
60      REAL(KIND=jprb)               :: zhook_handle
61
62      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_BFR'
63
64      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
65
66      !!---------------------------------------------------------------------
67      !
68      IF( nn_timing == 1 )  CALL timing_start('dyn_bfr')
69      !
70!!gm issue: better to put the logical in step to control the call of zdf_bfr
71!!          ==> change the logical from ln_bfrimp to ln_bfr_exp !!
72      IF( .NOT.ln_bfrimp) THEN     ! only for explicit bottom friction form
73                                    ! implicit bfr is implemented in dynzdf_imp
74
75!!gm bug : time step is only rdt (not 2 rdt if euler start !)
76        zm1_2dt = - 1._wp / ( 2._wp * rdt )
77
78        IF( l_trddyn )   THEN                      ! temporary save of ua and va trends
79           CALL wrk_alloc( jpi,jpj,jpk, ztrdu, ztrdv )
80           ztrdu(:,:,:) = ua(:,:,:)
81           ztrdv(:,:,:) = va(:,:,:)
82        ENDIF
83
84
85        DO jj = 2, jpjm1
86           DO ji = 2, jpim1
87              ikbu = mbku(ji,jj)          ! deepest ocean u- & v-levels
88              ikbv = mbkv(ji,jj)
89              !
90              ! Apply stability criteria on absolute value  : abs(bfr/e3) < 1/(2dt) => bfr/e3 > -1/(2dt)
91              ua(ji,jj,ikbu) = ua(ji,jj,ikbu) + MAX(  bfrua(ji,jj) / fse3u(ji,jj,ikbu) , zm1_2dt  ) * ub(ji,jj,ikbu)
92              va(ji,jj,ikbv) = va(ji,jj,ikbv) + MAX(  bfrva(ji,jj) / fse3v(ji,jj,ikbv) , zm1_2dt  ) * vb(ji,jj,ikbv)
93           END DO
94        END DO
95       
96        IF ( ln_isfcav ) THEN
97           DO jj = 2, jpjm1
98              DO ji = 2, jpim1
99                 ! (ISF) stability criteria for top friction
100                 ikbu = miku(ji,jj)          ! first wet ocean u- & v-levels
101                 ikbv = mikv(ji,jj)
102                 !
103                 ! Apply stability criteria on absolute value  : abs(bfr/e3) < 1/(2dt) => bfr/e3 > -1/(2dt)
104                 ua(ji,jj,ikbu) = ua(ji,jj,ikbu) + MAX(  tfrua(ji,jj) / fse3u(ji,jj,ikbu) , zm1_2dt  ) * ub(ji,jj,ikbu) &
105                    &             * (1.-umask(ji,jj,1))
106                 va(ji,jj,ikbv) = va(ji,jj,ikbv) + MAX(  tfrva(ji,jj) / fse3v(ji,jj,ikbv) , zm1_2dt  ) * vb(ji,jj,ikbv) &
107                    &             * (1.-vmask(ji,jj,1))
108                 ! (ISF)
109              END DO
110           END DO
111        END IF
112
113        !
114        IF( l_trddyn )   THEN                      ! save the vertical diffusive trends for further diagnostics
115           ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
116           ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
117           CALL trd_dyn( ztrdu(:,:,:), ztrdv(:,:,:), jpdyn_bfr, kt )
118           CALL wrk_dealloc( jpi,jpj,jpk, ztrdu, ztrdv )
119        ENDIF
120        !                                          ! print mean trends (used for debugging)
121        IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' bfr  - Ua: ', mask1=umask,               &
122           &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
123        !
124      ENDIF     ! end explicit bottom friction
125      !
126      IF( nn_timing == 1 )  CALL timing_stop('dyn_bfr')
127      !
128      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
129   END SUBROUTINE dyn_bfr
130
131   !!==============================================================================
132END MODULE dynbfr
Note: See TracBrowser for help on using the repository browser.