source: branches/UKMO/dev_r5518_GO6_package_text_diagnostics/NEMOGCM/NEMO/OPA_SRC/LDF/ldfdyn_smag.F90 @ 10774

Last change on this file since 10774 was 10774, checked in by andmirek, 20 months ago

GMED 450 add flush after prints

File size: 12.2 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         IF(lwp .AND. lflush) CALL flush(numout)
112
113      ENDIF
114     
115      zcmsmag_1 = rn_cmsmag_1
116      zcmsmag_2 = rn_cmsmag_2
117      zcmsh     = rn_cmsh
118
119   
120
121
122      ! Set ahm1 and ahm2  ( T- and F- points) (used for laplacian operators
123      ! =================                       whatever its orientation is)
124      IF( ln_dynldf_lap ) THEN
125         ! define ahm1 and ahm2 at the right grid point position
126         ! (USER: modify ahm1 and ahm2 following your desiderata)
127         
128         DO jk=1,jpk
129           zue2(:,:)=un(:,:,jk)/e2u(:,:)
130           zve1(:,:)=vn(:,:,jk)/e1v(:,:)
131           zue1(:,:)=un(:,:,jk)/e1u(:,:)
132           zve2(:,:)=vn(:,:,jk)/e2v(:,:)
133
134 
135           DO jj=2,jpj
136            DO ji=2,jpi
137            zux(ji,jj)=(zue2(ji,jj)-zue2(ji-1,jj))/e1t(ji,jj)*e2t(ji,jj)*tmask(ji,jj,jk) * zcmsh
138            zvy(ji,jj)=(zve1(ji,jj)-zve1(ji,jj-1))/e2t(ji,jj)*e1t(ji,jj)*tmask(ji,jj,jk) * zcmsh
139            ENDDO
140           ENDDO
141
142           DO jj=1,jpjm1
143            DO ji=1,jpim1
144            zuy(ji,jj)=(zue1(ji,jj+1)-zue1(ji,jj))/e2f(ji,jj)*e1f(ji,jj)*fmask(ji,jj,jk)
145            zvx(ji,jj)=(zve2(ji+1,jj)-zve2(ji,jj))/e1f(ji,jj)*e2f(ji,jj)*fmask(ji,jj,jk)
146            ENDDO
147           ENDDO
148             
149          DO jj=2,jpjm1
150           DO ji=2,jpim1
151
152            zdeltat=2._wp /(e1t(ji,jj)**(-2)+e2t(ji,jj)**(-2))
153            zdeltaf=2._wp /(e1f(ji,jj)**(-2)+e2f(ji,jj)**(-2))   
154            ahm1(ji,jj,jk)=(zcmsmag_1/rpi)**2*zdeltat*                                         &
155                            sqrt( (zux(ji,jj)-zvy(ji,jj))**2+                                    &
156                     0.0625_wp*(zuy(ji,jj)+zuy(ji,jj-1)+zuy(ji-1,jj)+zuy(ji-1,jj-1)+             &
157                            zvx(ji,jj)+zvx(ji,jj-1)+zvx(ji-1,jj)+zvx(ji-1,jj-1))**2)
158
159            ahm2(ji,jj,jk)=(zcmsmag_1/rpi)**2*zdeltaf*                                         &
160                            sqrt( (zuy(ji,jj)+zvx(ji,jj))**2+                                    &
161                     0.0625_wp*(zux(ji,jj)+zux(ji,jj+1)+zux(ji+1,jj)+zux(ji+1,jj+1)-             &
162                             zvy(ji,jj)-zvy(ji,jj+1)-zvy(ji+1,jj)-zvy(ji+1,jj+1))**2)
163
164            ahm1(ji,jj,jk)=MAX(ahm1(ji,jj,jk),rn_ahm_0_lap)
165            ahm2(ji,jj,jk)=MAX(ahm2(ji,jj,jk),rn_ahm_0_lap)
166
167! stability criteria or upper limit set from namelist
168            ahm1(ji,jj,jk)=MIN(ahm1(ji,jj,jk),zdeltat / (16_wp*rdt),rn_ahm_m_lap)
169            ahm2(ji,jj,jk)=MIN(ahm2(ji,jj,jk),zdeltaf / (16_wp*rdt),rn_ahm_m_lap)
170
171            ENDDO
172           ENDDO
173
174         ENDDO ! jpk
175            ahm1(:,:,jpk) = ahm1(:,:,jpkm1)
176            ahm2(:,:,jpk) = ahm2(:,:,jpkm1)
177            IF(lwp.and.kt==nit000) THEN
178               WRITE(numout,'(36x," ahm ", 7x)') 
179               IF(lflush) CALL flush(numout)
180            ENDIF
181         IF(lwp.and.kt==nit000) THEN
182            DO jk = 1, jpk
183               WRITE(numout,'(30x,E10.2,8x,i3)') ahm1(jpi/2,jpj/2,jk), jk
184            END DO
185            IF(lflush) CALL flush(numout)
186         ENDIF
187      CALL lbc_lnk( ahm1, 'T', 1. )   ! Lateral boundary conditions on ( ahtt )
188      CALL lbc_lnk( ahm2, 'F', 1. )   ! Lateral boundary conditions on ( ahtt )
189
190      ENDIF    ! ln_dynldf_lap
191     
192
193
194      ! ahm3 and ahm4 at U- and V-points (used for bilaplacian operator
195      ! ================================  whatever its orientation is)
196      ! Here: ahm is proportional to the cube of the maximum of the grid spacing
197      !       in the to horizontal direction
198
199      IF( ln_dynldf_bilap ) THEN
200         DO jk=1,jpk
201           zue2(:,:) = un(:,:,jk)/e2u(:,:)
202           zve1(:,:) = vn(:,:,jk)/e1v(:,:)
203           zue1(:,:) = un(:,:,jk)/e1u(:,:)
204           zve2(:,:) = vn(:,:,jk)/e2v(:,:)
205
206
207           DO jj=2,jpj
208            DO ji=2,jpi
209            zux(ji,jj) = (zue2(ji,jj)-zue2(ji-1,jj))/e1t(ji,jj)*e2t(ji,jj)*tmask(ji,jj,jk)
210            zvy(ji,jj) = (zve1(ji,jj)-zve1(ji,jj-1))/e2t(ji,jj)*e1t(ji,jj)*tmask(ji,jj,jk)
211            ENDDO
212           ENDDO
213
214           DO jj=1,jpjm1
215            DO ji=1,jpim1
216            zuy(ji,jj) = (zue1(ji,jj+1)-zue1(ji,jj))/e2f(ji,jj)*e1f(ji,jj)*fmask(ji,jj,jk)
217            zvx(ji,jj) = (zve2(ji+1,jj)-zve2(ji,jj))/e1f(ji,jj)*e2f(ji,jj)*fmask(ji,jj,jk)
218            ENDDO
219           ENDDO
220
221
222          DO jj=2,jpjm1
223           DO ji=2,jpim1
224            zdeltau = 2._wp/(e1u(ji,jj)**(-2)+e2u(ji,jj)**(-2))
225            zdeltav = 2._wp/(e1v(ji,jj)**(-2)+e2v(ji,jj)**(-2))
226
227            ahm3(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltau**2*                          &
228
229                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji+1,jj)-zvy(ji,jj)-zvy(ji+1,jj))**2+    &
230                              0.25_wp*(zuy(ji,jj)+zuy(ji,jj-1)+zvx(ji,jj)+zvx(ji,jj-1))**2)
231
232            ahm4(ji,jj,jk) = -(zcmsmag_2/rpi)**2/8.0_wp*zdeltav**2*                           &
233
234                         sqrt(0.25_wp*(zux(ji,jj)+zux(ji,jj+1)-zvy(ji,jj)-zvy(ji,jj+1))**2+    &
235                              0.25_wp*(zuy(ji,jj)+zuy(ji-1,jj)+zvx(ji-1,jj)+zvx(ji,jj))**2)
236
237            ahm3(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm3(ji,jj,jk) )
238            ahm4(ji,jj,jk) = MIN (rn_ahm_0_blp , ahm4(ji,jj,jk) ) 
239
240! stability criteria or upper limit set in namelist
241
242            ahm3(ji,jj,jk) = MAX( ahm3(ji,jj,jk),-zdeltau**2/( 128._wp*rdt ),rn_ahm_m_blp )
243            ahm4(ji,jj,jk) = MAX( ahm4(ji,jj,jk),-zdeltav**2/( 128._wp*rdt ),rn_ahm_m_blp )
244           
245
246            ENDDO
247           ENDDO
248
249         ENDDO
250            ahm3(:,:,jpk) = ahm3(:,:,jpkm1)
251            ahm4(:,:,jpk) = ahm4(:,:,jpkm1)
252
253      IF(  kt == nit000 .AND. lwp) THEN
254         DO jk = 1, jpk
255               WRITE(numout,'(30x,E10.2,8x,i3)') ahm3(jpi/2,jpj/2,jk), jk
256               IF(lflush) CALL flush(numout)
257         END DO
258      ENDIF   
259
260      CALL lbc_lnk( ahm3, 'U', 1. )   ! Lateral boundary conditions
261      CALL lbc_lnk( ahm4, 'V', 1. )
262   ENDIF
263
264      CALL wrk_dealloc( jpi,jpj,zux,zuy,zvx,zvy )
265      CALL wrk_dealloc( jpi,jpj,zue1,zue2,zve1,zve2 )
266   !    zumax = MAXVAL( ABS( ahm3(:,:,:) ) )                ! slower than the following loop on NEC SX5
267      zdeltat = 0._wp
268   If(ln_dynldf_lap)THEN
269      DO jk = 1, jpk
270         DO jj = 1, jpj
271            DO ji = 1, jpi
272               zdeltat = MAX(zdeltat,ABS(ahm1(ji,jj,jk)),ABS(ahm2(ji,jj,jk)) )
273          END DO
274        END DO
275      END DO
276      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
277      !
278      IF( MOD( kt, nwrite ) == 1 .AND. lwp )  THEN
279         WRITE(numout,*) ' ==>> time-step= ',kt,'dynlap:  abs(ahm) max: ', zdeltat
280         IF(lflush) CALL flush(numout)
281      ENDIF
282    ENDIF
283    If(ln_dynldf_bilap)THEN
284     zdeltat = 0._wp
285      DO jk = 1, jpk
286         DO jj = 1, jpj
287            DO ji = 1, jpi
288               zdeltat = MAX(zdeltat,ABS(ahm3(ji,jj,jk)),ABS(ahm3(ji,jj,jk)) )
289          END DO
290        END DO
291      END DO
292      IF( lk_mpp )   CALL mpp_max( zdeltat )                 ! max over the global domain
293      !
294      IF( MOD( kt, nwrite ) == 1 .AND. lwp )  THEN
295         WRITE(numout,*) ' ==>> time-step= ',kt,'dyn_bilap abs(ahm) max: ', zdeltat
296         IF(lflush) CALL flush(numout)
297      ENDIF
298      !
299   ENDIF
300      !
301
302END SUBROUTINE ldf_dyn_smag
303#else
304   !!----------------------------------------------------------------------
305   !!   Default option                                         Dummy module
306   !!----------------------------------------------------------------------
307CONTAINS
308   SUBROUTINE ldf_dyn_smag( kt )       ! Empty routine
309   IMPLICIT NONE
310      INTEGER :: kt                    ! timestep   
311      WRITE(*,*) 'ldf_dyn_smag: You should not have seen this print! error? check keys ldf:c3d+smag', kt
312   END SUBROUTINE ldf_dyn_smag
313#endif
314
315   END MODULE ldfdyn_smag
316
Note: See TracBrowser for help on using the repository browser.