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 branches/DEV_r2006_merge_TRA_TRC/NEMO/OPA_SRC/DYN – NEMO

source: branches/DEV_r2006_merge_TRA_TRC/NEMO/OPA_SRC/DYN/dynldf.F90 @ 2104

Last change on this file since 2104 was 2104, checked in by cetlod, 14 years ago

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