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

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

The Dr Hook changes from my perl code.

File size: 7.5 KB
Line 
1MODULE dynzdf
2   !!==============================================================================
3   !!                 ***  MODULE  dynzdf  ***
4   !! Ocean dynamics :  vertical component of the momentum mixing trend
5   !!==============================================================================
6   !! History :  1.0  !  2005-11  (G. Madec)  Original code
7   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   dyn_zdf      : Update the momentum trend with the vertical diffusion
12   !!   dyn_zdf_init : initializations of the vertical diffusion scheme
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
18   USE dynzdf_exp      ! vertical diffusion: explicit (dyn_zdf_exp     routine)
19   USE dynzdf_imp      ! vertical diffusion: implicit (dyn_zdf_imp     routine)
20
21   USE ldfdyn_oce      ! ocean dynamics: lateral physics
22   USE trd_oce         ! trends: ocean variables
23   USE trddyn          ! trend manager: dynamics
24   USE in_out_manager  ! I/O manager
25   USE lib_mpp         ! MPP library
26   USE prtctl          ! Print control
27   USE wrk_nemo        ! Memory Allocation
28   USE timing          ! Timing
29
30   USE yomhook, ONLY: lhook, dr_hook
31   USE parkind1, ONLY: jprb, jpim
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   dyn_zdf       !  routine called by step.F90
37   PUBLIC   dyn_zdf_init  !  routine called by opa.F90
38
39   INTEGER  ::   nzdf = 0   ! type vertical diffusion algorithm used, defined from ln_zdf... namlist logicals
40   REAL(wp) ::   r2dt       ! time-step, = 2 rdttra except at nit000 (=rdttra) if neuler=0
41
42   !! * Substitutions
43#  include "domzgr_substitute.h90"
44#  include "zdfddm_substitute.h90"
45#  include "vectopt_loop_substitute.h90"
46   !!----------------------------------------------------------------------
47   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
48   !! $Id$
49   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
51
52CONTAINS
53   
54   SUBROUTINE dyn_zdf( kt )
55      !!----------------------------------------------------------------------
56      !!                  ***  ROUTINE dyn_zdf  ***
57      !!
58      !! ** Purpose :   compute the vertical ocean dynamics physics.
59      !!---------------------------------------------------------------------
60      !!
61      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
62      !
63      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
64      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
65      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
66      REAL(KIND=jprb)               :: zhook_handle
67
68      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_ZDF'
69
70      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
71
72      !!---------------------------------------------------------------------
73      !
74      IF( nn_timing == 1 )  CALL timing_start('dyn_zdf')
75      !
76      !                                          ! set time step
77      IF( neuler == 0 .AND. kt == nit000     ) THEN   ;   r2dt =      rdt   ! = rdtra (restart with Euler time stepping)
78      ELSEIF(               kt <= nit000 + 1 ) THEN   ;   r2dt = 2. * rdt   ! = 2 rdttra (leapfrog)
79      ENDIF
80
81      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
82         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv ) 
83         ztrdu(:,:,:) = ua(:,:,:)
84         ztrdv(:,:,:) = va(:,:,:)
85      ENDIF
86
87      SELECT CASE ( nzdf )                       ! compute lateral mixing trend and add it to the general trend
88      !
89      CASE ( 0 )   ;   CALL dyn_zdf_exp( kt, r2dt )      ! explicit scheme
90      CASE ( 1 )   ;   CALL dyn_zdf_imp( kt, r2dt )      ! implicit scheme
91      !
92      CASE ( -1 )                                        ! esopa: test all possibility with control print
93                       CALL dyn_zdf_exp( kt, r2dt )
94                       CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf0 - Ua: ', mask1=umask,               &
95                          &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
96                       CALL dyn_zdf_imp( kt, r2dt )
97                       CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf1 - Ua: ', mask1=umask,               &
98                          &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
99      END SELECT
100
101      IF( l_trddyn )   THEN                      ! save the vertical diffusive trends for further diagnostics
102         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
103         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
104         CALL trd_dyn( ztrdu, ztrdv, jpdyn_zdf, kt )
105         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv ) 
106      ENDIF
107      !                                          ! print mean trends (used for debugging)
108      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf  - Ua: ', mask1=umask,               &
109            &                    tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
110      !
111      IF( nn_timing == 1 )  CALL timing_stop('dyn_zdf')
112      !
113      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
114   END SUBROUTINE dyn_zdf
115
116
117   SUBROUTINE dyn_zdf_init
118      !!----------------------------------------------------------------------
119      !!                 ***  ROUTINE dyn_zdf_init  ***
120      !!
121      !! ** Purpose :   initializations of the vertical diffusion scheme
122      !!
123      !! ** Method  :   implicit (euler backward) scheme (default)
124      !!                explicit (time-splitting) scheme if ln_zdfexp=T
125      !!----------------------------------------------------------------------
126      USE zdftke
127      USE zdfgls
128      USE zdfkpp
129      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
130      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
131      REAL(KIND=jprb)               :: zhook_handle
132
133      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_ZDF_INIT'
134
135      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
136
137      !!----------------------------------------------------------------------
138      !
139      ! Choice from ln_zdfexp read in namelist in zdfini
140      IF( ln_zdfexp ) THEN   ;   nzdf = 0           ! use explicit scheme
141      ELSE                   ;   nzdf = 1           ! use implicit scheme
142      ENDIF
143      !
144      ! Force implicit schemes
145      IF( lk_zdftke .OR. lk_zdfgls .OR. lk_zdfkpp )   nzdf = 1   ! TKE, GLS or KPP physics
146      IF( ln_dynldf_iso                           )   nzdf = 1   ! iso-neutral lateral physics
147      IF( ln_dynldf_hor .AND. ln_sco              )   nzdf = 1   ! horizontal lateral physics in s-coordinate
148      !
149      IF( lk_esopa )    nzdf = -1                   ! Esopa key: All schemes used
150      !
151      IF(lwp) THEN                                  ! Print the choice
152         WRITE(numout,*)
153         WRITE(numout,*) 'dyn_zdf_init : vertical dynamics physics scheme'
154         WRITE(numout,*) '~~~~~~~~~~~'
155         IF( nzdf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
156         IF( nzdf ==  0 )   WRITE(numout,*) '              Explicit time-splitting scheme'
157         IF( nzdf ==  1 )   WRITE(numout,*) '              Implicit (euler backward) scheme'
158      ENDIF
159      !
160      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
161   END SUBROUTINE dyn_zdf_init
162
163   !!==============================================================================
164END MODULE dynzdf
Note: See TracBrowser for help on using the repository browser.