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_exp_tam.F90 in branches/TAM_V3_0/NEMOTAM/OPATAM_SRC/DYN – NEMO

source: branches/TAM_V3_0/NEMOTAM/OPATAM_SRC/DYN/dynzdf_exp_tam.F90 @ 2587

Last change on this file since 2587 was 2587, checked in by vidard, 13 years ago

refer to ticket #798
File size: 8.5 KB
Line 
1MODULE dynzdf_exp_tam
2#ifdef key_tam
3   !!==============================================================================
4   !!                     ***  MODULE  dynzdf_exp_tam  ***
5   !! Ocean dynamics:  vertical component(s) of the momentum mixing trend
6   !!                 Tangent and Adjoint Module
7   !!==============================================================================
8   !! History of the direct module:
9   !!                !  90-10  (B. Blanke)  Original code
10   !!                !  97-05  (G. Madec)  vertical component of isopycnal
11   !!           8.5  !  02-08  (G. Madec)  F90: Free form and module
12   !! History of the TAM module:
13   !!           9.0  !  08-0!  (A. Vidard) Skeleton
14   !!----------------------------------------------------------------------
15
16   !!----------------------------------------------------------------------
17   !!   dyn_zdf_exp  : update the momentum trend with the vertical diffu-
18   !!                  sion using an explicit time-stepping scheme.
19   !!----------------------------------------------------------------------
20   !! * Modules used
21
22   USE par_kind      , ONLY: & ! Precision variables
23      & wp
24   USE par_oce       , ONLY: & ! Ocean space and time domain variables
25      & jpi,                 &
26      & jpj,                 & 
27      & jpk,                 & 
28      & jpim1,               &
29      & jpjm1,               & 
30      & jpkm1
31   USE oce_tam       , ONLY: & ! ocean dynamics and tracers
32      & ub_tl,               &
33      & vb_tl,               &
34      & ua_tl,               &
35      & va_tl,               &
36      & ub_ad,               &
37      & vb_ad,               &
38      & ua_ad,               &
39      & va_ad
40   USE zdf_oce       , ONLY: & ! ocean vertical physics
41      & avmu,                &
42      & avmv,                &
43      & n_zdfexp
44   USE dom_oce       , ONLY: & ! ocean space and time domain
45#if defined key_zco
46      & e3t_0,               &
47      & e3w_0,               &
48#else
49      & e3u,                 &
50      & e3v,                 &
51      & e3uw,                &
52      & e3vw,                &
53#endif
54      & umask,               &
55      & vmask
56   USE phycst        , ONLY: & ! physical constants
57      & rau0
58   USE in_out_manager, ONLY: & ! I/O manager
59      & nit000,              &
60      & nitend,              &
61      & numout,              &
62      & lwp,                 &
63      & ctl_stop
64   IMPLICIT NONE
65   PRIVATE
66
67   !! * Routine accessibility
68   PUBLIC dyn_zdf_exp_tan     ! called by dynzdf_tam.F90
69   PUBLIC dyn_zdf_exp_adj     ! called by dynzdf_tam.F90
70
71   !! * Substitutions
72#  include "domzgr_substitute.h90"
73#  include "vectopt_loop_substitute.h90"
74   !!----------------------------------------------------------------------
75
76CONTAINS
77
78   SUBROUTINE dyn_zdf_exp_tan( kt, p2dt )
79      !!----------------------------------------------------------------------
80      !!                  ***  ROUTINE dyn_zdf_exp_tan  ***
81      !!                   
82      !! ** Purpose of the direct routine:
83      !!      Compute the trend due to the vert. momentum diffusion
84      !!
85      !! ** Method of the direct routine:
86      !!      Explicit forward time stepping with a time splitting
87      !!      technique. The vertical diffusion of momentum is given by:
88      !!         diffu = dz( avmu dz(u) ) = 1/e3u dk+1( avmu/e3uw dk(ub) )
89      !!      Surface boundary conditions: wind stress input
90      !!      Bottom boundary conditions : bottom stress (cf zdfbfr.F90)
91      !!      Add this trend to the general trend ua :
92      !!         ua = ua + dz( avmu dz(u) )
93      !!
94      !! ** Action : - Update (ua,va) with the vertical diffusive trend
95      !!---------------------------------------------------------------------
96      !! * Arguments
97      INTEGER , INTENT( in ) ::   kt                           ! ocean time-step index
98      REAL(wp), INTENT( in ) ::   p2dt                         ! time-step
99
100      !! * Local declarations
101      INTEGER ::   ji, jj, jk, jl                              ! dummy loop indices
102      REAL(wp) ::   zrau0r, zlavmr, zuatl, zvatl                   ! temporary scalars
103      REAL(wp), DIMENSION(jpi,jpk) ::   zwxtl, zwytl, zwztl, zwwtl     ! temporary workspace arrays
104      !!----------------------------------------------------------------------
105
106      IF( kt == nit000 ) THEN
107         IF(lwp) WRITE(numout,*)
108         IF(lwp) WRITE(numout,*) 'dyn_zdf_exp_tan : vertical momentum diffusion explicit operator'
109         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~ '
110      ENDIF
111      ! Local constant initialization
112      ! -----------------------------
113      zrau0r = 1. / rau0                                   ! inverse of the reference density
114      zlavmr = 1. / float( n_zdfexp )                      ! inverse of the number of sub time step
115
116      !                                                ! ===============
117      DO jj = 2, jpjm1                                 !  Vertical slab
118         !                                             ! ===============
119
120         ! Surface boundary condition
121         DO ji = 2, jpim1
122            zwytl(ji,1) = 0.0_wp
123            zwwtl(ji,1) = 0.0_wp
124         END DO 
125
126         ! Initialization of x, z and contingently trends array
127         DO jk = 1, jpk
128            DO ji = 2, jpim1
129               zwxtl(ji,jk) = ub_tl(ji,jj,jk)
130               zwztl(ji,jk) = vb_tl(ji,jj,jk)
131            END DO 
132         END DO 
133
134         ! Time splitting loop
135         DO jl = 1, n_zdfexp
136
137            ! First vertical derivative
138            DO jk = 2, jpk
139               DO ji = 2, jpim1
140                  zwytl(ji,jk) = avmu(ji,jj,jk) * ( zwxtl(ji,jk-1) - zwxtl(ji,jk) ) / fse3uw(ji,jj,jk) 
141                  zwwtl(ji,jk) = avmv(ji,jj,jk) * ( zwztl(ji,jk-1) - zwztl(ji,jk) ) / fse3vw(ji,jj,jk)
142               END DO 
143            END DO 
144
145            ! Second vertical derivative and trend estimation at kt+l*rdt/n_zdfexp
146            DO jk = 1, jpkm1
147               DO ji = 2, jpim1
148                  zuatl = zlavmr*( zwytl(ji,jk) - zwytl(ji,jk+1) ) / fse3u(ji,jj,jk)
149                  zvatl = zlavmr*( zwwtl(ji,jk) - zwwtl(ji,jk+1) ) / fse3v(ji,jj,jk)
150                  ua_tl(ji,jj,jk) = ua_tl(ji,jj,jk) + zuatl
151                  va_tl(ji,jj,jk) = va_tl(ji,jj,jk) + zvatl
152
153                  zwxtl(ji,jk) = zwxtl(ji,jk) + p2dt*zuatl*umask(ji,jj,jk)
154                  zwztl(ji,jk) = zwztl(ji,jk) + p2dt*zvatl*vmask(ji,jj,jk)
155               END DO 
156            END DO 
157
158         END DO 
159
160         !                                             ! ===============
161      END DO                                           !   End of slab
162      !                                                ! ===============
163
164
165   END SUBROUTINE dyn_zdf_exp_tan
166   SUBROUTINE dyn_zdf_exp_adj( kt, p2dt )
167      !!----------------------------------------------------------------------
168      !!                  ***  ROUTINE dyn_zdf_exp_adj  ***
169      !!                   
170      !! ** Purpose of the direct routine:
171      !!      Compute the trend due to the vert. momentum diffusion
172      !!
173      !! ** Method of the direct routine:
174      !!      Explicit forward time stepping with a time splitting
175      !!      technique. The vertical diffusion of momentum is given by:
176      !!         diffu = dz( avmu dz(u) ) = 1/e3u dk+1( avmu/e3uw dk(ub) )
177      !!      Surface boundary conditions: wind stress input
178      !!      Bottom boundary conditions : bottom stress (cf zdfbfr.F90)
179      !!      Add this trend to the general trend ua :
180      !!         ua = ua + dz( avmu dz(u) )
181      !!
182      !! ** Action : - Update (ua,va) with the vertical diffusive trend
183      !!---------------------------------------------------------------------
184      !! * Arguments
185      INTEGER , INTENT( in ) ::   kt                           ! ocean time-step index
186      REAL(wp), INTENT( in ) ::   p2dt                         ! time-step
187
188      !! * Local declarations
189      INTEGER ::   ji, jj, jk, jl                              ! dummy loop indices
190      REAL(wp) ::   zrau0r, zlavmr, zua, zva                   ! temporary scalars
191      REAL(wp), DIMENSION(jpi,jpk) ::   zwx, zwy, zwz, zww     ! temporary workspace arrays
192      !!----------------------------------------------------------------------
193
194      IF( kt == nitend ) THEN
195         IF(lwp) WRITE(numout,*)
196         IF(lwp) WRITE(numout,*) 'dyn_zdf_exp_adj : vertical momentum diffusion explicit operator'
197         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~ '
198      ENDIF
199
200      CALL ctl_stop ('dyn_zdf_exp_adj not available yet')
201   END SUBROUTINE dyn_zdf_exp_adj
202#endif
203   !!==============================================================================
204END MODULE dynzdf_exp_tam
Note: See TracBrowser for help on using the repository browser.