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.
ldfdyn_smag.F90 in branches/UKMO/smagorinsky_diagnostics/NEMOGCM/NEMO/OPA_SRC/LDF – NEMO

source: branches/UKMO/smagorinsky_diagnostics/NEMOGCM/NEMO/OPA_SRC/LDF/ldfdyn_smag.F90 @ 5702

Last change on this file since 5702 was 5702, checked in by davestorkey, 9 years ago

Add in new diagnostics.
File size: 11.9 KB
Line 
1MODULE ldfdyn_smag
2   !!======================================================================
3   !!                     ***  MODULE  ldftrasmag  ***
4   !! Ocean physics:  variable eddy induced velocity coefficients
5   !!======================================================================
6#if   defined key_dynldf_smag   &&   defined key_dynldf_c3d
7   !!----------------------------------------------------------------------
8   !!   'key_dynldf_smag'      and           smagorinsky  diffusivity
9   !!   'key_dynldf_c3d'                    3D tracer lateral  mixing coef.
10   !!----------------------------------------------------------------------
11   !!   ldf_eiv      : compute the eddy induced velocity coefficients
12   !!----------------------------------------------------------------------
13   !! * Modules used
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE sbc_oce         ! surface boundary condition: ocean
17   USE sbcrnf          ! river runoffs
18   USE ldfdyn_oce      ! ocean tracer   lateral physics
19   USE phycst          ! physical constants
20   USE ldfslp          ! iso-neutral slopes
21   USE in_out_manager  ! I/O manager
22   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
23   USE prtctl          ! Print control
24   USE iom
25   USE wrk_nemo
26   IMPLICIT NONE
27   PRIVATE
28
29   !! * Routine accessibility
30   PUBLIC ldf_dyn_smag               ! routine called by step.F90
31   !!----------------------------------------------------------------------
32   !!  OPA 9.0 , LOCEAN-IPSL (2005)
33   !! $Id$
34   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
35   !!----------------------------------------------------------------------
36   !! * Substitutions
37#  include "domzgr_substitute.h90"
38#  include "vectopt_loop_substitute.h90"
39   !!----------------------------------------------------------------------
40
41CONTAINS
42
43
44
45
46
47   !!----------------------------------------------------------------------
48   !!                        ***  ldfdyn_smag.F90  ***
49   !!----------------------------------------------------------------------
50
51   !!----------------------------------------------------------------------
52   !!  OPA 9.0 , LOCEAN-IPSL (2005)
53   !! $Id$
54   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
55   !!----------------------------------------------------------------------
56
57   !!----------------------------------------------------------------------
58   !!   'key_dynldf_smag'             3D lateral eddy viscosity coefficients
59   !!----------------------------------------------------------------------
60
61   SUBROUTINE ldf_dyn_smag( kt )
62      !!----------------------------------------------------------------------
63      !!                  ***  ROUTINE ldf_dyn_smag  ***
64      !!                   
65      !! ** Purpose :   initializations of the horizontal ocean physics
66      !!
67      !! ** Method  :   3D eddy viscosity coef.
68      !!    M.Griffies, R.Hallberg AMS, 2000
69      !! for laplacian:
70      !!   Asmag=(C/pi)^2*dx*dy sqrt(D^2), C=3-4
71      !! for bilaplacian:
72      !!   Bsmag=Asmag*dx*dy/8
73      !!   D^2=(du/dx-dv/dy)^2+(dv/dx+du/dy)^2 for Cartesian coordinates
74      !!  in general case du/dx ==> e2 d(u/e2)/dx;  du/dy ==> e1 d(u/e1)/dy;
75      !!                  dv/dx ==> e2 d(v/e2)/dx;  dv/dy ==> e1 d(v/e1)/dy
76      !!
77      !!       laplacian operator   : ahm1, ahm2 defined at T- and F-points
78      !!                              ahm3, ahm4 never used
79      !!       bilaplacian operator : ahm1, ahm2 never used
80      !!                           :  ahm3, ahm4 defined at U- and V-points
81      !!       explanation of the default is missingi
82      !!  last modified : Maria Luneva, September 2011
83      !!----------------------------------------------------------------------
84      !! * Modules used
85      !! ahm0 here is a background viscosity
86
87      !! * Arguments
88
89      !! * local variables
90
91      INTEGER              :: kt                   ! timestep
92
93      INTEGER  ::   ji, jj, jk                     ! dummy loop indices
94      REAL (wp):: zdeltat,zdeltaf,zdeltau,zdeltav  ! temporary scalars
95      REAL (wp), POINTER, DIMENSION (:,:) ::   zux, zuy , zvx ,zvy, zue1, zue2, zve1, zve2 
96      REAL (wp)::  zcmsmag_1, zcmsmag_2 , zcmsh
97
98
99      !!----------------------------------------------------------------------
100
101      CALL wrk_alloc( jpi,jpj,zux,zuy,zvx,zvy )
102      CALL wrk_alloc( jpi,jpj,zue1,zue2,zve1,zve2 )
103
104
105      IF(  kt == nit000 ) THEN
106
107
108      IF(lwp) WRITE(numout,*)
109      IF(lwp) WRITE(numout,*) 'ldf_dyn_smag : 3D lateral eddy viscosity coefficient'
110      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
111     
112      ENDIF
113     
114      zcmsmag_1 = rn_cmsmag_1
115      zcmsmag_2 = rn_cmsmag_2
116      zcmsh     = rn_cmsh
117
118   
119
120
121      ! Set ahm1 and ahm2  ( T- and F- points) (used for laplacian operators
122      ! =================                       whatever its orientation is)
123      IF( ln_dynldf_lap ) THEN
124         ! define ahm1 and ahm2 at the right grid point position
125         ! (USER: modify ahm1 and ahm2 following your desiderata)
126         
127         DO jk=1,jpk
128           zue2(:,:)=un(:,:,jk)/e2u(:,:)
129           zve1(:,:)=vn(:,:,jk)/e1v(:,:)
130           zue1(:,:)=un(:,:,jk)/e1u(:,:)
131           zve2(:,:)=vn(:,:,jk)/e2v(:,:)
132
133 
134           DO jj=2,jpj
135            DO ji=2,jpi
136            zux(ji,jj)=(zue2(ji,jj)-zue2(ji-1,jj))/e1t(ji,jj)*e2t(ji,jj)*tmask(ji,jj,jk) * zcmsh
137            zvy(ji,jj)=(zve1(ji,jj)-zve1(ji,jj-1))/e2t(ji,jj)*e1t(ji,jj)*tmask(ji,jj,jk) * zcmsh
138            ENDDO
139           ENDDO
140
141           DO jj=1,jpjm1
142            DO ji=1,jpim1
143            zuy(ji,jj)=(zue1(ji,jj+1)-zue1(ji,jj))/e2f(ji,jj)*e1f(ji,jj)*fmask(ji,jj,jk)
144            zvx(ji,jj)=(zve2(ji+1,jj)-zve2(ji,jj))/e1f(ji,jj)*e2f(ji,jj)*fmask(ji,jj,jk)
145            ENDDO
146           ENDDO
147             
148          DO jj=2,jpjm1
149           DO ji=2,jpim1
150
151            zdeltat=2._wp /(e1t(ji,jj)**(-2)+e2t(ji,jj)**(-2))
152            zdeltaf=2._wp /(e1f(ji,jj)**(-2)+e2f(ji,jj)**(-2))   
153            ahm1(ji,jj,jk)=(zcmsmag_1/rpi)**2*zdeltat*                                         &
154                            sqrt( (zux(ji,jj)-zvy(ji,jj))**2+                                    &
155                     0.0625_wp*(zuy(ji,jj)+zuy(ji,jj-1)+zuy(ji-1,jj)+zuy(ji-1,jj-1)+             &
156                            zvx(ji,jj)+zvx(ji,jj-1)+zvx(ji-1,jj)+zvx(ji-1,jj-1))**2)
157
158            ahm2(ji,jj,jk)=(zcmsmag_1/rpi)**2*zdeltaf*                                         &
159                            sqrt( (zuy(ji,jj)+zvx(ji,jj))**2+                                    &
160                     0.0625_wp*(zux(ji,jj)+zux(ji,jj+1)+zux(ji+1,jj)+zux(ji+1,jj+1)-             &
161                             zvy(ji,jj)-zvy(ji,jj+1)-zvy(ji+1,jj)-zvy(ji+1,jj+1))**2)
162
163            ahm1(ji,jj,jk)=MAX(ahm1(ji,jj,jk),rn_ahm_0_lap)
164            ahm2(ji,jj,jk)=MAX(ahm2(ji,jj,jk),rn_ahm_0_lap)
165
166! stability criteria or upper limit set from namelist
167            ahm1(ji,jj,jk)=MIN(ahm1(ji,jj,jk),zdeltat / (16_wp*rdt),rn_ahm_m_lap)
168            ahm2(ji,jj,jk)=MIN(ahm2(ji,jj,jk),zdeltaf / (16_wp*rdt),rn_ahm_m_lap)
169
170            ENDDO
171           ENDDO
172
173         ENDDO ! jpk
174            ahm1(:,:,jpk) = ahm1(:,:,jpkm1)
175            ahm2(:,:,jpk) = ahm2(:,:,jpkm1)
176            IF(lwp.and.kt==nit000) WRITE(numout,'(36x," ahm ", 7x)')
177            DO jk = 1, jpk
178
179               IF(lwp.and.kt==nit000) WRITE(numout,'(30x,E10.2,8x,i3)') ahm1(jpi/2,jpj/2,jk), jk
180            END DO
181      CALL lbc_lnk( ahm1, 'T', 1. )   ! Lateral boundary conditions on ( ahtt )
182      CALL lbc_lnk( ahm2, 'F', 1. )   ! Lateral boundary conditions on ( ahtt )
183      CALL iom_put( 'ahmu_lap_smag', ahm1(:,:,:) ) 
184      CALL iom_put( 'ahmv_lap_smag', ahm2(:,:,:) )
185
186      ENDIF    ! ln_dynldf_lap
187     
188
189
190      ! ahm3 and ahm4 at U- and V-points (used for bilaplacian operator
191      ! ================================  whatever its orientation is)
192      ! Here: ahm is proportional to the cube of the maximum of the grid spacing
193      !       in the to horizontal direction
194
195      IF( ln_dynldf_bilap ) THEN
196         DO jk=1,jpk
197           zue2(:,:) = un(:,:,jk)/e2u(:,:)
198           zve1(:,:) = vn(:,:,jk)/e1v(:,:)
199           zue1(:,:) = un(:,:,jk)/e1u(:,:)
200           zve2(:,:) = vn(:,:,jk)/e2v(:,:)
201
202
203           DO jj=2,jpj
204            DO ji=2,jpi
205            zux(ji,jj) = (zue2(ji,jj)-zue2(ji-1,jj))/e1t(ji,jj)*e2t(ji,jj)*tmask(ji,jj,jk)
206            zvy(ji,jj) = (zve1(ji,jj)-zve1(ji,jj-1))/e2t(ji,jj)*e1t(ji,jj)*tmask(ji,jj,jk)
207            ENDDO
208           ENDDO
209
210           DO jj=1,jpjm1
211            DO ji=1,jpim1
212            zuy(ji,jj) = (zue1(ji,jj+1)-zue1(ji,jj))/e2f(ji,jj)*e1f(ji,jj)*fmask(ji,jj,jk)
213            zvx(ji,jj) = (zve2(ji+1,jj)-zve2(ji,jj))/e1f(ji,jj)*e2f(ji,jj)*fmask(ji,jj,jk)
214            ENDDO
215           ENDDO
216
217
218          DO jj=2,jpjm1
219           DO ji=2,jpim1
220            zdeltau = 2._wp/(e1u(ji,jj)**(-2)+e2u(ji,jj)**(-2))
221            zdeltav = 2._wp/(e1v(ji,jj)**(-2)+e2v(ji,jj)**(-2))
222
223            ahm3(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltau**2*                          &
224
225                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji+1,jj)-zvy(ji,jj)-zvy(ji+1,jj))**2+    &
226                              0.25_wp*(zuy(ji,jj)+zuy(ji,jj-1)+zvx(ji,jj)+zvx(ji,jj-1))**2)
227
228            ahm4(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltav**2*                           &
229
230                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji,jj+1)-zvy(ji,jj)-zvy(ji,jj+1))**2+    &
231                              0.25_wp*(zuy(ji,jj)+zuy(ji-1,jj)+zvx(ji-1,jj)+zvx(ji,jj))**2)
232
233            ahm3(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm3(ji,jj,jk) )
234            ahm4(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm4(ji,jj,jk) ) 
235
236! stability criteria or upper limit set in namelist
237
238            ahm3(ji,jj,jk) = MAX( ahm3(ji,jj,jk),-zdeltau**2/( 128._wp*rdt ),rn_ahm_m_blp )
239            ahm4(ji,jj,jk) = MAX( ahm4(ji,jj,jk),-zdeltav**2/( 128._wp*rdt ),rn_ahm_m_blp )
240           
241
242            ENDDO
243           ENDDO
244
245         ENDDO
246            ahm3(:,:,jpk) = ahm3(:,:,jpkm1)
247            ahm4(:,:,jpk) = ahm4(:,:,jpkm1)
248
249      DO jk = 1, jpk
250      IF(  kt == nit000 ) THEN
251
252               IF(lwp) WRITE(numout,'(30x,E10.2,8x,i3)') ahm3(jpi/2,jpj/2,jk), jk
253      ENDIF   
254      END DO
255      CALL lbc_lnk( ahm3, 'U', 1. )   ! Lateral boundary conditions
256      CALL lbc_lnk( ahm4, 'V', 1. )
257      CALL iom_put( 'ahmu_bilap_smag', ahm3(:,:,:) ) 
258      CALL iom_put( 'ahmv_bilap_smag', ahm4(:,:,:) )
259
260   ENDIF
261
262      CALL wrk_dealloc( jpi,jpj,zux,zuy,zvx,zvy )
263      CALL wrk_dealloc( jpi,jpj,zue1,zue2,zve1,zve2 )
264   !    zumax = MAXVAL( ABS( ahm3(:,:,:) ) )                ! slower than the following loop on NEC SX5
265      zdeltat = 0._wp
266   If(ln_dynldf_lap)THEN
267      DO jk = 1, jpk
268         DO jj = 1, jpj
269            DO ji = 1, jpi
270               zdeltat = MAX(zdeltat,ABS(ahm1(ji,jj,jk)),ABS(ahm2(ji,jj,jk)) )
271          END DO
272        END DO
273      END DO
274      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
275      !
276      IF( MOD( kt, nwrite ) == 1 .AND. lwp )   WRITE(numout,*) ' ==>> time-step= ',kt,'dynlap:  abs(ahm) max: ', zdeltat
277    ENDIF
278    If(ln_dynldf_bilap)THEN
279     zdeltat = 0._wp
280      DO jk = 1, jpk
281         DO jj = 1, jpj
282            DO ji = 1, jpi
283               zdeltat = MAX(zdeltat,ABS(ahm3(ji,jj,jk)),ABS(ahm3(ji,jj,jk)) )
284          END DO
285        END DO
286      END DO
287      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
288      !
289      IF( MOD( kt, nwrite ) == 1 .AND. lwp )   WRITE(numout,*) ' ==>> time-step= ',kt,'dyn_bilap abs(ahm) max: ', zdeltat
290      !
291   ENDIF
292      !
293
294END SUBROUTINE ldf_dyn_smag
295#else
296   !!----------------------------------------------------------------------
297   !!   Default option                                         Dummy module
298   !!----------------------------------------------------------------------
299CONTAINS
300   SUBROUTINE ldf_dyn_smag( kt )       ! Empty routine
301      WRITE(*,*) 'ldf_dyn_smag: You should not have seen this print! error? check keys ldf:c3d+smag', kt
302   END SUBROUTINE ldf_dyn_smag
303#endif
304
305   END MODULE ldfdyn_smag
306
Note: See TracBrowser for help on using the repository browser.