source: trunk/NEMO/OPA_SRC/DYN/dynldf.F90 @ 1152

Last change on this file since 1152 was 1152, checked in by rblod, 12 years ago

Convert cvs header to svn Id, step II

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 10.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      !
72      CASE ( -1 )                                       ! esopa: test all possibility with control print
73                        CALL dyn_ldf_lap    ( kt )
74                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf0 - Ua: ', mask1=umask,   &
75            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
76                        CALL dyn_ldf_iso    ( kt )
77                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf1 - Ua: ', mask1=umask,   &
78            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
79                        CALL dyn_ldf_bilap  ( kt )
80                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf2 - Ua: ', mask1=umask,   &
81            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
82                        CALL dyn_ldf_bilapg ( kt )
83                        CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf3 - Ua: ', mask1=umask,   &
84            &                         tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
85      END SELECT
86
87      IF( l_trddyn ) THEN                        ! save the horizontal diffusive trends for further diagnostics
88         ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:)
89         ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:)
90         CALL trd_mod( ztrdu, ztrdv, jpdyn_trd_ldf, 'DYN', kt )
91      ENDIF
92      !                                          ! print sum trends (used for debugging)
93      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ua, clinfo1=' ldf  - Ua: ', mask1=umask,   &
94         &                       tab3d_2=va, clinfo2=       ' Va: ', mask2=vmask, clinfo3='dyn' )
95      !
96   END SUBROUTINE dyn_ldf
97
98
99   SUBROUTINE dyn_ldf_ctl
100      !!----------------------------------------------------------------------
101      !!                  ***  ROUTINE dyn_ldf_ctl  ***
102      !!
103      !! ** Purpose :   initializations of the horizontal ocean dynamics physics
104      !!----------------------------------------------------------------------
105      INTEGER ::   ioptio, ierr         ! temporary integers
106      !!----------------------------------------------------------------------
107   
108      !                                   ! Namelist nam_dynldf: already read in ldfdyn module
109
110      IF(lwp) THEN                        ! Namelist print
111         WRITE(numout,*)
112         WRITE(numout,*) 'dyn_ldf_ctl : Choice of the lateral diffusive operator on dynamics'
113         WRITE(numout,*) '~~~~~~~~~~~'
114         WRITE(numout,*) '       Namelist nam_dynldf : set lateral mixing parameters (type, direction, coefficients)'
115         WRITE(numout,*) '          laplacian operator          ln_dynldf_lap   = ', ln_dynldf_lap
116         WRITE(numout,*) '          bilaplacian operator        ln_dynldf_bilap = ', ln_dynldf_bilap
117         WRITE(numout,*) '          iso-level                   ln_dynldf_level = ', ln_dynldf_level
118         WRITE(numout,*) '          horizontal (geopotential)   ln_dynldf_hor   = ', ln_dynldf_hor
119         WRITE(numout,*) '          iso-neutral                 ln_dynldf_iso   = ', ln_dynldf_iso
120      ENDIF
121
122      !                                   ! control the consistency
123      ioptio = 0
124      IF( ln_dynldf_lap   )   ioptio = ioptio + 1
125      IF( ln_dynldf_bilap )   ioptio = ioptio + 1
126      IF( ioptio /= 1 ) CALL ctl_stop( '          use ONE of the 2 lap/bilap operator type on dynamics' )
127      ioptio = 0
128      IF( ln_dynldf_level )   ioptio = ioptio + 1
129      IF( ln_dynldf_hor   )   ioptio = ioptio + 1
130      IF( ln_dynldf_iso   )   ioptio = ioptio + 1
131      IF( ioptio /= 1 ) CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
132
133      !                                   ! Set nldf, the type of lateral diffusion, from ln_dynldf_... logicals
134      ierr = 0
135      IF ( ln_dynldf_lap ) THEN      ! laplacian operator
136         IF ( ln_zco ) THEN                ! z-coordinate
137            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
138            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
139            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
140         ENDIF
141         IF ( ln_zps ) THEN             ! z-coordinate
142            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
143            IF ( ln_dynldf_hor   )   nldf = 0      ! horizontal (no rotation)
144            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
145         ENDIF
146         IF ( ln_sco ) THEN             ! z-coordinate
147            IF ( ln_dynldf_level )   nldf = 0      ! iso-level  (no rotation)
148            IF ( ln_dynldf_hor   )   nldf = 1      ! horizontal (   rotation)
149            IF ( ln_dynldf_iso   )   nldf = 1      ! isoneutral (   rotation)
150         ENDIF
151      ENDIF
152
153      IF( ln_dynldf_bilap ) THEN      ! bilaplacian operator
154         IF ( ln_zco ) THEN                ! z-coordinate
155            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
156            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
157            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
158         ENDIF
159         IF ( ln_zps ) THEN             ! z-coordinate
160            IF ( ln_dynldf_level )   ierr = 1      ! iso-level not allowed
161            IF ( ln_dynldf_hor   )   nldf = 2      ! horizontal (no rotation)
162            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
163         ENDIF
164         IF ( ln_sco ) THEN             ! z-coordinate
165            IF ( ln_dynldf_level )   nldf = 2      ! iso-level  (no rotation)
166            IF ( ln_dynldf_hor   )   nldf = 3      ! horizontal (   rotation)
167            IF ( ln_dynldf_iso   )   ierr = 2      ! isoneutral (   rotation)
168         ENDIF
169      ENDIF
170     
171      IF( lk_esopa )                 nldf = -1     ! esopa test
172
173      IF( ierr == 1 )   CALL ctl_stop( 'iso-level in z-coordinate - partial step, not allowed' )
174      IF( ierr == 2 )   CALL ctl_stop( 'isoneutral bilaplacian operator does not exist' )
175      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
176         IF( .NOT.lk_ldfslp )   CALL ctl_stop( 'the rotation of the diffusive tensor require key_ldfslp' )
177      ENDIF
178
179      IF(lwp) THEN
180         WRITE(numout,*)
181         IF( nldf == -1 )   WRITE(numout,*) '              ESOPA test All scheme used'
182         IF( nldf ==  0 )   WRITE(numout,*) '              laplacian operator'
183         IF( nldf ==  1 )   WRITE(numout,*) '              Rotated laplacian operator'
184         IF( nldf ==  2 )   WRITE(numout,*) '              bilaplacian operator'
185         IF( nldf ==  3 )   WRITE(numout,*) '              Rotated bilaplacian'
186      ENDIF
187      !
188   END SUBROUTINE dyn_ldf_ctl
189
190   !!======================================================================
191END MODULE dynldf
Note: See TracBrowser for help on using the repository browser.