source: branches/UKMO/r6232_tracer_advection/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90

Last change on this file was 9295, checked in by jcastill, 3 years ago

Remove svn keywords

File size: 12.5 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
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   dyn_ldf       ! called by step module
37   PUBLIC   dyn_ldf_init  ! called by opa  module
38
39   INTEGER ::   nldf = -2   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
40
41   !! * Substitutions
42#  include "domzgr_substitute.h90"
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
46   !! $Id$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   SUBROUTINE dyn_ldf( kt )
52      !!----------------------------------------------------------------------
53      !!                  ***  ROUTINE dyn_ldf  ***
54      !!
55      !! ** Purpose :   compute the lateral ocean dynamics physics.
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         CALL dyn_ldf_lap    ( kt )
78         CALL dyn_ldf_bilap  ( kt )
79      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
80         CALL dyn_ldf_iso    ( kt )
81         CALL dyn_ldf_bilapg ( kt )
82      !
83      CASE ( -1 )                                       ! esopa: test all possibility with control print
84                        CALL dyn_ldf_lap    ( kt )
85                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
86            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
87                        CALL dyn_ldf_iso    ( kt )
88                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
89            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
90                        CALL dyn_ldf_bilap  ( kt )
91                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
92            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
93                        CALL dyn_ldf_bilapg ( kt )
94                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
95            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
96      !
97      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
98         IF( kt == nit000 ) THEN
99            IF(lwp) WRITE(numout,*)
100            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
101            IF(lwp) WRITE(numout,*) '~~~~~~~ '
102         ENDIF
103      END SELECT
104
105      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
106         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
107         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
108         CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
109         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
110      ENDIF
111      !                                          ! print sum trends (used for debugging)
112      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
113         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
114      !
115      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
116      !
117   END SUBROUTINE dyn_ldf
118
119
120   SUBROUTINE dyn_ldf_init
121      !!----------------------------------------------------------------------
122      !!                  ***  ROUTINE dyn_ldf_init  ***
123      !!
124      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
125      !!----------------------------------------------------------------------
126      INTEGER ::   ioptio, ierr         ! temporary integers
127      !!----------------------------------------------------------------------
128   
129      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
130
131      IF(lwp) THEN                        ! Namelist print
132         WRITE(numout,*)
133         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
134         WRITE(numout,*) '~~~~~~~~~~~'
135         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
136         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
137         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
138         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
139         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
140         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
141      ENDIF
142
143      !                                   ! control the consistency
144      ioptio = 0
145      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
146      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
147      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
148      ioptio = 0
149      IF( ln_dynldf_level )   ioptio = ioptio + 1
150      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
151      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
152      IF( ioptio >  1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
153
154      IF( ln_dynldf_iso .AND. ln_traldf_hor ) CALL ctl_stop &
155      &   ( 'Not sensible to use geopotential diffusion for tracers with isoneutral diffusion for dynamics' )
156
157      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
158      ierr = 0
159      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
160         IF ( ln_zco ) THEN                ! z-coordinate
161            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
162            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
163            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
164         ENDIF
165         IF ( ln_zps ) THEN             ! z-coordinate
166            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
167            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
168            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
169         ENDIF
170         IF ( ln_sco ) THEN             ! s-coordinate
171            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
172            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
173            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
174         ENDIF
175      ENDIF
176
177      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
178         IF ( ln_zco ) THEN                ! z-coordinate
179            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
180            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
181            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
182         ENDIF
183         IF ( ln_zps ) THEN             ! z-coordinate
184            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
185            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
186            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
187         ENDIF
188         IF ( ln_sco ) THEN             ! s-coordinate
189            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
190            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
191            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
192         ENDIF
193      ENDIF
194     
195      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
196         IF ( ln_zco ) THEN                ! z-coordinate
197            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
198            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
199            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
200         ENDIF
201         IF ( ln_zps ) THEN             ! z-coordinate
202            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
203            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
204            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
205         ENDIF
206         IF ( ln_sco ) THEN             ! s-coordinate
207            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
208            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
209            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
210         ENDIF
211      ENDIF
212
213      IF( lk_esopa )                 nldf = -1     ! esopa test
214
215      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
216      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
217      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
218         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
219      ENDIF
220
221      IF(lwp) THEN
222         WRITE(numout,*)
223         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
224         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
225         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
226         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
227         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
228         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
229         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
230         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
231      ENDIF
232      !
233   END SUBROUTINE dyn_ldf_init
234
235   !!======================================================================
236END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.