source: branches/DEV_r1784_mid_year_merge_2010/NEMO/OPA_SRC/DYN/dynldf.F90 @ 1954

Last change on this file since 1954 was 1954, checked in by acc, 10 years ago

ticket #684 step 4: Add in changes between the head of the dev_r1821_mixed_ldfdyn branch and the trunk@1821

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 12.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_ctl : 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
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   dyn_ldf   ! called by step module
33
34   INTEGER ::   nldf = 0   ! type of lateral diffusion used defined from ln_dynldf_... namlist logicals)
35
36   !! * Substitutions
37#  include "domzgr_substitute.h90"
38#  include "vectopt_loop_substitute.h90"
39   !!---------------------------------------------------------------------------------
40   !!   OPA 9.0 , LOCEAN-IPSL (2005)
41   !! $Id$
42   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44
45CONTAINS
46
47   SUBROUTINE dyn_ldf( kt )
48      !!----------------------------------------------------------------------
49      !!                  ***  ROUTINE dyn_ldf  ***
50      !!
51      !! ** Purpose :   compute the lateral ocean dynamics physics.
52      !!----------------------------------------------------------------------
53      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
54      !!
55      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   ztrdu, ztrdv   ! 3D workspace
56      !!----------------------------------------------------------------------
57
58      IF( kt == nit000 )   CALL dyn_ldf_ctl      ! initialisation & control of options
59
60      IF( l_trddyn )   THEN                      ! temporary save of ta and sa trends
61         ztrdu(:,:,:) = ua(:,:,:) 
62         ztrdv(:,:,:) = va(:,:,:) 
63      ENDIF
64
65      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
66      !
67      CASE ( 0 )    ;   CALL dyn_ldf_lap    ( kt )      ! iso-level laplacian
68      CASE ( 1 )    ;   CALL dyn_ldf_iso    ( kt )      ! rotated laplacian (except dk[ dk[.] ] part)
69      CASE ( 2 )    ;   CALL dyn_ldf_bilap  ( kt )      ! iso-level bilaplacian
70      CASE ( 3 )    ;   CALL dyn_ldf_bilapg ( kt )      ! s-coord. horizontal bilaplacian
71      CASE ( 4 )                                        ! iso-level laplacian + bilaplacian
72         CALL dyn_ldf_lap    ( kt )
73         CALL dyn_ldf_bilap  ( kt )
74      CASE ( 5 )                                        ! rotated laplacian + bilaplacian (s-coord)
75         CALL dyn_ldf_iso    ( kt )
76         CALL dyn_ldf_bilapg ( kt )
77      !
78      CASE ( -1 )                                       ! esopa: test all possibility with control print
79                        CALL dyn_ldf_lap    ( kt )
80                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
81            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
82                        CALL dyn_ldf_iso    ( kt )
83                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
84            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
85                        CALL dyn_ldf_bilap  ( kt )
86                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
87            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
88                        CALL dyn_ldf_bilapg ( kt )
89                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
90            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
91      !
92      CASE ( -2 )                                       ! neither laplacian nor bilaplacian schemes used
93         IF( kt == nit000 ) THEN
94            IF(lwp) WRITE(numout,*)
95            IF(lwp) WRITE(numout,*) 'dyn_ldf : no lateral diffusion on momentum setup'
96            IF(lwp) WRITE(numout,*) '~~~~~~~ '
97         ENDIF
98      END SELECT
99
100      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
101         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
102         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
103         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_ldf, 'DYN', kt )
104      ENDIF
105      !                                          ! print sum trends (used for debugging)
106      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
107         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
108      !
109   END SUBROUTINE dyn_ldf
110
111
112   SUBROUTINE dyn_ldf_ctl
113      !!----------------------------------------------------------------------
114      !!                  ***  ROUTINE dyn_ldf_ctl  ***
115      !!
116      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
117      !!----------------------------------------------------------------------
118      INTEGER ::   ioptio, ierr         ! temporary integers
119      !!----------------------------------------------------------------------
120   
121      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
122
123      IF(lwp) THEN                        ! Namelist print
124         WRITE(numout,*)
125         WRITE(numout,*) 'dyn_ldf_ctl : Choice of the lateral diffusive operator on dynamics'
126         WRITE(numout,*) '~~~~~~~~~~~'
127         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
128         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
129         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
130         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
131         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
132         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
133      ENDIF
134
135      !                                   ! control the consistency
136      ioptio = 0
137      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
138      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
139      IF( ioptio <  1 ) CALL ctl_warn( '          neither laplacian nor bilaplacian operator set for dynamics' )
140      ioptio = 0
141      IF( ln_dynldf_level )   ioptio = ioptio + 1
142      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
143      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
144      IF( ioptio /= 1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
145
146      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
147      ierr = 0
148      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
149         IF ( ln_zco ) THEN                ! z-coordinate
150            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
151            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
152            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
153         ENDIF
154         IF ( ln_zps ) THEN             ! z-coordinate
155            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
156            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
157            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
158         ENDIF
159         IF ( ln_sco ) THEN             ! s-coordinate
160            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
161            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
162            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
163         ENDIF
164      ENDIF
165
166      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
167         IF ( ln_zco ) THEN                ! z-coordinate
168            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
169            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
170            IF ( ln_dynldf_iso   )   ierr = 2      ! 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 = 2      ! horizontal (no rotation)
175            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
176         ENDIF
177         IF ( ln_sco ) THEN             ! s-coordinate
178            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
179            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
180            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
181         ENDIF
182      ENDIF
183     
184      IF( ln_dynldf_lap .AND. ln_dynldf_bilap ) THEN  ! mixed laplacian and bilaplacian operators
185         IF ( ln_zco ) THEN                ! z-coordinate
186            IF ( ln_dynldf_level )   nldf = 4      ! iso-level  (no rotation)
187            IF ( ln_dynldf_hor   )   nldf = 4      ! 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 = 4      ! 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 = 4      ! iso-level  (no rotation)
197            IF ( ln_dynldf_hor   )   nldf = 5      ! horizontal (   rotation)
198            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
199         ENDIF
200      ENDIF
201
202      IF( lk_esopa )                 nldf = -1     ! esopa test
203
204      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
205      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
206      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
207         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
208      ENDIF
209
210      IF(lwp) THEN
211         WRITE(numout,*)
212         IF( nldf == -2 )   WRITE(numout,*) '              neither laplacian nor bilaplacian schemes used'
213         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
214         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
215         IF( nldf ==  1 )   WRITE(numout,*) '              rotated laplacian operator'
216         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
217         IF( nldf ==  3 )   WRITE(numout,*) '              rotated bilaplacian'
218         IF( nldf ==  4 )   WRITE(numout,*) '              laplacian and bilaplacian operators'
219         IF( nldf ==  5 )   WRITE(numout,*) '              rotated laplacian and bilaplacian operators'
220      ENDIF
221      !
222   END SUBROUTINE dyn_ldf_ctl
223
224   !!======================================================================
225END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.