[2026] | 1 | MODULE trdtra |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE trdtra *** |
---|
[3316] | 4 | !! Ocean diagnostics: ocean tracers trends pre-processing |
---|
[2026] | 5 | !!===================================================================== |
---|
[3316] | 6 | !! History : 3.3 ! 2010-06 (C. Ethe) creation for the TRA/TRC merge |
---|
| 7 | !! 3.5 ! 2012-02 (G. Madec) update the comments |
---|
[2026] | 8 | !!---------------------------------------------------------------------- |
---|
| 9 | #if defined key_trdtra || defined key_trdmld || defined key_trdmld_trc |
---|
| 10 | !!---------------------------------------------------------------------- |
---|
[3316] | 11 | !! trd_tra : pre-process the tracer trends and calll trd_mod(_trc) |
---|
| 12 | !! trd_tra_adv : transform a div(U.T) trend into a U.grad(T) trend |
---|
[2026] | 13 | !!---------------------------------------------------------------------- |
---|
[3317] | 14 | USE oce ! ocean dynamics and tracers variables |
---|
[3316] | 15 | USE dom_oce ! ocean domain |
---|
[3317] | 16 | USE zdf_oce ! ocean vertical physics |
---|
| 17 | USE zdfddm ! vertical physics: double diffusion |
---|
[3316] | 18 | USE trdmod_oce ! ocean active mixed layer tracers trends |
---|
| 19 | USE trdmod ! ocean active mixed layer tracers trends |
---|
| 20 | USE trdmod_trc ! ocean passive mixed layer tracers trends |
---|
[3317] | 21 | USE ldftra_oce ! ocean active tracers lateral physics |
---|
[3316] | 22 | USE in_out_manager ! I/O manager |
---|
| 23 | USE lib_mpp ! MPP library |
---|
| 24 | USE wrk_nemo ! Memory allocation |
---|
[2026] | 25 | |
---|
| 26 | IMPLICIT NONE |
---|
| 27 | PRIVATE |
---|
| 28 | |
---|
[3316] | 29 | PUBLIC trd_tra ! called by all tra_... modules |
---|
[2026] | 30 | |
---|
[3316] | 31 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: trdtx, trdty, trdt ! use to store the temperature trends |
---|
[2026] | 32 | |
---|
| 33 | !! * Substitutions |
---|
| 34 | # include "domzgr_substitute.h90" |
---|
[3317] | 35 | # include "zdfddm_substitute.h90" |
---|
[2026] | 36 | # include "vectopt_loop_substitute.h90" |
---|
| 37 | !!---------------------------------------------------------------------- |
---|
[3316] | 38 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[2281] | 39 | !! $Id$ |
---|
[2715] | 40 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[2026] | 41 | !!---------------------------------------------------------------------- |
---|
| 42 | CONTAINS |
---|
| 43 | |
---|
[2715] | 44 | INTEGER FUNCTION trd_tra_alloc() |
---|
[3317] | 45 | !!--------------------------------------------------------------------- |
---|
[2715] | 46 | !! *** FUNCTION trd_tra_alloc *** |
---|
[3317] | 47 | !!--------------------------------------------------------------------- |
---|
[2715] | 48 | ALLOCATE( trdtx(jpi,jpj,jpk) , trdty(jpi,jpj,jpk) , trdt(jpi,jpj,jpk) , STAT= trd_tra_alloc ) |
---|
| 49 | ! |
---|
| 50 | IF( lk_mpp ) CALL mpp_sum ( trd_tra_alloc ) |
---|
| 51 | IF( trd_tra_alloc /= 0 ) CALL ctl_warn('trd_tra_alloc: failed to allocate arrays') |
---|
| 52 | END FUNCTION trd_tra_alloc |
---|
| 53 | |
---|
| 54 | |
---|
[2026] | 55 | SUBROUTINE trd_tra( kt, ctype, ktra, ktrd, ptrd, pun, ptra ) |
---|
| 56 | !!--------------------------------------------------------------------- |
---|
| 57 | !! *** ROUTINE trd_tra *** |
---|
| 58 | !! |
---|
[3316] | 59 | !! ** Purpose : pre-process tracer trends |
---|
[2026] | 60 | !! |
---|
[3316] | 61 | !! ** Method : - mask the trend |
---|
| 62 | !! - advection (ptra present) converte the incoming flux (U.T) |
---|
| 63 | !! into trend (U.T => -U.grat(T)=div(U.T)-T.div(U)) through a |
---|
| 64 | !! call to trd_tra_adv |
---|
| 65 | !! - 'TRA' case : regroup T & S trends |
---|
| 66 | !! - send the trends to trd_mod(_trc) for further processing |
---|
[2026] | 67 | !!---------------------------------------------------------------------- |
---|
[3316] | 68 | INTEGER , INTENT(in) :: kt ! time step |
---|
| 69 | CHARACTER(len=3) , INTENT(in) :: ctype ! tracers trends type 'TRA'/'TRC' |
---|
| 70 | INTEGER , INTENT(in) :: ktra ! tracer index |
---|
| 71 | INTEGER , INTENT(in) :: ktrd ! tracer trend index |
---|
| 72 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in) :: ptrd ! tracer trend or flux |
---|
| 73 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in), OPTIONAL :: pun ! now velocity |
---|
| 74 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in), OPTIONAL :: ptra ! now tracer variable |
---|
[2715] | 75 | ! |
---|
[3317] | 76 | INTEGER :: jk ! loop indices |
---|
| 77 | REAL(wp), POINTER, DIMENSION(:,:,:) :: zwt, zws, ztrdt, ztrds ! 3D workspace |
---|
[2026] | 78 | !!---------------------------------------------------------------------- |
---|
[3316] | 79 | ! |
---|
[3294] | 80 | CALL wrk_alloc( jpi, jpj, jpk, ztrds ) |
---|
[3317] | 81 | ! |
---|
[3316] | 82 | IF( .NOT. ALLOCATED( trdtx ) ) THEN ! allocate trdtra arrays |
---|
[2715] | 83 | IF( trd_tra_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'trd_tra : unable to allocate arrays' ) |
---|
| 84 | ENDIF |
---|
[3317] | 85 | |
---|
[3316] | 86 | IF( ctype == 'TRA' .AND. ktra == jp_tem ) THEN !== Temperature trend ==! |
---|
| 87 | ! |
---|
| 88 | IF( PRESENT( ptra ) ) THEN ! advection: transform flux into trend |
---|
| 89 | SELECT CASE( ktrd ) |
---|
| 90 | CASE( jptra_trd_xad ) ; CALL trd_tra_adv( ptrd, pun, ptra, 'X', trdtx ) |
---|
| 91 | CASE( jptra_trd_yad ) ; CALL trd_tra_adv( ptrd, pun, ptra, 'Y', trdty ) |
---|
| 92 | CASE( jptra_trd_zad ) ; CALL trd_tra_adv( ptrd, pun, ptra, 'Z', trdt ) |
---|
[2026] | 93 | END SELECT |
---|
[3316] | 94 | ELSE ! other trends: |
---|
| 95 | trdt(:,:,:) = ptrd(:,:,:) * tmask(:,:,:) ! mask & store |
---|
| 96 | IF( ktrd == jptra_trd_bbc .OR. ktrd == jptra_trd_qsr ) THEN ! qsr, bbc: on temperature only |
---|
| 97 | ztrds(:,:,:) = 0._wp |
---|
| 98 | CALL trd_mod( trdt, ztrds, ktrd, ctype, kt ) ! send to trd_mod |
---|
| 99 | ENDIF |
---|
| 100 | ENDIF |
---|
| 101 | ! |
---|
| 102 | ENDIF |
---|
[2026] | 103 | |
---|
[3316] | 104 | IF( ctype == 'TRA' .AND. ktra == jp_sal ) THEN !== Salinity trends ==! |
---|
| 105 | ! |
---|
| 106 | IF( PRESENT( ptra ) ) THEN ! advection: transform the advective flux into a trend |
---|
| 107 | SELECT CASE( ktrd ) ! and send T & S trends to trd_mod |
---|
| 108 | CASE( jptra_trd_xad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'X' , ztrds ) |
---|
| 109 | CALL trd_mod ( trdtx, ztrds, ktrd, ctype, kt ) |
---|
| 110 | CASE( jptra_trd_yad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'Y' , ztrds ) |
---|
| 111 | ; CALL trd_mod ( trdty, ztrds, ktrd, ctype, kt ) |
---|
| 112 | CASE( jptra_trd_zad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'Z' , ztrds ) |
---|
| 113 | CALL trd_mod ( trdt , ztrds, ktrd, ctype, kt ) |
---|
[2026] | 114 | END SELECT |
---|
[3316] | 115 | ELSE ! other trends: mask and send T & S trends to trd_mod |
---|
| 116 | ztrds(:,:,:) = ptrd(:,:,:) * tmask(:,:,:) |
---|
[2026] | 117 | CALL trd_mod( trdt, ztrds, ktrd, ctype, kt ) |
---|
[3316] | 118 | ENDIF |
---|
| 119 | ! |
---|
[3317] | 120 | IF( ktrd == jptra_trd_zdfp ) THEN ! diagnose the "PURE" Kz trend (here: just before the swap) |
---|
| 121 | ! |
---|
| 122 | IF( ln_traldf_iso ) THEN ! iso-neutral diffusion only otherwise jptra_trd_zdf is "PURE" |
---|
| 123 | ! |
---|
| 124 | CALL wrk_alloc( jpi, jpj, jpk, zwt, zws, ztrdt ) |
---|
| 125 | ! |
---|
| 126 | zwt(:,:, 1 ) = 0._wp ; zws(:,:, 1 ) = 0._wp ! vertical diffusive fluxes |
---|
| 127 | zwt(:,:,jpk) = 0._wp ; zws(:,:,jpk) = 0._wp |
---|
| 128 | DO jk = 2, jpk |
---|
| 129 | zwt(:,:,jk) = avt(:,:,jk) * ( tsa(:,:,jk-1,jp_tem) - tsa(:,:,jk,jp_tem) ) / fse3w(:,:,jk) * tmask(:,:,jk) |
---|
| 130 | zws(:,:,jk) = fsavs(:,:,jk) * ( tsa(:,:,jk-1,jp_sal) - tsa(:,:,jk,jp_sal) ) / fse3w(:,:,jk) * tmask(:,:,jk) |
---|
| 131 | END DO |
---|
| 132 | ! |
---|
| 133 | ztrdt(:,:,jpk) = 0._wp ; ztrds(:,:,jpk) = 0._wp |
---|
| 134 | DO jk = 1, jpkm1 |
---|
| 135 | ztrdt(:,:,jk) = ( zwt(:,:,jk) - zwt(:,:,jk+1) ) / fse3t(:,:,jk) |
---|
| 136 | ztrds(:,:,jk) = ( zws(:,:,jk) - zws(:,:,jk+1) ) / fse3t(:,:,jk) |
---|
| 137 | END DO |
---|
| 138 | CALL trd_mod( ztrdt, ztrds, jptra_trd_zdfp, ctype, kt ) |
---|
| 139 | ! |
---|
| 140 | CALL wrk_dealloc( jpi, jpj, jpk, zwt, zws, ztrdt ) |
---|
| 141 | ! |
---|
| 142 | ENDIF |
---|
| 143 | ! |
---|
| 144 | ENDIF |
---|
[3316] | 145 | ENDIF |
---|
[2026] | 146 | |
---|
[3316] | 147 | IF( ctype == 'TRC' ) THEN !== passive tracer trend ==! |
---|
[2026] | 148 | ! |
---|
[3316] | 149 | IF( PRESENT( ptra ) ) THEN ! advection: transform flux into a trend |
---|
| 150 | SELECT CASE( ktrd ) |
---|
| 151 | CASE( jptra_trd_xad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'X', ztrds ) |
---|
| 152 | CASE( jptra_trd_yad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'Y', ztrds ) |
---|
| 153 | CASE( jptra_trd_zad ) ; CALL trd_tra_adv( ptrd , pun , ptra, 'Z', ztrds ) |
---|
[2026] | 154 | END SELECT |
---|
[3316] | 155 | ELSE ! other trends: mask |
---|
| 156 | ztrds(:,:,:) = ptrd(:,:,:) * tmask(:,:,:) |
---|
[2026] | 157 | END IF |
---|
[3316] | 158 | ! |
---|
| 159 | CALL trd_mod_trc( ztrds, ktra, ktrd, kt ) ! send trend to trd_mod_trc |
---|
[2026] | 160 | ! |
---|
| 161 | ENDIF |
---|
| 162 | ! |
---|
[3294] | 163 | CALL wrk_dealloc( jpi, jpj, jpk, ztrds ) |
---|
[2715] | 164 | ! |
---|
[2026] | 165 | END SUBROUTINE trd_tra |
---|
| 166 | |
---|
[2715] | 167 | |
---|
[2026] | 168 | SUBROUTINE trd_tra_adv( pf, pun, ptn, cdir, ptrd ) |
---|
| 169 | !!--------------------------------------------------------------------- |
---|
| 170 | !! *** ROUTINE trd_tra_adv *** |
---|
| 171 | !! |
---|
[3316] | 172 | !! ** Purpose : transformed a advective flux into a masked advective trends |
---|
| 173 | !! |
---|
| 174 | !! ** Method : use the following transformation: -div(U.T) = - U grad(T) + T.div(U) |
---|
| 175 | !! i-advective trends = -un. di-1[T] = -( di-1[fi] - tn di-1[un] ) |
---|
| 176 | !! j-advective trends = -un. di-1[T] = -( dj-1[fi] - tn dj-1[un] ) |
---|
| 177 | !! k-advective trends = -un. di+1[T] = -( dk+1[fi] - tn dk+1[un] ) |
---|
| 178 | !! where fi is the incoming advective flux. |
---|
[2026] | 179 | !!---------------------------------------------------------------------- |
---|
[3316] | 180 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pf ! advective flux in one direction |
---|
| 181 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pun ! now velocity in one direction |
---|
| 182 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: ptn ! now or before tracer |
---|
| 183 | CHARACTER(len=1) , INTENT(in ) :: cdir ! X/Y/Z direction |
---|
| 184 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT( out) :: ptrd ! advective trend in one direction |
---|
[2715] | 185 | ! |
---|
| 186 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
[3316] | 187 | INTEGER :: ii, ij, ik ! index shift as function of the direction |
---|
[2026] | 188 | !!---------------------------------------------------------------------- |
---|
[3316] | 189 | ! |
---|
| 190 | SELECT CASE( cdir ) ! shift depending on the direction |
---|
| 191 | CASE( 'X' ) ; ii = 1 ; ij = 0 ; ik = 0 ! i-trend |
---|
| 192 | CASE( 'Y' ) ; ii = 0 ; ij = 1 ; ik = 0 ! j-trend |
---|
| 193 | CASE( 'Z' ) ; ii = 0 ; ij = 0 ; ik =-1 ! k-trend |
---|
[2026] | 194 | END SELECT |
---|
| 195 | ! |
---|
[3316] | 196 | ! ! set to zero uncomputed values |
---|
| 197 | ptrd(jpi,:,:) = 0._wp ; ptrd(1,:,:) = 0._wp |
---|
| 198 | ptrd(:,jpj,:) = 0._wp ; ptrd(:,1,:) = 0._wp |
---|
| 199 | ptrd(:,:,jpk) = 0._wp |
---|
[2026] | 200 | ! |
---|
[3316] | 201 | DO jk = 1, jpkm1 ! advective trend |
---|
[2026] | 202 | DO jj = 2, jpjm1 |
---|
| 203 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[3316] | 204 | ptrd(ji,jj,jk) = - ( pf (ji,jj,jk) - pf (ji-ii,jj-ij,jk-ik) & |
---|
| 205 | & - ( pun(ji,jj,jk) - pun(ji-ii,jj-ij,jk-ik) ) * ptn(ji,jj,jk) ) & |
---|
| 206 | & / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) ) * tmask(ji,jj,jk) |
---|
[2026] | 207 | END DO |
---|
| 208 | END DO |
---|
| 209 | END DO |
---|
| 210 | ! |
---|
| 211 | END SUBROUTINE trd_tra_adv |
---|
| 212 | |
---|
[3316] | 213 | #else |
---|
[2026] | 214 | !!---------------------------------------------------------------------- |
---|
[2715] | 215 | !! Default case : Dummy module No trend diagnostics |
---|
[2026] | 216 | !!---------------------------------------------------------------------- |
---|
| 217 | USE par_oce ! ocean variables trends |
---|
| 218 | CONTAINS |
---|
| 219 | SUBROUTINE trd_tra( kt, ctype, ktra, ktrd, ptrd, pu, ptra ) |
---|
| 220 | !!---------------------------------------------------------------------- |
---|
[3316] | 221 | CHARACTER(len=3) , INTENT(in) :: ctype |
---|
| 222 | INTEGER , INTENT(in) :: kt, ktra, ktrd |
---|
| 223 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in) :: ptrd |
---|
| 224 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in), OPTIONAL :: pu, ptra ! Tracer variable |
---|
| 225 | WRITE(*,*) 'trd_tra: You should not have seen this print! error ?', & |
---|
| 226 | & ptrd(1,1,1), ptra(1,1,1), pu(1,1,1), ktrd, ktra, ctype, kt |
---|
[2026] | 227 | END SUBROUTINE trd_tra |
---|
[3316] | 228 | #endif |
---|
| 229 | |
---|
[2026] | 230 | !!====================================================================== |
---|
| 231 | END MODULE trdtra |
---|