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.
dynzdf.F90 on Ticket #1584 – Attachment – NEMO

Ticket #1584: dynzdf.F90

File dynzdf.F90, 8.8 KB (added by chrenkl, 7 years ago)

Modified dynzdf.F90

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   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC   dyn_zdf       !  routine called by step.F90
34   PUBLIC   dyn_zdf_init  !  routine called by opa.F90
35
36   INTEGER  ::   nzdf = 0   ! type vertical diffusion algorithm used, defined from ln_zdf... namlist logicals
37   REAL(wp) ::   r2dt       ! time-step, = 2 rdttra except at nit000 (=rdttra) if neuler=0
38
39   !! * Substitutions
40#  include "domzgr_substitute.h90"
41#  include "zdfddm_substitute.h90"
42#  include "vectopt_loop_substitute.h90"
43   !!----------------------------------------------------------------------
44   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
45   !! $Id: dynzdf.F90 4990 2014-12-15 16:42:49Z timgraham $
46   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
47   !!----------------------------------------------------------------------
48
49CONTAINS
50   
51   SUBROUTINE dyn_zdf( kt )
52      !!----------------------------------------------------------------------
53      !!                  ***  ROUTINE dyn_zdf  ***
54      !!
55      !! ** Purpose :   compute the vertical ocean dynamics physics.
56      !!---------------------------------------------------------------------
57      !!
58      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
59      !
60      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
61! CR 20161028 --- begin ---
62      INTEGER                             ::  jk   ! dummy loop indices
63      REAL(wp)                            ::  z1_2dt 
64      REAL(wp), POINTER, DIMENSION(:,:)   ::  zue, zve
65      REAL(wp), POINTER, DIMENSION(:,:,:) ::  zua, zva 
66! CR 20161028 --- end ---
67      !!---------------------------------------------------------------------
68      !
69      IF( nn_timing == 1 )  CALL timing_start('dyn_zdf')
70! CR 20161028 --- begin ---
71!       CALL wrk_alloc( jpi,jpj,jpk, zua, zva )
72!       CALL wrk_alloc( jpi,jpj, zue, zve )
73! CR 20161028 --- end ---
74      !
75      !                                          ! set time step
76      IF( neuler == 0 .AND. kt == nit000     ) THEN   ;   r2dt =      rdt   ! = rdtra (restart with Euler time stepping)
77      ELSEIF(               kt <= nit000 + 1 ) THEN   ;   r2dt = 2. * rdt   ! = 2 rdttra (leapfrog)
78      ENDIF
79
80      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
81         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv ) 
82         ztrdu(:,:,:) = ua(:,:,:)
83         ztrdv(:,:,:) = va(:,:,:)
84      ENDIF
85
86      SELECT CASE ( nzdf )                       ! compute lateral mixing trend and add it to the general trend
87      !
88      CASE ( 0 )   ;   CALL dyn_zdf_exp( kt, r2dt )      ! explicit scheme
89      CASE ( 1 )   ;   CALL dyn_zdf_imp( kt, r2dt )      ! implicit scheme
90      !
91      CASE ( -1 )                                        ! esopa: test all possibility with control print
92                       CALL dyn_zdf_exp( kt, r2dt )
93                       CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf0 - Ua: ', mask1=umask,               &
94                          &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
95                       CALL dyn_zdf_imp( kt, r2dt )
96                       CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf1 - Ua: ', mask1=umask,               &
97                          &          tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
98      END SELECT
99
100      IF( l_trddyn )   THEN                      ! save the vertical diffusive trends for further diagnostics
101! CR 20161028         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
102! CR 20161028         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
103! CR 20161028 --- begin ---
104      ! In dyn_zdf_imp, ua & va become velocities and are not trends anymore. Thus, we have to back-calculate
105      ! in order to obtain the trend due to vertical diffusion.
106      ! Before, replace barotropic component: (copied from dynnxt.F90))
107      ! Ensure below that barotropic velocities match time splitting estimate
108      ! Compute actual transport and replace it with ts estimate at "after" time step
109         CALL wrk_alloc( jpi,jpj,jpk, zua, zva )
110         CALL wrk_alloc( jpi,jpj, zue, zve )
111         zue(:,:) = fse3u_a(:,:,1) * ua(:,:,1) * umask(:,:,1)
112         zve(:,:) = fse3v_a(:,:,1) * va(:,:,1) * vmask(:,:,1)
113         DO jk = 2, jpkm1
114            zue(:,:) = zue(:,:) + fse3u_a(:,:,jk) * ua(:,:,jk) * umask(:,:,jk)
115            zve(:,:) = zve(:,:) + fse3v_a(:,:,jk) * va(:,:,jk) * vmask(:,:,jk)
116         END DO
117         DO jk = 1, jpkm1
118            ua(:,:,jk) = ( ua(:,:,jk) - zue(:,:) * hur_a(:,:) + ua_b(:,:) ) * umask(:,:,jk)
119            va(:,:,jk) = ( va(:,:,jk) - zve(:,:) * hvr_a(:,:) + va_b(:,:) ) * vmask(:,:,jk)
120         END DO
121         !
122         z1_2dt = 1._wp / (2. * rdt)        ! Euler or leap-frog time step
123         IF( neuler == 0 .AND. kt == nit000 )   z1_2dt = 1._wp / rdt     
124         !
125         zua(:,:,:) = ( ua(:,:,:) - ub(:,:,:) ) * z1_2dt - ztrdu
126         zva(:,:,:) = ( va(:,:,:) - vb(:,:,:) ) * z1_2dt - ztrdv
127         CALL trd_dyn( zua, zva, jpdyn_zdf, kt )
128         CALL wrk_dealloc( jpi,jpj,jpk, zua, zva )
129         CALL wrk_dealloc( jpi,jpj, zue, zve )
130! CR 20161028 --- end ---
131! CR 20161031         CALL trd_dyn( ztrdu, ztrdv, jpdyn_zdf, kt )
132         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv ) 
133      ENDIF
134      !                                          ! print mean trends (used for debugging)
135      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' zdf  - Ua: ', mask1=umask,               &
136            &                    tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
137      !
138      IF( nn_timing == 1 )  CALL timing_stop('dyn_zdf')
139      !
140   END SUBROUTINE dyn_zdf
141
142
143   SUBROUTINE dyn_zdf_init
144      !!----------------------------------------------------------------------
145      !!                 ***  ROUTINE dyn_zdf_init  ***
146      !!
147      !! ** Purpose :   initializations of the vertical diffusion scheme
148      !!
149      !! ** Method  :   implicit (euler backward) scheme (default)
150      !!                explicit (time-splitting) scheme if ln_zdfexp=T
151      !!----------------------------------------------------------------------
152      USE zdftke
153      USE zdfgls
154      USE zdfkpp
155      !!----------------------------------------------------------------------
156      !
157      ! Choice from ln_zdfexp read in namelist in zdfini
158      IF( ln_zdfexp ) THEN   ;   nzdf = 0           ! use explicit scheme
159      ELSE                   ;   nzdf = 1           ! use implicit scheme
160      ENDIF
161      !
162      ! Force implicit schemes
163      IF( lk_zdftke .OR. lk_zdfgls .OR. lk_zdfkpp )   nzdf = 1   ! TKE, GLS or KPP physics
164      IF( ln_dynldf_iso                           )   nzdf = 1   ! iso-neutral lateral physics
165      IF( ln_dynldf_hor .AND. ln_sco              )   nzdf = 1   ! horizontal lateral physics in s-coordinate
166      !
167      IF( lk_esopa )    nzdf = -1                   ! Esopa key: All schemes used
168      !
169      IF(lwp) THEN                                  ! Print the choice
170         WRITE(numout,*)
171         WRITE(numout,*) 'dyn_zdf_init : vertical dynamics physics scheme'
172         WRITE(numout,*) '~~~~~~~~~~~'
173         IF( nzdf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
174         IF( nzdf ==  0 )   WRITE(numout,*) '              Explicit time-splitting scheme'
175         IF( nzdf ==  1 )   WRITE(numout,*) '              Implicit (euler backward) scheme'
176      ENDIF
177      !
178   END SUBROUTINE dyn_zdf_init
179
180   !!==============================================================================
181END MODULE dynzdf