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.
dynldf.F90 in branches/UKMO/dev_r5518_GO6_package_for_static_diagnostics/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/UKMO/dev_r5518_GO6_package_for_static_diagnostics/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 7605

Last change on this file since 7605 was 7605, checked in by timgraham, 7 years ago

Added field for dynldf_c3d case
File size: 13.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 iom
32   USE timing          ! Timing
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   !! * Substitutions
43#  include "domzgr_substitute.h90"
44#  include "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE dyn_ldf( kt )
53      !!----------------------------------------------------------------------
54      !!                  ***  ROUTINE dyn_ldf  ***
55      !!
56      !! ** Purpose :   compute the lateral ocean dynamics physics.
57      !!----------------------------------------------------------------------
58      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
59      !
60      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
61      REAL(wp), POINTER, DIMENSION(:,:) ::  ztmp
62      INTEGER :: ji,jj
63      !!----------------------------------------------------------------------
64      !
65      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
66      !
67      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
68         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv )
69         ztrdu(:,:,:) = ua(:,:,:) 
70         ztrdv(:,:,:) = va(:,:,:) 
71      ENDIF
72     
73      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
74      !
75      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
76      CASE ( 1 )
77          CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
78#ifdef key_dynldf_c2d
79          IF (kt == nit000) CALL iom_put("ahmt_lap", ahm1)
80#endif
81#ifdef key_dynldf_c3d
82          IF (kt == nit000) CALL iom_put("ahmt_lap3d", ahm1)
83#endif
84      CASE ( 2 )   
85          CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
86#ifdef key_dynldf_c2d
87          !Average ahm3 and ahm4 onto T points and output for CMIP6 diagnostics
88          IF(kt == nit000) THEN
89             CALL wrk_alloc(jpi, jpj, ztmp)
90             DO jj=2,jpj
91                DO ji=2,jpi
92                   ztmp(ji,jj) = (ahm3(ji,jj)*umask(ji,jj,1) + ahm3(ji-1,jj)*umask(ji-1,jj,1) &
93                                + ahm4(ji,jj)*vmask(ji,jj,1) + ahm4(ji,jj-1)*vmask(ji,jj-1,1)) / &
94                      &  (umask(ji,jj,1) + umask(ji-1,jj,1) + vmask(ji,jj,1) + vmask(ji,jj-1,1))
95                ENDDO
96             ENDDO
97             CALL iom_put("ahmt_blp", ztmp)
98             CALL wrk_dealloc(jpi, jpj, ztmp)
99          ENDIF
100#endif
101      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
102      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
103         CALL dyn_ldf_lap    ( kt )
104         CALL dyn_ldf_bilap  ( kt )
105      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
106         CALL dyn_ldf_iso    ( kt )
107         CALL dyn_ldf_bilapg ( kt )
108      !
109      CASE ( -1 )                                       ! esopa: test all possibility with control print
110                        CALL dyn_ldf_lap    ( kt )
111                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
112            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
113                        CALL dyn_ldf_iso    ( kt )
114                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
115            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
116                        CALL dyn_ldf_bilap  ( kt )
117                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
118            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
119                        CALL dyn_ldf_bilapg ( kt )
120                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
121            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
122      !
123      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
124         IF( kt == nit000 ) THEN
125            IF(lwp) WRITE(numout,*)
126            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
127            IF(lwp) WRITE(numout,*) '~~~~~~~ '
128         ENDIF
129      END SELECT
130
131      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
132         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
133         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
134         CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
135         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
136      ENDIF
137      !                                          ! print sum trends (used for debugging)
138      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
139         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
140      !
141      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
142      !
143   END SUBROUTINE dyn_ldf
144
145
146   SUBROUTINE dyn_ldf_init
147      !!----------------------------------------------------------------------
148      !!                  ***  ROUTINE dyn_ldf_init  ***
149      !!
150      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
151      !!----------------------------------------------------------------------
152      INTEGER ::   ioptio, ierr         ! temporary integers
153      !!----------------------------------------------------------------------
154   
155      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
156
157      IF(lwp) THEN                        ! Namelist print
158         WRITE(numout,*)
159         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
160         WRITE(numout,*) '~~~~~~~~~~~'
161         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
162         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
163         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
164         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
165         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
166         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
167      ENDIF
168
169      !                                   ! control the consistency
170      ioptio = 0
171      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
172      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
173      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
174      ioptio = 0
175      IF( ln_dynldf_level )   ioptio = ioptio + 1
176      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
177      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
178      IF( ioptio >  1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
179
180      IF( ln_dynldf_iso .AND. ln_traldf_hor ) CALL ctl_stop &
181      &   ( 'Not sensible to use geopotential diffusion for tracers with isoneutral diffusion for dynamics' )
182
183      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
184      ierr = 0
185      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
186         IF ( ln_zco ) THEN                ! z-coordinate
187            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
188            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
189            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
190         ENDIF
191         IF ( ln_zps ) THEN             ! z-coordinate
192            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
193            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
194            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
195         ENDIF
196         IF ( ln_sco ) THEN             ! s-coordinate
197            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
198            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
199            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
200         ENDIF
201      ENDIF
202
203      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
204         IF ( ln_zco ) THEN                ! z-coordinate
205            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
206            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
207            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
208         ENDIF
209         IF ( ln_zps ) THEN             ! z-coordinate
210            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
211            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
212            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
213         ENDIF
214         IF ( ln_sco ) THEN             ! s-coordinate
215            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
216            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
217            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
218         ENDIF
219      ENDIF
220     
221      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
222         IF ( ln_zco ) THEN                ! z-coordinate
223            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
224            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
225            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
226         ENDIF
227         IF ( ln_zps ) THEN             ! z-coordinate
228            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
229            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
230            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
231         ENDIF
232         IF ( ln_sco ) THEN             ! s-coordinate
233            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
234            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
235            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
236         ENDIF
237      ENDIF
238
239      IF( lk_esopa )                 nldf = -1     ! esopa test
240
241      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
242      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
243      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
244         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
245      ENDIF
246
247      IF(lwp) THEN
248         WRITE(numout,*)
249         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
250         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
251         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
252         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
253         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
254         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
255         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
256         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
257      ENDIF
258      !
259   END SUBROUTINE dyn_ldf_init
260
261   !!======================================================================
262END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.