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/CO5_package_branch/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/UKMO/CO5_package_branch/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 7367

Last change on this file since 7367 was 7367, checked in by deazer, 7 years ago

Contains merged code for CO5 reference.
File size: 14.0 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 ldfslp         ! lateral mixing: slopes of mixing orientation
18   USE dynldf_bilapg  ! lateral mixing            (dyn_ldf_bilapg routine)
19   USE dynldf_bilap   ! lateral mixing            (dyn_ldf_bilap  routine)
20   USE dynldf_iso     ! lateral mixing            (dyn_ldf_iso    routine)
21   USE dynldf_lap     ! lateral mixing            (dyn_ldf_lap    routine)
22   USE trdmod         ! ocean dynamics and tracer trends
23   USE trdmod_oce     ! ocean variables trends
24   USE prtctl         ! Print control
25   USE in_out_manager ! I/O manager
26   USE lib_mpp        ! distribued memory computing library
27   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
28   USE wrk_nemo        ! Memory Allocation
29   USE timing          ! Timing
30
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   dyn_ldf       ! called by step module
36   PUBLIC   dyn_ldf_init  ! called by opa  module
37
38   INTEGER ::   nldf = -2   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
39
40   !! * Substitutions
41#  include "domzgr_substitute.h90"
42#  include "vectopt_loop_substitute.h90"
43   !!----------------------------------------------------------------------
44   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
45   !! $Id$
46   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
47   !!----------------------------------------------------------------------
48CONTAINS
49
50   SUBROUTINE dyn_ldf( kt )
51      !!----------------------------------------------------------------------
52      !!                  ***  ROUTINE dyn_ldf  ***
53      !!
54      !! ** Purpose :   compute the lateral ocean dynamics physics.
55      !!----------------------------------------------------------------------
56      !
57      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
58      !
59      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
60      !!----------------------------------------------------------------------
61      !
62      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
63      !
64      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
65         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv )
66         ztrdu(:,:,:) = ua(:,:,:) 
67         ztrdv(:,:,:) = va(:,:,:) 
68      ENDIF
69
70      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
71      !
72      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
73      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
74      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
75      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
76      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian 
77        IF ( ln_zco .or. ln_zps ) THEN                ! z-coordinate 
78           CALL dyn_ldf_lap    ( kt ) 
79           CALL dyn_ldf_bilap  ( kt ) 
80        ELSEIF ( ln_sco ) THEN             ! s-coordinate 
81           IF ( ln_dynldf_lap_hor .or. ln_dynldf_lap_iso ) THEN 
82               CALL dyn_ldf_iso    ( kt ) 
83           ELSEIF (ln_dynldf_lap_level ) THEN 
84               CALL dyn_ldf_lap    ( kt ) 
85           ELSE 
86               WRITE(numout,*) 'error in dynldf.F90, no slope used for laplacian mixing' 
87           ENDIF 
88           IF ( ln_dynldf_bilap_hor .or. ln_dynldf_bilap_iso ) THEN 
89               CALL dyn_ldf_bilapg ( kt ) 
90           ELSEIF ( ln_dynldf_bilap_level ) THEN 
91               CALL dyn_ldf_bilap  ( kt ) 
92           ELSE 
93               WRITE(numout,*) 'error in dynldf.F90, no slope used for bilaplacian mixing' 
94           ENDIF 
95        ENDIF 
96      !
97      CASE ( -1 )                                       ! esopa: test all possibility with control print
98                        CALL dyn_ldf_lap    ( kt )
99                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
100            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
101                        CALL dyn_ldf_iso    ( kt )
102                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
103            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
104                        CALL dyn_ldf_bilap  ( kt )
105                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
106            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
107                        CALL dyn_ldf_bilapg ( kt )
108                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
109            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
110      !
111      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
112         IF( kt == nit000 ) THEN
113            IF(lwp) WRITE(numout,*)
114            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
115            IF(lwp) WRITE(numout,*) '~~~~~~~ '
116         ENDIF
117      END SELECT
118
119      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
120         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
121         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
122         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_ldf, 'DYN', kt )
123         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
124      ENDIF
125      !                                          ! print sum trends (used for debugging)
126      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
127         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
128      !
129      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
130      !
131   END SUBROUTINE dyn_ldf
132
133
134   SUBROUTINE dyn_ldf_init
135      !!----------------------------------------------------------------------
136      !!                  ***  ROUTINE dyn_ldf_init  ***
137      !!
138      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
139      !!----------------------------------------------------------------------
140      INTEGER ::   ioptio, ierr         ! temporary integers
141      !!----------------------------------------------------------------------
142   
143      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
144
145      IF(lwp) THEN                        ! Namelist print
146         WRITE(numout,*)
147         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
148         WRITE(numout,*) '~~~~~~~~~~~'
149         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
150         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
151         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
152         WRITE(numout,*) '          laplacien iso-level                   ln_dynldf_lap_level = ', ln_dynldf_lap_level 
153         WRITE(numout,*) '          laplacien horizontal (geopotential)   ln_dynldf_lap_hor   = ', ln_dynldf_lap_hor 
154         WRITE(numout,*) '          laplacien iso-neutral                 ln_dynldf_lap_iso   = ', ln_dynldf_lap_iso 
155         WRITE(numout,*) '          bilaplacien iso-level                 ln_dynldf_bilap_level = ', ln_dynldf_bilap_level 
156         WRITE(numout,*) '          bilaplacien horizontal (geopotential) ln_dynldf_bilap_hor   = ', ln_dynldf_bilap_hor 
157         WRITE(numout,*) '          bilaplacien iso-neutral               ln_dynldf_bilap_iso   = ', ln_dynldf_bilap_iso 
158      ENDIF
159
160      !                                   ! control the consistency
161      ioptio = 0
162      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
163      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
164      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
165      ioptio = 0
166      IF( ln_dynldf_lap_level )   ioptio = ioptio + 1 
167      IF( ln_dynldf_lap_hor   )   ioptio = ioptio + 1 
168      IF( ln_dynldf_lap_iso   )   ioptio = ioptio + 1 
169      IF( ( ioptio /= 1 ) .and. ln_dynldf_lap )     & 
170                        CALL ctl_stop( '          use only ONE direction for laplacien mixing (level/hor/iso)' ) 
171      ioptio = 0 
172      IF( ln_dynldf_bilap_level )   ioptio = ioptio + 1 
173      IF( ln_dynldf_bilap_hor   )   ioptio = ioptio + 1 
174      IF( ln_dynldf_bilap_iso   )   ioptio = ioptio + 1 
175      IF( ( ioptio /= 1 ) .and. ln_dynldf_bilap )     & 
176                        CALL ctl_stop( '          use only ONE direction for bilaplacien mixing (level/hor/iso)' ) 
177      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
178      ierr = 0
179      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
180         IF ( ln_zco ) THEN                ! z-coordinate
181            IF ( ln_dynldf_lap_level )   nldf = 0      ! iso-level  (no rotation)
182            IF ( ln_dynldf_lap_hor   )   nldf = 0      ! horizontal (no rotation)
183            IF ( ln_dynldf_lap_iso   )   nldf = 1      ! isoneutral (   rotation)
184         ENDIF
185         IF ( ln_zps ) THEN             ! z-coordinate
186            IF ( ln_dynldf_lap_level )   ierr = 1      ! iso-level not allowed 
187            IF ( ln_dynldf_lap_hor   )   nldf = 0      ! horizontal (no rotation) 
188            IF ( ln_dynldf_lap_iso   )   nldf = 1      ! isoneutral (   rotation) 
189         ENDIF 
190         IF ( ln_sco ) THEN             ! s-coordinate 
191            IF ( ln_dynldf_lap_level )   nldf = 0      ! iso-level  (no rotation) 
192            IF ( ln_dynldf_lap_hor   )   nldf = 1      ! horizontal (   rotation) 
193            IF ( ln_dynldf_lap_iso   )   nldf = 1      ! isoneutral (   rotation) 
194         ENDIF
195      ENDIF
196
197      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
198         IF ( ln_zco ) THEN                ! z-coordinate
199            IF ( ln_dynldf_bilap_level )   nldf = 2      ! iso-level  (no rotation)
200            IF ( ln_dynldf_bilap_hor   )   nldf = 2      ! horizontal (no rotation)
201            IF ( ln_dynldf_bilap_iso   )   ierr = 2      ! isoneutral (   rotation)
202         ENDIF
203         IF ( ln_zps ) THEN             ! z-coordinate
204            IF ( ln_dynldf_bilap_level )   ierr = 1      ! iso-level not allowed
205            IF ( ln_dynldf_bilap_hor   )   nldf = 2      ! horizontal (no rotation)
206            IF ( ln_dynldf_bilap_iso   )   ierr = 2      ! isoneutral (   rotation)
207         ENDIF
208         IF ( ln_sco ) THEN             ! s-coordinate
209            IF ( ln_dynldf_bilap_level )   nldf = 2      ! iso-level  (no rotation)
210            IF ( ln_dynldf_bilap_hor   )   nldf = 3      ! horizontal (   rotation)
211            IF ( ln_dynldf_bilap_iso   )   ierr = 2      ! isoneutral (   rotation)
212         ENDIF
213      ENDIF
214     
215      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators 
216         IF ( ln_zco ) THEN                ! z-coordinate 
217            IF ( ln_dynldf_lap_level .or. ln_dynldf_bilap_level )   nldf = 4      ! 
218            IF ( ln_dynldf_lap_hor   .or. ln_dynldf_bilap_hor   )   nldf = 4      ! 
219            IF ( ln_dynldf_lap_iso   .or. ln_dynldf_bilap_iso   )   ierr = 2      ! isoneutral (   rotation) 
220         ENDIF 
221         IF ( ln_zps ) THEN             ! z-coordinate 
222            IF ( ln_dynldf_lap_level .or. ln_dynldf_bilap_level )   ierr = 1      ! iso-level not allowed 
223            IF ( ln_dynldf_lap_hor   .or. ln_dynldf_bilap_hor   )   nldf = 4      ! 
224            IF ( ln_dynldf_lap_iso   .or. ln_dynldf_bilap_iso   )   ierr = 2      ! 
225         ENDIF 
226         IF ( ln_sco ) THEN             ! s-coordinate 
227            IF ( ln_dynldf_lap_level .or. ln_dynldf_bilap_level )   nldf = 4      ! 
228            IF ( ln_dynldf_lap_hor   .or. ln_dynldf_bilap_hor   )   nldf = 4      ! 
229            IF ( ln_dynldf_lap_iso   .or. ln_dynldf_bilap_iso   )   ierr = 2      ! 
230         ENDIF 
231      ENDIF 
232      !
233      IF( lk_esopa )                 nldf = -1     ! esopa test
234
235      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
236      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
237      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
238         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
239      ENDIF
240
241      IF(lwp) THEN
242         WRITE(numout,*)
243         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
244         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
245         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
246         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
247         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
248         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
249         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
250         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
251      ENDIF
252      !
253   END SUBROUTINE dyn_ldf_init
254
255   !!======================================================================
256END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.