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/2014/dev_CNRS1_10_TEOS10_Ediag/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/2014/dev_CNRS1_10_TEOS10_Ediag/NEMOGCM/NEMO/OPA_SRC/TRA/traldf.F90 @ 4915

Last change on this file since 4915 was 4619, checked in by gm, 10 years ago

#1294 : TEOS-10 and Ediag

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