source: branches/UKMO/r6232_tracer_advection/NEMOGCM/NEMO/OPA_SRC/LDF/ldfdyn_smag.F90 @ 9295

Last change on this file since 9295 was 9295, checked in by jcastill, 3 years ago

Remove svn keywords

File size: 11.7 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
184      ENDIF    ! ln_dynldf_lap
185     
186
187
188      ! ahm3 and ahm4 at U- and V-points (used for bilaplacian operator
189      ! ================================  whatever its orientation is)
190      ! Here: ahm is proportional to the cube of the maximum of the grid spacing
191      !       in the to horizontal direction
192
193      IF( ln_dynldf_bilap ) THEN
194         DO jk=1,jpk
195           zue2(:,:) = un(:,:,jk)/e2u(:,:)
196           zve1(:,:) = vn(:,:,jk)/e1v(:,:)
197           zue1(:,:) = un(:,:,jk)/e1u(:,:)
198           zve2(:,:) = vn(:,:,jk)/e2v(:,:)
199
200
201           DO jj=2,jpj
202            DO ji=2,jpi
203            zux(ji,jj) = (zue2(ji,jj)-zue2(ji-1,jj))/e1t(ji,jj)*e2t(ji,jj)*tmask(ji,jj,jk)
204            zvy(ji,jj) = (zve1(ji,jj)-zve1(ji,jj-1))/e2t(ji,jj)*e1t(ji,jj)*tmask(ji,jj,jk)
205            ENDDO
206           ENDDO
207
208           DO jj=1,jpjm1
209            DO ji=1,jpim1
210            zuy(ji,jj) = (zue1(ji,jj+1)-zue1(ji,jj))/e2f(ji,jj)*e1f(ji,jj)*fmask(ji,jj,jk)
211            zvx(ji,jj) = (zve2(ji+1,jj)-zve2(ji,jj))/e1f(ji,jj)*e2f(ji,jj)*fmask(ji,jj,jk)
212            ENDDO
213           ENDDO
214
215
216          DO jj=2,jpjm1
217           DO ji=2,jpim1
218            zdeltau = 2._wp/(e1u(ji,jj)**(-2)+e2u(ji,jj)**(-2))
219            zdeltav = 2._wp/(e1v(ji,jj)**(-2)+e2v(ji,jj)**(-2))
220
221            ahm3(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltau**2*                          &
222
223                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji+1,jj)-zvy(ji,jj)-zvy(ji+1,jj))**2+    &
224                              0.25_wp*(zuy(ji,jj)+zuy(ji,jj-1)+zvx(ji,jj)+zvx(ji,jj-1))**2)
225
226            ahm4(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltav**2*                           &
227
228                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji,jj+1)-zvy(ji,jj)-zvy(ji,jj+1))**2+    &
229                              0.25_wp*(zuy(ji,jj)+zuy(ji-1,jj)+zvx(ji-1,jj)+zvx(ji,jj))**2)
230
231            ahm3(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm3(ji,jj,jk) )
232            ahm4(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm4(ji,jj,jk) ) 
233
234! stability criteria or upper limit set in namelist
235
236            ahm3(ji,jj,jk) = MAX( ahm3(ji,jj,jk),-zdeltau**2/( 128._wp*rdt ),rn_ahm_m_blp )
237            ahm4(ji,jj,jk) = MAX( ahm4(ji,jj,jk),-zdeltav**2/( 128._wp*rdt ),rn_ahm_m_blp )
238           
239
240            ENDDO
241           ENDDO
242
243         ENDDO
244            ahm3(:,:,jpk) = ahm3(:,:,jpkm1)
245            ahm4(:,:,jpk) = ahm4(:,:,jpkm1)
246
247      DO jk = 1, jpk
248      IF(  kt == nit000 ) THEN
249
250               IF(lwp) WRITE(numout,'(30x,E10.2,8x,i3)') ahm3(jpi/2,jpj/2,jk), jk
251      ENDIF   
252      END DO
253      CALL lbc_lnk( ahm3, 'U', 1. )   ! Lateral boundary conditions
254      CALL lbc_lnk( ahm4, 'V', 1. )
255   ENDIF
256
257      CALL wrk_dealloc( jpi,jpj,zux,zuy,zvx,zvy )
258      CALL wrk_dealloc( jpi,jpj,zue1,zue2,zve1,zve2 )
259   !    zumax = MAXVAL( ABS( ahm3(:,:,:) ) )                ! slower than the following loop on NEC SX5
260      zdeltat = 0._wp
261   If(ln_dynldf_lap)THEN
262      DO jk = 1, jpk
263         DO jj = 1, jpj
264            DO ji = 1, jpi
265               zdeltat = MAX(zdeltat,ABS(ahm1(ji,jj,jk)),ABS(ahm2(ji,jj,jk)) )
266          END DO
267        END DO
268      END DO
269      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
270      !
271      IF( MOD( kt, nwrite ) == 1 .AND. lwp )   WRITE(numout,*) ' ==>> time-step= ',kt,'dynlap:  abs(ahm) max: ', zdeltat
272    ENDIF
273    If(ln_dynldf_bilap)THEN
274     zdeltat = 0._wp
275      DO jk = 1, jpk
276         DO jj = 1, jpj
277            DO ji = 1, jpi
278               zdeltat = MAX(zdeltat,ABS(ahm3(ji,jj,jk)),ABS(ahm3(ji,jj,jk)) )
279          END DO
280        END DO
281      END DO
282      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
283      !
284      IF( MOD( kt, nwrite ) == 1 .AND. lwp )   WRITE(numout,*) ' ==>> time-step= ',kt,'dyn_bilap abs(ahm) max: ', zdeltat
285      !
286   ENDIF
287      !
288
289END SUBROUTINE ldf_dyn_smag
290#else
291   !!----------------------------------------------------------------------
292   !!   Default option                                         Dummy module
293   !!----------------------------------------------------------------------
294CONTAINS
295   SUBROUTINE ldf_dyn_smag( kt )       ! Empty routine
296      WRITE(*,*) 'ldf_dyn_smag: You should not have seen this print! error? check keys ldf:c3d+smag', kt
297   END SUBROUTINE ldf_dyn_smag
298#endif
299
300   END MODULE ldfdyn_smag
301
Note: See TracBrowser for help on using the repository browser.