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.
trazdf.F90 in NEMO/branches/2020/dev_r13898_Tiling_Cleanup_MPI3/tests/CANAL/MY_SRC – NEMO

source: NEMO/branches/2020/dev_r13898_Tiling_Cleanup_MPI3/tests/CANAL/MY_SRC/trazdf.F90 @ 13906

Last change on this file since 13906 was 13906, checked in by mocavero, 4 years ago

Merge with dev_r13296_HPC-07_mocavero_mpi3
  • Property svn:keywords set to Id
File size: 13.1 KB
Line 
1MODULE trazdf
2   !!==============================================================================
3   !!                 ***  MODULE  trazdf  ***
4   !! Ocean active tracers:  vertical component of the tracer mixing trend
5   !!==============================================================================
6   !! History :  1.0  !  2005-11  (G. Madec)  Original code
7   !!            3.0  !  2008-01  (C. Ethe, G. Madec)  merge TRC-TRA
8   !!            4.0  !  2017-06  (G. Madec)  remove explict time-stepping option
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   tra_zdf       : Update the tracer trend with the vertical diffusion
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers variables
15   USE dom_oce        ! ocean space and time domain variables
16   USE domvvl         ! variable volume
17   USE phycst         ! physical constant
18   USE zdf_oce        ! ocean vertical physics variables
19   USE sbc_oce        ! surface boundary condition: ocean
20   USE ldftra         ! lateral diffusion: eddy diffusivity
21   USE ldfslp         ! lateral diffusion: iso-neutral slope
22   USE trd_oce        ! trends: ocean variables
23   USE trdtra         ! trends: tracer trend manager
24   !
25   USE in_out_manager ! I/O manager
26   USE prtctl         ! Print control
27   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
28   USE lib_mpp        ! MPP library
29   USE timing         ! Timing
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC   tra_zdf       ! called by step.F90
35   PUBLIC   tra_zdf_imp   ! called by trczdf.F90
36
37   !! * Substitutions
38#  include "do_loop_substitute.h90"
39   !!----------------------------------------------------------------------
40   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
41   !! $Id$
42   !! Software governed by the CeCILL license (see ./LICENSE)
43   !!----------------------------------------------------------------------
44CONTAINS
45
46   SUBROUTINE tra_zdf( kt, Kbb, Kmm, Krhs, pts, Kaa )
47      !!----------------------------------------------------------------------
48      !!                  ***  ROUTINE tra_zdf  ***
49      !!
50      !! ** Purpose :   compute the vertical ocean tracer physics.
51      !!---------------------------------------------------------------------
52      INTEGER                                  , INTENT(in)    :: kt                  ! ocean time-step index
53      INTEGER                                  , INTENT(in)    :: Kbb, Kmm, Krhs, Kaa ! time level indices
54      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts                 ! active tracers and RHS of tracer equation
55      !
56      INTEGER  ::   ji, jj, jk   ! Dummy loop indices
57      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::   ztrdt, ztrds   ! 3D workspace
58      !!---------------------------------------------------------------------
59      !
60      IF( ln_timing )   CALL timing_start('tra_zdf')
61      !
62      IF( kt == nit000 )  THEN
63         IF( ntile == 0 .OR. ntile == 1 )  THEN                   ! Do only on the first tile
64            IF(lwp)WRITE(numout,*)
65            IF(lwp)WRITE(numout,*) 'tra_zdf : implicit vertical mixing on T & S'
66            IF(lwp)WRITE(numout,*) '~~~~~~~ '
67         ENDIF
68      ENDIF
69      !
70      IF( l_trdtra )   THEN                  !* Save ta and sa trends
71         ALLOCATE( ztrdt(jpi,jpj,jpk) , ztrds(jpi,jpj,jpk) )
72         ztrdt(:,:,:) = pts(:,:,:,jp_tem,Kaa)
73         ztrds(:,:,:) = pts(:,:,:,jp_sal,Kaa)
74      ENDIF
75      !
76      !                                      !* compute lateral mixing trend and add it to the general trend
77      CALL tra_zdf_imp( kt, nit000, 'TRA', rDt, Kbb, Kmm, Krhs, pts, Kaa, jpts ) 
78
79!!gm WHY here !   and I don't like that !
80      ! DRAKKAR SSS control {
81      ! JMM avoid negative salinities near river outlet ! Ugly fix
82      ! JMM : restore negative salinities to small salinities:
83!!$      WHERE( pts(:,:,:,jp_sal,Kaa) < 0._wp )   pts(:,:,:,jp_sal,Kaa) = 0.1_wp
84!!gm
85
86      IF( l_trdtra )   THEN                      ! save the vertical diffusive trends for further diagnostics
87         DO jk = 1, jpk
88            ztrdt(:,:,jk) = (   (  pts(:,:,jk,jp_tem,Kaa)*e3t(:,:,jk,Kaa)     &
89               &                 - pts(:,:,jk,jp_tem,Kbb)*e3t(:,:,jk,Kbb)  )  &
90               &              / (  e3t(:,:,jk,Kmm)*rDt  )   )                 &
91               &          - ztrdt(:,:,jk)
92            ztrds(:,:,jk) = (   (  pts(:,:,jk,jp_sal,Kaa)*e3t(:,:,jk,Kaa)     &
93               &                 - pts(:,:,jk,jp_sal,Kbb)*e3t(:,:,jk,Kbb)  )  &
94               &             / (   e3t(:,:,jk,Kmm)*rDt  )   )                 &
95               &          - ztrds(:,:,jk)
96         END DO
97!!gm this should be moved in trdtra.F90 and done on all trends
98#if defined key_mpi3
99         CALL lbc_lnk_nc_multi( 'trazdf', ztrdt, 'T', 1. , ztrds, 'T', 1. )
100#else
101         CALL lbc_lnk_multi( 'trazdf', ztrdt, 'T', 1. , ztrds, 'T', 1. )
102#endif
103!!gm
104         CALL trd_tra( kt, Kmm, Krhs, 'TRA', jp_tem, jptra_zdf, ztrdt )
105         CALL trd_tra( kt, Kmm, Krhs, 'TRA', jp_sal, jptra_zdf, ztrds )
106         DEALLOCATE( ztrdt , ztrds )
107      ENDIF
108      !                                          ! print mean trends (used for debugging)
109      IF(sn_cfctl%l_prtctl)   CALL prt_ctl( tab3d_1=pts(:,:,:,jp_tem,Kaa), clinfo1=' zdf  - Ta: ', mask1=tmask,               &
110         &                                  tab3d_2=pts(:,:,:,jp_sal,Kaa), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
111      !
112      IF( ln_timing )   CALL timing_stop('tra_zdf')
113      !
114   END SUBROUTINE tra_zdf
115
116 
117   SUBROUTINE tra_zdf_imp( kt, kit000, cdtype, p2dt, Kbb, Kmm, Krhs, pt, Kaa, kjpt ) 
118      !!----------------------------------------------------------------------
119      !!                  ***  ROUTINE tra_zdf_imp  ***
120      !!
121      !! ** Purpose :   Compute the after tracer through a implicit computation
122      !!     of the vertical tracer diffusion (including the vertical component
123      !!     of lateral mixing (only for 2nd order operator, for fourth order
124      !!     it is already computed and add to the general trend in traldf)
125      !!
126      !! ** Method  :  The vertical diffusion of a tracer ,t , is given by:
127      !!          difft = dz( avt dz(t) ) = 1/e3t dk+1( avt/e3w dk(t) )
128      !!      It is computed using a backward time scheme (t=after field)
129      !!      which provide directly the after tracer field.
130      !!      If ln_zdfddm=T, use avs for salinity or for passive tracers
131      !!      Surface and bottom boundary conditions: no diffusive flux on
132      !!      both tracers (bottom, applied through the masked field avt).
133      !!      If iso-neutral mixing, add to avt the contribution due to lateral mixing.
134      !!
135      !! ** Action  : - pt(:,:,:,:,Kaa)  becomes the after tracer
136      !!---------------------------------------------------------------------
137      INTEGER                                  , INTENT(in   ) ::   kt       ! ocean time-step index
138      INTEGER                                  , INTENT(in   ) ::   Kbb, Kmm, Krhs, Kaa  ! ocean time level indices
139      INTEGER                                  , INTENT(in   ) ::   kit000   ! first time step index
140      CHARACTER(len=3)                         , INTENT(in   ) ::   cdtype   ! =TRA or TRC (tracer indicator)
141      INTEGER                                  , INTENT(in   ) ::   kjpt     ! number of tracers
142      REAL(wp)                                 , INTENT(in   ) ::   p2dt     ! tracer time-step
143      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt,jpt), INTENT(inout) ::   pt       ! tracers and RHS of tracer equation
144      !
145      INTEGER  ::  ji, jj, jk, jn   ! dummy loop indices
146      REAL(wp) ::  zrhs, zzwi, zzws ! local scalars
147      REAL(wp), DIMENSION(A2D(nn_hls),jpk) ::  zwi, zwt, zwd, zws
148      !!---------------------------------------------------------------------
149      !
150      !                                               ! ============= !
151      DO jn = 1, kjpt                                 !  tracer loop  !
152         !                                            ! ============= !
153         !  Matrix construction
154         ! --------------------
155         ! Build matrix if temperature or salinity (only in double diffusion case) or first passive tracer
156         !
157         IF(  ( cdtype == 'TRA' .AND. ( jn == jp_tem .OR. ( jn == jp_sal .AND. ln_zdfddm ) ) ) .OR.   &
158            & ( cdtype == 'TRC' .AND. jn == 1 )  )  THEN
159            !
160            ! vertical mixing coef.: avt for temperature, avs for salinity and passive tracers
161            IF( cdtype == 'TRA' .AND. jn == jp_tem ) THEN
162               DO_3D( 1, 1, 1, 1, 2, jpk )
163                  zwt(ji,jj,jk) = avt(ji,jj,jk)
164               END_3D
165            ELSE
166               DO_3D( 1, 1, 1, 1, 2, jpk )
167                  zwt(ji,jj,jk) = avs(ji,jj,jk)
168               END_3D
169            ENDIF
170            zwt(:,:,1) = 0._wp
171            !
172            IF( l_ldfslp ) THEN            ! isoneutral diffusion: add the contribution
173               IF( ln_traldf_msc  ) THEN     ! MSC iso-neutral operator
174                  DO_3D( 0, 0, 0, 0, 2, jpkm1 )
175                     zwt(ji,jj,jk) = zwt(ji,jj,jk) + akz(ji,jj,jk) 
176                  END_3D
177               ELSE                          ! standard or triad iso-neutral operator
178                  DO_3D( 0, 0, 0, 0, 2, jpkm1 )
179                     zwt(ji,jj,jk) = zwt(ji,jj,jk) + ah_wslp2(ji,jj,jk)
180                  END_3D
181               ENDIF
182            ENDIF
183            !
184            ! Diagonal, lower (i), upper (s)  (including the bottom boundary condition since avt is masked)
185            IF( ln_zad_Aimp ) THEN         ! Adaptive implicit vertical advection
186               DO_3D( 0, 0, 0, 0, 1, jpkm1 )
187                  zzwi = - p2dt * zwt(ji,jj,jk  ) / e3w(ji,jj,jk  ,Kmm)
188                  zzws = - p2dt * zwt(ji,jj,jk+1) / e3w(ji,jj,jk+1,Kmm)
189                  zwd(ji,jj,jk) = e3t(ji,jj,jk,Kaa) - zzwi - zzws   &
190                     &                 + p2dt * ( MAX( wi(ji,jj,jk  ) , 0._wp ) - MIN( wi(ji,jj,jk+1) , 0._wp ) )
191                  zwi(ji,jj,jk) = zzwi + p2dt *   MIN( wi(ji,jj,jk  ) , 0._wp )
192                  zws(ji,jj,jk) = zzws - p2dt *   MAX( wi(ji,jj,jk+1) , 0._wp )
193               END_3D
194            ELSE
195               DO_3D( 0, 0, 0, 0, 1, jpkm1 )
196                  zwi(ji,jj,jk) = - p2dt * zwt(ji,jj,jk  ) / e3w(ji,jj,jk,Kmm)
197                  zws(ji,jj,jk) = - p2dt * zwt(ji,jj,jk+1) / e3w(ji,jj,jk+1,Kmm)
198                  zwd(ji,jj,jk) = e3t(ji,jj,jk,Kaa) - zwi(ji,jj,jk) - zws(ji,jj,jk)
199               END_3D
200            ENDIF
201            !
202            !! Matrix inversion from the first level
203            !!----------------------------------------------------------------------
204            !   solve m.x = y  where m is a tri diagonal matrix ( jpk*jpk )
205            !
206            !        ( zwd1 zws1   0    0    0  )( zwx1 ) ( zwy1 )
207            !        ( zwi2 zwd2 zws2   0    0  )( zwx2 ) ( zwy2 )
208            !        (  0   zwi3 zwd3 zws3   0  )( zwx3 )=( zwy3 )
209            !        (        ...               )( ...  ) ( ...  )
210            !        (  0    0    0   zwik zwdk )( zwxk ) ( zwyk )
211            !
212            !   m is decomposed in the product of an upper and lower triangular matrix.
213            !   The 3 diagonal terms are in 3d arrays: zwd, zws, zwi.
214            !   Suffices i,s and d indicate "inferior" (below diagonal), diagonal
215            !   and "superior" (above diagonal) components of the tridiagonal system.
216            !   The solution will be in the 4d array pta.
217            !   The 3d array zwt is used as a work space array.
218            !   En route to the solution pt(:,:,:,:,Kaa) is used a to evaluate the rhs and then
219            !   used as a work space array: its value is modified.
220            !
221            DO_2D( 0, 0, 0, 0 )
222               zwt(ji,jj,1) = zwd(ji,jj,1)
223            END_2D
224            DO_3D( 0, 0, 0, 0, 2, jpkm1 )
225               zwt(ji,jj,jk) = zwd(ji,jj,jk) - zwi(ji,jj,jk) * zws(ji,jj,jk-1) / zwt(ji,jj,jk-1)
226            END_3D
227            !
228         ENDIF 
229         !         
230         DO_2D( 0, 0, 0, 0 )
231            pt(ji,jj,1,jn,Kaa) = e3t(ji,jj,1,Kbb) * pt(ji,jj,1,jn,Kbb) + p2dt * e3t(ji,jj,1,Kmm) * pt(ji,jj,1,jn,Krhs)
232         END_2D
233         DO_3D( 0, 0, 0, 0, 2, jpkm1 )
234            zrhs = e3t(ji,jj,jk,Kbb) * pt(ji,jj,jk,jn,Kbb) + p2dt * e3t(ji,jj,jk,Kmm) * pt(ji,jj,jk,jn,Krhs)   ! zrhs=right hand side
235            pt(ji,jj,jk,jn,Kaa) = zrhs - zwi(ji,jj,jk) / zwt(ji,jj,jk-1) * pt(ji,jj,jk-1,jn,Kaa)
236         END_3D
237         !
238         DO_2D( 0, 0, 0, 0 )
239            pt(ji,jj,jpkm1,jn,Kaa) = pt(ji,jj,jpkm1,jn,Kaa) / zwt(ji,jj,jpkm1) * tmask(ji,jj,jpkm1)
240         END_2D
241         DO_3DS( 0, 0, 0, 0, jpk-2, 1, -1 )
242            pt(ji,jj,jk,jn,Kaa) = ( pt(ji,jj,jk,jn,Kaa) - zws(ji,jj,jk) * pt(ji,jj,jk+1,jn,Kaa) )   &
243               &             / zwt(ji,jj,jk) * tmask(ji,jj,jk)
244         END_3D
245         !                                            ! ================= !
246      END DO                                          !  end tracer loop  !
247      !                                               ! ================= !
248   END SUBROUTINE tra_zdf_imp
249
250   !!==============================================================================
251END MODULE trazdf
Note: See TracBrowser for help on using the repository browser.