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

source: trunk/NEMOGCM/NEMO/OPA_SRC/DYN/dynldf.F90 @ 2528

Last change on this file since 2528 was 2528, checked in by rblod, 13 years ago

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