source: branches/UKMO/dev_r5518_GO6_package_FOAMv14/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 11442

Last change on this file since 11442 was 11442, checked in by mattmartin, 2 years ago

Introduction of stochastic physics in NEMO, based on Andrea Storto's code.
For details, see ticket https://code.metoffice.gov.uk/trac/utils/ticket/251.

File size: 14.4 KB
Line 
1MODULE dynldf
2   !!======================================================================
3   !!                       ***  MODULE  dynldf  ***
4   !! Ocean physics:  lateral diffusivity trends
5   !!=====================================================================
6   !! History :  9.0  !  05-11  (G. Madec)  Original code (new step architecture)
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   dyn_ldf      : update the dynamics trend with the lateral diffusion
11   !!   dyn_ldf_init : initialization, namelist read, and parameters control
12   !!----------------------------------------------------------------------
13   USE oce            ! ocean dynamics and tracers
14   USE dom_oce        ! ocean space and time domain
15   USE phycst         ! physical constants
16   USE ldfdyn_oce     ! ocean dynamics lateral physics
17   USE ldftra_oce     ! ocean tracers  lateral physics
18   USE ldfslp         ! lateral mixing: slopes of mixing orientation
19   USE dynldf_bilapg  ! lateral mixing            (dyn_ldf_bilapg routine)
20   USE dynldf_bilap   ! lateral mixing            (dyn_ldf_bilap  routine)
21   USE dynldf_iso     ! lateral mixing            (dyn_ldf_iso    routine)
22   USE dynldf_lap     ! lateral mixing            (dyn_ldf_lap    routine)
23   USE trd_oce        ! trends: ocean variables
24   USE trddyn         ! trend manager: dynamics   (trd_dyn        routine)
25   !
26   USE prtctl         ! Print control
27   USE in_out_manager ! I/O manager
28   USE lib_mpp        ! distribued memory computing library
29   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
30   USE wrk_nemo        ! Memory Allocation
31   USE timing          ! Timing
32   USE stopack
33
34   IMPLICIT NONE
35   PRIVATE
36
37   PUBLIC   dyn_ldf       ! called by step module
38   PUBLIC   dyn_ldf_init  ! called by opa  module
39
40   INTEGER ::   nldf = -2   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
41
42#if defined key_dynldf_c3d
43   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ahm10, ahm20, ahm30, ahm40
44#endif
45#if defined key_dynldf_c2d
46   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:  ) :: ahm10, ahm20, ahm30, ahm40
47#endif
48
49   !! * Substitutions
50#  include "domzgr_substitute.h90"
51#  include "vectopt_loop_substitute.h90"
52   !!----------------------------------------------------------------------
53   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
54   !! $Id$
55   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
56   !!----------------------------------------------------------------------
57CONTAINS
58
59   SUBROUTINE dyn_ldf( kt )
60      !!----------------------------------------------------------------------
61      !!                  ***  ROUTINE dyn_ldf  ***
62      !!
63      !! ** Purpose :   compute the lateral ocean dynamics physics.
64      !!----------------------------------------------------------------------
65      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
66      !
67      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
68      !!----------------------------------------------------------------------
69      !
70      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
71      !
72      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
73         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv )
74         ztrdu(:,:,:) = ua(:,:,:) 
75         ztrdv(:,:,:) = va(:,:,:) 
76      ENDIF
77
78#if defined key_dynldf_c3d
79         IF( kt == nit000 .AND. ln_stopack .AND. &
80            & ( (nn_spp_ahm1 + nn_spp_ahm2) > 0 ) ) THEN
81             ALLOCATE ( ahm10(jpi,jpj,jpk), ahm20(jpi,jpj,jpk) )
82             ALLOCATE ( ahm30(jpi,jpj,jpk), ahm40(jpi,jpj,jpk) )
83             ahm10 = ahm1
84             ahm20 = ahm2
85             ahm30 = ahm3
86             ahm40 = ahm4
87         ENDIF
88#endif
89#if defined key_dynldf_c2d
90         IF( kt == nit000 .AND. ln_stopack .AND. &
91            & ( (nn_spp_ahm1 + nn_spp_ahm2) > 0 ) ) THEN
92             ALLOCATE ( ahm10(jpi,jpj), ahm20(jpi,jpj) )
93             ALLOCATE ( ahm30(jpi,jpj), ahm40(jpi,jpj) )
94             ahm10 = ahm1
95             ahm20 = ahm2
96             ahm30 = ahm3
97             ahm40 = ahm4
98         ENDIF
99#endif
100
101#if defined key_traldf_c3d || defined key_traldf_c2d
102         IF( ln_stopack ) THEN
103            IF( nn_spp_ahm1 > 0 ) THEN
104               IF( ln_dynldf_lap ) THEN
105                  ahm1 = ahm10
106                  CALL spp_ahm(kt, ahm1, nn_spp_ahm1, rn_ahm1_sd, jk_spp_ahm1)
107               ENDIF
108               IF( ln_dynldf_bilap ) THEN
109                  ahm3 = ahm30
110                  CALL spp_ahm(kt, ahm3, nn_spp_ahm1, rn_ahm1_sd, jk_spp_ahm3)
111               ENDIF
112            ENDIF
113            IF( nn_spp_ahm2 > 0 ) THEN
114               IF( ln_dynldf_lap ) THEN
115               ahm2 = ahm20
116               CALL spp_ahm(kt, ahm2, nn_spp_ahm2, rn_ahm2_sd, jk_spp_ahm2)
117               ENDIF
118               IF( ln_dynldf_bilap ) THEN
119                  ahm4 = ahm40
120                  CALL spp_ahm(kt, ahm4, nn_spp_ahm2, rn_ahm2_sd, jk_spp_ahm4)
121               ENDIF
122            ENDIF
123         ENDIF
124#endif
125
126      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
127      !
128      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
129      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
130      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
131      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
132      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
133         CALL dyn_ldf_lap    ( kt )
134         CALL dyn_ldf_bilap  ( kt )
135      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
136         CALL dyn_ldf_iso    ( kt )
137         CALL dyn_ldf_bilapg ( kt )
138      !
139      CASE ( -1 )                                       ! esopa: test all possibility with control print
140                        CALL dyn_ldf_lap    ( kt )
141                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
142            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
143                        CALL dyn_ldf_iso    ( kt )
144                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
145            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
146                        CALL dyn_ldf_bilap  ( kt )
147                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
148            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
149                        CALL dyn_ldf_bilapg ( kt )
150                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
151            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
152      !
153      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
154         IF( kt == nit000 ) THEN
155            IF(lwp) WRITE(numout,*)
156            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
157            IF(lwp) WRITE(numout,*) '~~~~~~~ '
158         ENDIF
159      END SELECT
160
161      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
162         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
163         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
164         CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
165         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
166      ENDIF
167      !                                          ! print sum trends (used for debugging)
168      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
169         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
170      !
171      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
172      !
173   END SUBROUTINE dyn_ldf
174
175
176   SUBROUTINE dyn_ldf_init
177      !!----------------------------------------------------------------------
178      !!                  ***  ROUTINE dyn_ldf_init  ***
179      !!
180      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
181      !!----------------------------------------------------------------------
182      INTEGER ::   ioptio, ierr         ! temporary integers
183      !!----------------------------------------------------------------------
184   
185      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
186
187      IF(lwp) THEN                        ! Namelist print
188         WRITE(numout,*)
189         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
190         WRITE(numout,*) '~~~~~~~~~~~'
191         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
192         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
193         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
194         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
195         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
196         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
197      ENDIF
198
199      !                                   ! control the consistency
200      ioptio = 0
201      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
202      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
203      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
204      ioptio = 0
205      IF( ln_dynldf_level )   ioptio = ioptio + 1
206      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
207      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
208      IF( ioptio >  1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
209
210      IF( ln_dynldf_iso .AND. ln_traldf_hor ) CALL ctl_stop &
211      &   ( 'Not sensible to use geopotential diffusion for tracers with isoneutral diffusion for dynamics' )
212
213      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
214      ierr = 0
215      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
216         IF ( ln_zco ) THEN                ! z-coordinate
217            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
218            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
219            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
220         ENDIF
221         IF ( ln_zps ) THEN             ! z-coordinate
222            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
223            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
224            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
225         ENDIF
226         IF ( ln_sco ) THEN             ! s-coordinate
227            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
228            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
229            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
230         ENDIF
231      ENDIF
232
233      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
234         IF ( ln_zco ) THEN                ! z-coordinate
235            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
236            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
237            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
238         ENDIF
239         IF ( ln_zps ) THEN             ! z-coordinate
240            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
241            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
242            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
243         ENDIF
244         IF ( ln_sco ) THEN             ! s-coordinate
245            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
246            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
247            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
248         ENDIF
249      ENDIF
250     
251      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
252         IF ( ln_zco ) THEN                ! z-coordinate
253            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
254            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
255            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
256         ENDIF
257         IF ( ln_zps ) THEN             ! z-coordinate
258            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
259            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
260            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
261         ENDIF
262         IF ( ln_sco ) THEN             ! s-coordinate
263            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
264            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
265            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
266         ENDIF
267      ENDIF
268
269      IF( lk_esopa )                 nldf = -1     ! esopa test
270
271      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
272      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
273      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
274         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
275      ENDIF
276
277      IF(lwp) THEN
278         WRITE(numout,*)
279         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
280         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
281         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
282         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
283         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
284         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
285         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
286         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
287      ENDIF
288      !
289   END SUBROUTINE dyn_ldf_init
290
291   !!======================================================================
292END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.