source: branches/UKMO/GO6_dyn_vrt_diag/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 8300

Last change on this file since 8300 was 8300, checked in by glong, 4 years ago

Changed diagnostics to calculate the contributions by taking after-before before going into the specific numerical scheme for the model.

File size: 12.8 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 divcur         ! Used by dyn_vrt_dia
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      CHARACTER(len=3)    ::   id_vrt_dia_ldf = "ldf"  ! TODO Replace once proper flags in place
61      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
62      !!----------------------------------------------------------------------
63      !
64      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
65      !
66      IF( l_trddyn .or. ( id_vrt_dia_ldf == "ldf" ) )   THEN               ! temporary save of ta and sa trends
67         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv )
68         ztrdu(:,:,:) = ua(:,:,:) 
69         ztrdv(:,:,:) = va(:,:,:) 
70      ENDIF
71
72      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
73      !
74      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
75      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
76      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
77      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
78      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
79         CALL dyn_ldf_lap    ( kt )
80         CALL dyn_ldf_bilap  ( kt )
81      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
82         CALL dyn_ldf_iso    ( kt )
83         CALL dyn_ldf_bilapg ( kt )
84      !
85      CASE ( -1 )                                       ! esopa: test all possibility with control print
86                        CALL dyn_ldf_lap    ( kt )
87                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
88            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
89                        CALL dyn_ldf_iso    ( kt )
90                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
91            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
92                        CALL dyn_ldf_bilap  ( kt )
93                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
94            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
95                        CALL dyn_ldf_bilapg ( kt )
96                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
97            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
98      !
99      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
100         IF( kt == nit000 ) THEN
101            IF(lwp) WRITE(numout,*)
102            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
103            IF(lwp) WRITE(numout,*) '~~~~~~~ '
104         ENDIF
105      END SELECT
106
107      IF( l_trddyn .or. ( id_vrt_dia_ldf == "ldf" ) ) THEN    ! save the horizontal diffusive trends for further diagnostics
108         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
109         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
110         IF( id_vrt_dia_ldf == "ldf" ) THEN
111             CALL dyn_vrt_dia_3d( ztrdu, ztrdv, id_vrt_dia_ldf )
112         END IF
113         IF( l_trddyn ) THEN
114             CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
115         END IF
116         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
117      ENDIF
118      !                                          ! print sum trends (used for debugging)
119      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
120         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
121      !
122      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
123      !
124   END SUBROUTINE dyn_ldf
125
126
127   SUBROUTINE dyn_ldf_init
128      !!----------------------------------------------------------------------
129      !!                  ***  ROUTINE dyn_ldf_init  ***
130      !!
131      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
132      !!----------------------------------------------------------------------
133      INTEGER ::   ioptio, ierr         ! temporary integers
134      !!----------------------------------------------------------------------
135   
136      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
137
138      IF(lwp) THEN                        ! Namelist print
139         WRITE(numout,*)
140         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
141         WRITE(numout,*) '~~~~~~~~~~~'
142         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
143         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
144         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
145         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
146         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
147         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
148      ENDIF
149
150      !                                   ! control the consistency
151      ioptio = 0
152      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
153      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
154      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
155      ioptio = 0
156      IF( ln_dynldf_level )   ioptio = ioptio + 1
157      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
158      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
159      IF( ioptio >  1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
160
161      IF( ln_dynldf_iso .AND. ln_traldf_hor ) CALL ctl_stop &
162      &   ( 'Not sensible to use geopotential diffusion for tracers with isoneutral diffusion for dynamics' )
163
164      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
165      ierr = 0
166      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
167         IF ( ln_zco ) THEN                ! z-coordinate
168            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
169            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
170            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
171         ENDIF
172         IF ( ln_zps ) THEN             ! z-coordinate
173            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
174            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
175            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
176         ENDIF
177         IF ( ln_sco ) THEN             ! s-coordinate
178            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
179            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
180            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
181         ENDIF
182      ENDIF
183
184      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
185         IF ( ln_zco ) THEN                ! z-coordinate
186            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
187            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
188            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
189         ENDIF
190         IF ( ln_zps ) THEN             ! z-coordinate
191            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
192            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
193            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
194         ENDIF
195         IF ( ln_sco ) THEN             ! s-coordinate
196            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
197            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
198            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
199         ENDIF
200      ENDIF
201     
202      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
203         IF ( ln_zco ) THEN                ! z-coordinate
204            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
205            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
206            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
207         ENDIF
208         IF ( ln_zps ) THEN             ! z-coordinate
209            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
210            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
211            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
212         ENDIF
213         IF ( ln_sco ) THEN             ! s-coordinate
214            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
215            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
216            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
217         ENDIF
218      ENDIF
219
220      IF( lk_esopa )                 nldf = -1     ! esopa test
221
222      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
223      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
224      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
225         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
226      ENDIF
227
228      IF(lwp) THEN
229         WRITE(numout,*)
230         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
231         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
232         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
233         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
234         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
235         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
236         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
237         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
238      ENDIF
239      !
240   END SUBROUTINE dyn_ldf_init
241
242   !!======================================================================
243END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.