source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 13 months ago

The Dr Hook changes from my perl code.

File size: 13.3 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   USE yomhook, ONLY: lhook, dr_hook
34   USE parkind1, ONLY: jprb, jpim
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC   dyn_ldf       ! called by step module
40   PUBLIC   dyn_ldf_init  ! called by opa  module
41
42   INTEGER ::   nldf = -2   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
43
44   !! * Substitutions
45#  include "domzgr_substitute.h90"
46#  include "vectopt_loop_substitute.h90"
47   !!----------------------------------------------------------------------
48   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
49   !! $Id$
50   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
51   !!----------------------------------------------------------------------
52CONTAINS
53
54   SUBROUTINE dyn_ldf( kt )
55      !!----------------------------------------------------------------------
56      !!                  ***  ROUTINE dyn_ldf  ***
57      !!
58      !! ** Purpose :   compute the lateral ocean dynamics physics.
59      !!----------------------------------------------------------------------
60      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
61      !
62      REAL(wp), POINTER, DIMENSION(:,:,:) ::  ztrdu, ztrdv
63      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
64      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
65      REAL(KIND=jprb)               :: zhook_handle
66
67      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_LDF'
68
69      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
70
71      !!----------------------------------------------------------------------
72      !
73      IF( nn_timing == 1 )  CALL timing_start('dyn_ldf')
74      !
75      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
76         CALL wrk_alloc( jpi, jpj, jpk, ztrdu, ztrdv )
77         ztrdu(:,:,:) = ua(:,:,:) 
78         ztrdv(:,:,:) = va(:,:,:) 
79      ENDIF
80
81      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
82      !
83      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
84      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
85      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
86      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
87      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
88         CALL dyn_ldf_lap    ( kt )
89         CALL dyn_ldf_bilap  ( kt )
90      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
91         CALL dyn_ldf_iso    ( kt )
92         CALL dyn_ldf_bilapg ( kt )
93      !
94      CASE ( -1 )                                       ! esopa: test all possibility with control print
95                        CALL dyn_ldf_lap    ( kt )
96                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
97            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
98                        CALL dyn_ldf_iso    ( kt )
99                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
100            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
101                        CALL dyn_ldf_bilap  ( kt )
102                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
103            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
104                        CALL dyn_ldf_bilapg ( kt )
105                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
106            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
107      !
108      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
109         IF( kt == nit000 ) THEN
110            IF(lwp) WRITE(numout,*)
111            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
112            IF(lwp) WRITE(numout,*) '~~~~~~~ '
113         ENDIF
114      END SELECT
115
116      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
117         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
118         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
119         CALL trd_dyn( ztrdu, ztrdv, jpdyn_ldf, kt )
120         CALL wrk_dealloc( jpi, jpj, jpk, ztrdu, ztrdv )
121      ENDIF
122      !                                          ! print sum trends (used for debugging)
123      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
124         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
125      !
126      IF( nn_timing == 1 )  CALL timing_stop('dyn_ldf')
127      !
128      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
129   END SUBROUTINE dyn_ldf
130
131
132   SUBROUTINE dyn_ldf_init
133      !!----------------------------------------------------------------------
134      !!                  ***  ROUTINE dyn_ldf_init  ***
135      !!
136      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
137      !!----------------------------------------------------------------------
138      INTEGER ::   ioptio, ierr         ! temporary integers
139      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
140      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
141      REAL(KIND=jprb)               :: zhook_handle
142
143      CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_LDF_INIT'
144
145      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
146
147      !!----------------------------------------------------------------------
148   
149      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
150
151      IF(lwp) THEN                        ! Namelist print
152         WRITE(numout,*)
153         WRITE(numout,*) 'dyn_ldf_init : Choice of the lateral diffusive operator on dynamics'
154         WRITE(numout,*) '~~~~~~~~~~~'
155         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
156         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
157         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
158         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
159         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
160         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
161      ENDIF
162
163      !                                   ! control the consistency
164      ioptio = 0
165      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
166      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
167      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
168      ioptio = 0
169      IF( ln_dynldf_level )   ioptio = ioptio + 1
170      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
171      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
172      IF( ioptio >  1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
173
174      IF( ln_dynldf_iso .AND. ln_traldf_hor ) CALL ctl_stop &
175      &   ( 'Not sensible to use geopotential diffusion for tracers with isoneutral diffusion for dynamics' )
176
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_level )   nldf = 0      ! iso-level  (no rotation)
182            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
183            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
184         ENDIF
185         IF ( ln_zps ) THEN             ! z-coordinate
186            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
187            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
188            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
189         ENDIF
190         IF ( ln_sco ) THEN             ! s-coordinate
191            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
192            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
193            IF ( ln_dynldf_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_level )   nldf = 2      ! iso-level  (no rotation)
200            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
201            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
202         ENDIF
203         IF ( ln_zps ) THEN             ! z-coordinate
204            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
205            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
206            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
207         ENDIF
208         IF ( ln_sco ) THEN             ! s-coordinate
209            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
210            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
211            IF ( ln_dynldf_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_level )   nldf = 4      ! iso-level  (no rotation)
218            IF ( ln_dynldf_hor   )   nldf = 4      ! horizontal (no rotation)
219            IF ( ln_dynldf_iso   )   ierr = 2      ! 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 = 4      ! horizontal (no rotation)
224            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
225         ENDIF
226         IF ( ln_sco ) THEN             ! s-coordinate
227            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
228            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
229            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
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      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
254   END SUBROUTINE dyn_ldf_init
255
256   !!======================================================================
257END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.