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.
traldf.F90 in branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/TRA/traldf.F90 @ 2399

Last change on this file since 2399 was 2399, checked in by gm, 13 years ago

v3.3beta: diaptr (poleward heat & salt transports) #759 : rewriting including dynamical allocation + DOCTOR names

  • Property svn:keywords set to Id
File size: 16.0 KB
Line 
1MODULE traldf
2   !!======================================================================
3   !!                       ***  MODULE  traldf  ***
4   !! Ocean Active tracers : lateral diffusive trends
5   !!=====================================================================
6   !! History :  9.0  ! 2005-11 (G. Madec)  Original code
7   !!       NEMO 3.0  ! 2008-01  (C. Ethe, G. Madec)  merge TRC-TRA
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   tra_ldf      : update the tracer trend with the lateral diffusion
12   !!   tra_ldf_init : initialization, namelist read, and parameters control
13   !!       ldf_ano  : compute lateral diffusion for constant T-S profiles
14   !!----------------------------------------------------------------------
15   USE oce             ! ocean dynamics and tracers
16   USE dom_oce         ! ocean space and time domain
17   USE phycst          ! physical constants
18   USE ldftra_oce      ! ocean tracer   lateral physics
19   USE ldfslp          ! ???
20   USE traldf_bilapg   ! lateral mixing            (tra_ldf_bilapg routine)
21   USE traldf_bilap    ! lateral mixing             (tra_ldf_bilap routine)
22   USE traldf_iso      ! lateral mixing               (tra_ldf_iso routine)
23   USE traldf_iso_grif ! lateral mixing          (tra_ldf_iso_grif routine)
24   USE traldf_lap      ! lateral mixing               (tra_ldf_lap routine)
25   USE trdmod_oce      ! ocean space and time domain
26   USE trdtra          ! ocean active tracers trends
27   USE prtctl          ! Print control
28   USE in_out_manager  ! I/O manager
29   USE lib_mpp         ! distribued memory computing library
30   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   tra_ldf         ! called by step.F90
36   PUBLIC   tra_ldf_init    ! called by opa.F90
37   !
38   INTEGER ::   nldf = 0   ! type of lateral diffusion used defined from ln_traldf_... namlist logicals)
39#if defined key_traldf_ano
40   REAL, DIMENSION(jpi,jpj,jpk) ::   t0_ldf, s0_ldf   ! lateral diffusion trends of T & S for a constant profile
41#endif
42
43   !! * Substitutions
44#  include "domzgr_substitute.h90"
45#  include "vectopt_loop_substitute.h90"
46   !!----------------------------------------------------------------------
47   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
48   !! $Id$
49   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
51CONTAINS
52
53   SUBROUTINE tra_ldf( kt )
54      !!----------------------------------------------------------------------
55      !!                  ***  ROUTINE tra_ldf  ***
56      !!
57      !! ** Purpose :   compute the lateral ocean tracer physics.
58      !!----------------------------------------------------------------------
59      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
60      !!
61      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  ztrdt, ztrds
62      !!----------------------------------------------------------------------
63
64      IF( l_trdtra )   THEN                    !* Save ta and sa trends
65         ALLOCATE( ztrdt(jpi,jpj,jpk) )   ;    ztrdt(:,:,:) = tsa(:,:,:,jp_tem) 
66         ALLOCATE( ztrds(jpi,jpj,jpk) )   ;    ztrds(:,:,:) = tsa(:,:,:,jp_sal)
67      ENDIF
68
69      SELECT CASE ( nldf )                       ! compute lateral mixing trend and add it to the general trend
70      CASE ( 0 )   ;   CALL tra_ldf_lap     ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts        )  ! iso-level laplacian
71      CASE ( 1 )                                                                              ! rotated laplacian
72         IF( ln_traldf_grif ) THEN                                                         
73                       CALL tra_ldf_iso_grif( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts, ahtb0 )      ! Griffies operator
74         ELSE                                                                               
75                       CALL tra_ldf_iso     ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts, ahtb0 )      ! Madec operator
76         ENDIF
77      CASE ( 2 )   ;   CALL tra_ldf_bilap   ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts        )  ! iso-level bilaplacian
78      CASE ( 3 )   ;   CALL tra_ldf_bilapg  ( kt, 'TRA',             tsb, tsa, jpts        )  ! s-coord. geopot. bilap.
79         !
80      CASE ( -1 )                                ! esopa: test all possibility with control print
81         CALL tra_ldf_lap   ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts        ) 
82         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' ldf0 - Ta: ', mask1=tmask,               &
83         &             tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
84         IF( ln_traldf_grif ) THEN
85            CALL tra_ldf_iso_grif( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts, ahtb0 )
86         ELSE
87            CALL tra_ldf_iso     ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts, ahtb0 ) 
88         ENDIF
89         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' ldf1 - Ta: ', mask1=tmask,               &
90         &             tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
91         CALL tra_ldf_bilap ( kt, 'TRA', gtsu, gtsv, tsb, tsa, jpts        ) 
92         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' ldf2 - Ta: ', mask1=tmask,               &
93         &             tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
94         CALL tra_ldf_bilapg( kt, 'TRA',             tsb, tsa, jpts        ) 
95         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' ldf3 - Ta: ', mask1=tmask,               &
96         &             tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
97      END SELECT
98
99#if defined key_traldf_ano
100      tsa(:,:,:,jp_tem) = tsa(:,:,:,jp_tem) - t0_ldf(:,:,:)      ! anomaly: substract the reference diffusivity
101      tsa(:,:,:,jp_sal) = tsa(:,:,:,jp_sal) - s0_ldf(:,:,:)
102#endif
103
104      IF( l_trdtra )   THEN                      ! save the horizontal diffusive trends for further diagnostics
105         ztrdt(:,:,:) = tsa(:,:,:,jp_tem) - ztrdt(:,:,:)
106         ztrds(:,:,:) = tsa(:,:,:,jp_sal) - ztrds(:,:,:)
107         CALL trd_tra( kt, 'TRA', jp_tem, jptra_trd_ldf, ztrdt )
108         CALL trd_tra( kt, 'TRA', jp_sal, jptra_trd_ldf, ztrds )
109         DEALLOCATE( ztrdt )      ;     DEALLOCATE( ztrds ) 
110      ENDIF
111      !                                          ! print mean trends (used for debugging)
112      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' ldf  - Ta: ', mask1=tmask,               &
113         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
114      !
115   END SUBROUTINE tra_ldf
116
117
118   SUBROUTINE tra_ldf_init
119      !!----------------------------------------------------------------------
120      !!                  ***  ROUTINE tra_ldf_init  ***
121      !!
122      !! ** Purpose :   Choice of the operator for the lateral tracer diffusion
123      !!
124      !! ** Method  :   set nldf from the namtra_ldf logicals
125      !!      nldf == -1   ESOPA test: ALL operators are used
126      !!      nldf ==  0   laplacian operator
127      !!      nldf ==  1   Rotated laplacian operator
128      !!      nldf ==  2   bilaplacian operator
129      !!      nldf ==  3   Rotated bilaplacian
130      !!----------------------------------------------------------------------
131      INTEGER ::   ioptio, ierr         ! temporary integers
132!     
133      !!----------------------------------------------------------------------
134
135      !  Define the lateral mixing oparator for tracers
136      ! ===============================================
137   
138      IF(lwp) THEN                    ! Namelist print
139         WRITE(numout,*)
140         WRITE(numout,*) 'tra_ldf_init : lateral tracer diffusive operator'
141         WRITE(numout,*) '~~~~~~~~~~~'
142         WRITE(numout,*) '   Namelist namtra_ldf already read in ldftra module'
143         WRITE(numout,*) '   see ldf_tra_init report for lateral mixing parameters'
144         WRITE(numout,*)
145      ENDIF
146
147      !                               ! control the input
148      ioptio = 0
149      IF( ln_traldf_lap   )   ioptio = ioptio + 1
150      IF( ln_traldf_bilap )   ioptio = ioptio + 1
151      IF( ioptio >  1 )   CALL ctl_stop( '          use ONE or NONE of the 2 lap/bilap operator type on tracer' )
152      IF( ioptio == 0 )   nldf = -2   ! No lateral diffusion
153      ioptio = 0
154      IF( ln_traldf_level )   ioptio = ioptio + 1
155      IF( ln_traldf_hor   )   ioptio = ioptio + 1
156      IF( ln_traldf_iso   )   ioptio = ioptio + 1
157      IF( ioptio /= 1 )   CALL ctl_stop( '          use only ONE direction (level/hor/iso)' )
158
159      ! defined the type of lateral diffusion from ln_traldf_... logicals
160      ! CAUTION : nldf = 1 is used in trazdf_imp, change it carefully
161      ierr = 0
162      IF( ln_traldf_lap ) THEN       ! laplacian operator
163         IF ( ln_zco ) THEN                ! z-coordinate
164            IF ( ln_traldf_level )   nldf = 0      ! iso-level  (no rotation)
165            IF ( ln_traldf_hor   )   nldf = 0      ! horizontal (no rotation)
166            IF ( ln_traldf_iso   )   nldf = 1      ! isoneutral (   rotation)
167         ENDIF
168         IF ( ln_zps ) THEN             ! z-coordinate
169            IF ( ln_traldf_level )   ierr = 1      ! iso-level not allowed
170            IF ( ln_traldf_hor   )   nldf = 0      ! horizontal (no rotation)
171            IF ( ln_traldf_iso   )   nldf = 1      ! isoneutral (   rotation)
172         ENDIF
173         IF ( ln_sco ) THEN             ! z-coordinate
174            IF ( ln_traldf_level )   nldf = 0      ! iso-level  (no rotation)
175            IF ( ln_traldf_hor   )   nldf = 1      ! horizontal (   rotation)
176            IF ( ln_traldf_iso   )   nldf = 1      ! isoneutral (   rotation)
177         ENDIF
178      ENDIF
179
180      IF( ln_traldf_bilap ) THEN      ! bilaplacian operator
181         IF ( ln_zco ) THEN                ! z-coordinate
182            IF ( ln_traldf_level )   nldf = 2      ! iso-level  (no rotation)
183            IF ( ln_traldf_hor   )   nldf = 2      ! horizontal (no rotation)
184            IF ( ln_traldf_iso   )   ierr = 2      ! isoneutral (   rotation)
185         ENDIF
186         IF ( ln_zps ) THEN             ! z-coordinate
187            IF ( ln_traldf_level )   ierr = 1      ! iso-level not allowed
188            IF ( ln_traldf_hor   )   nldf = 2      ! horizontal (no rotation)
189            IF ( ln_traldf_iso   )   ierr = 2      ! isoneutral (   rotation)
190         ENDIF
191         IF ( ln_sco ) THEN             ! z-coordinate
192            IF ( ln_traldf_level )   nldf = 2      ! iso-level  (no rotation)
193            IF ( ln_traldf_hor   )   nldf = 3      ! horizontal (   rotation)
194            IF ( ln_traldf_iso   )   ierr = 2      ! isoneutral (   rotation)
195         ENDIF
196      ENDIF
197
198      IF( ierr == 1 )   CALL ctl_stop( ' iso-level in z-coordinate - partial step, not allowed' )
199      IF( ierr == 2 )   CALL ctl_stop( ' isoneutral bilaplacian operator does not exist' )
200      IF( lk_traldf_eiv .AND. .NOT.ln_traldf_iso )   &
201           CALL ctl_stop( '          eddy induced velocity on tracers',   &
202           &              ' the eddy induced velocity on tracers requires isopycnal laplacian diffusion' )
203      IF( nldf == 1 .OR. nldf == 3 ) THEN      ! rotation
204         IF( .NOT.lk_ldfslp )   CALL ctl_stop( '          the rotation of the diffusive tensor require key_ldfslp' )
205         l_traldf_rot = .TRUE.                 ! needed for trazdf_imp
206      ENDIF
207
208      IF( lk_esopa ) THEN
209         IF(lwp) WRITE(numout,*) '          esopa control: use all lateral physics options'
210         nldf = -1
211      ENDIF
212
213      IF(lwp) THEN
214         WRITE(numout,*)
215         IF( nldf == -2 )   WRITE(numout,*) '          NO lateral diffusion'
216         IF( nldf == -1 )   WRITE(numout,*) '          ESOPA test All scheme used'
217         IF( nldf ==  0 )   WRITE(numout,*) '          laplacian operator'
218         IF( nldf ==  1 )   WRITE(numout,*) '          Rotated laplacian operator'
219         IF( nldf ==  2 )   WRITE(numout,*) '          bilaplacian operator'
220         IF( nldf ==  3 )   WRITE(numout,*) '          Rotated bilaplacian'
221      ENDIF
222
223      ! Reference T & S diffusivity (if necessary)
224      ! ===========================
225      CALL ldf_ano
226      !
227   END SUBROUTINE tra_ldf_init
228
229#if defined key_traldf_ano
230   !!----------------------------------------------------------------------
231   !!   'key_traldf_ano'               T & S lateral diffusion on anomalies
232   !!----------------------------------------------------------------------
233
234   SUBROUTINE ldf_ano
235      !!----------------------------------------------------------------------
236      !!                  ***  ROUTINE ldf_ano  ***
237      !!
238      !! ** Purpose :   initializations of
239      !!----------------------------------------------------------------------
240      USE zdf_oce         ! vertical mixing
241      USE trazdf          ! vertical mixing: double diffusion
242      USE zdfddm          ! vertical mixing: double diffusion
243      !!
244      INTEGER  ::   jk              ! Dummy loop indice
245      LOGICAL  ::   llsave          !
246      REAL(wp) ::   zt0, zs0, z12   ! temporary scalar
247      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zt_ref, ztb, zavt   ! 3D workspace
248      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zs_ref, zsb         ! 3D workspace
249      !!----------------------------------------------------------------------
250
251      IF(lwp) THEN
252         WRITE(numout,*)
253         WRITE(numout,*) 'tra:ldf_ano : lateral diffusion acting on anomalies'
254         WRITE(numout,*) '~~~~~~~~~~~'
255      ENDIF
256
257      ! defined the T & S reference profiles
258      ! ------------------------------------
259      zt0 =10.e0                               ! homogeneous ocean
260      zs0 =35.e0
261      zt_ref(:,:,:) = 10.0 * tmask(:,:,:)
262      zs_ref(:,:,:) = 35.0 * tmask(:,:,:)
263      IF(lwp) WRITE(numout,*) '              homogeneous ocean T = ', zt0, ' S = ',zs0
264
265      !                                        ! T & S profile (to be coded +namelist parameter
266
267      ! prepare the ldf computation
268      ! ---------------------------
269      llsave = l_trdtra
270      l_trdtra = .false.      ! desactivate trend computation
271      t0_ldf(:,:,:) = 0.e0
272      s0_ldf(:,:,:) = 0.e0
273      ztb   (:,:,:) = tsb (:,:,:,jp_tem)
274      zsb   (:,:,:) = tsb (:,:,:,jp_sal)
275      ua    (:,:,:) = tsa (:,:,:,jp_tem)
276      va    (:,:,:) = tsa (:,:,:,jp_sal)
277      zavt  (:,:,:) = avt(:,:,:)
278      IF( lk_zdfddm ) THEN CALL ctl_stop( ' key_traldf_ano with key_zdfddm not implemented' )
279      ! set tb, sb to reference values and avr to zero
280      tsb (:,:,:,jp_tem) = zt_ref(:,:,:)
281      tsb (:,:,:,jp_sal) = zs_ref(:,:,:)
282      tsa (:,:,:,jp_tem) = 0.e0
283      tsa (:,:,:,jp_sal) = 0.e0
284      avt(:,:,:)         = 0.e0
285
286      ! Compute the ldf trends
287      ! ----------------------
288      CALL tra_ldf( nit000+1 )      ! horizontal components (+1: no more init)
289      CALL tra_zdf( nit000   )      ! vertical component (if necessary nit000 to performed the init)
290
291      ! finalise the computation and recover all arrays
292      ! -----------------------------------------------
293      l_trdtra = llsave
294      z12 = 2.e0
295      IF( neuler == 1)   z12 = 1.e0
296      IF( ln_zdfexp ) THEN      ! ta,sa are the trends
297         t0_ldf(:,:,:) = tsa(:,:,:,jp_tem)
298         s0_ldf(:,:,:) = tsa(:,:,:,jp_sal)
299      ELSE
300         DO jk = 1, jpkm1
301            t0_ldf(:,:,jk) = ( tsa(:,:,jk,jp_tem) - tsb(:,:,jk,jp_tem) ) / ( z12 *rdttra(jk) )
302            s0_ldf(:,:,jk) = ( tsa(:,:,jk,jp_sal) - tsb(:,:,jk,jp_sal) ) / ( z12 *rdttra(jk) )
303         END DO
304      ENDIF
305      tsb(:,:,:,jp_tem) = ztb (:,:,:)
306      tsb(:,:,:,jp_sal) = zsb (:,:,:)
307      tsa(:,:,:,jp_tem) = ua  (:,:,:)
308      tsa(:,:,:,jp_sal) = va  (:,:,:)
309      avt(:,:,:)        = zavt(:,:,:)
310      !
311   END SUBROUTINE ldf_ano
312
313#else
314   !!----------------------------------------------------------------------
315   !!   default option :   Dummy code   NO T & S background profiles
316   !!----------------------------------------------------------------------
317   SUBROUTINE ldf_ano
318      IF(lwp) THEN
319         WRITE(numout,*)
320         WRITE(numout,*) 'tra:ldf_ano : lateral diffusion acting on the full fields'
321         WRITE(numout,*) '~~~~~~~~~~~'
322      ENDIF
323   END SUBROUTINE ldf_ano
324#endif
325
326   !!======================================================================
327END MODULE traldf
Note: See TracBrowser for help on using the repository browser.