| 1 | MODULE traadv |
|---|
| 2 | !!============================================================================== |
|---|
| 3 | !! *** MODULE traadv *** |
|---|
| 4 | !! Ocean active tracers: advection trend |
|---|
| 5 | !!============================================================================== |
|---|
| 6 | !! History : 2.0 ! 2005-11 (G. Madec) Original code |
|---|
| 7 | !! 3.3 ! 2010-09 (C. Ethe, G. Madec) merge TRC-TRA + switch from velocity to transport |
|---|
| 8 | !! 3.6 ! 2011-06 (G. Madec) Addition of Mixed Layer Eddy parameterisation |
|---|
| 9 | !! 3.7 ! 2014-05 (G. Madec) Add 2nd/4th order cases for CEN and FCT schemes |
|---|
| 10 | !! - ! 2014-12 (G. Madec) suppression of cross land advection option |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| 12 | |
|---|
| 13 | !!---------------------------------------------------------------------- |
|---|
| 14 | !! tra_adv : compute ocean tracer advection trend |
|---|
| 15 | !! tra_adv_ctl : control the different options of advection scheme |
|---|
| 16 | !!---------------------------------------------------------------------- |
|---|
| 17 | USE oce ! ocean dynamics and active tracers |
|---|
| 18 | USE dom_oce ! ocean space and time domain |
|---|
| 19 | USE domvvl ! variable vertical scale factors |
|---|
| 20 | USE traadv_cen ! centered scheme (tra_adv_cen routine) |
|---|
| 21 | USE traadv_fct ! FCT scheme (tra_adv_fct routine) |
|---|
| 22 | USE traadv_mus ! MUSCL scheme (tra_adv_mus routine) |
|---|
| 23 | USE traadv_ubs ! UBS scheme (tra_adv_ubs routine) |
|---|
| 24 | USE traadv_qck ! QUICKEST scheme (tra_adv_qck routine) |
|---|
| 25 | USE traadv_mle ! ML eddy induced velocity (tra_adv_mle routine) |
|---|
| 26 | USE ldftra ! lateral diffusion: eddy diffusivity & EIV coeff. |
|---|
| 27 | USE ldfslp ! Lateral diffusion: slopes of neutral surfaces |
|---|
| 28 | ! |
|---|
| 29 | USE in_out_manager ! I/O manager |
|---|
| 30 | USE iom ! I/O module |
|---|
| 31 | USE prtctl ! Print control |
|---|
| 32 | USE lib_mpp ! MPP library |
|---|
| 33 | USE wrk_nemo ! Memory Allocation |
|---|
| 34 | USE timing ! Timing |
|---|
| 35 | |
|---|
| 36 | USE diaptr ! Poleward heat transport |
|---|
| 37 | |
|---|
| 38 | IMPLICIT NONE |
|---|
| 39 | PRIVATE |
|---|
| 40 | |
|---|
| 41 | PUBLIC tra_adv ! routine called by step module |
|---|
| 42 | PUBLIC tra_adv_init ! routine called by opa module |
|---|
| 43 | |
|---|
| 44 | ! !!* Namelist namtra_adv * |
|---|
| 45 | LOGICAL :: ln_traadv_cen ! centered scheme flag |
|---|
| 46 | INTEGER :: nn_cen_h, nn_cen_v ! =2/4 : horizontal and vertical choices of the order of CEN scheme |
|---|
| 47 | LOGICAL :: ln_traadv_fct ! FCT scheme flag |
|---|
| 48 | INTEGER :: nn_fct_h, nn_fct_v ! =2/4 : horizontal and vertical choices of the order of FCT scheme |
|---|
| 49 | INTEGER :: nn_fct_zts ! >=1 : 2nd order FCT with vertical sub-timestepping |
|---|
| 50 | LOGICAL :: ln_traadv_mus ! MUSCL scheme flag |
|---|
| 51 | LOGICAL :: ln_mus_ups ! use upstream scheme in vivcinity of river mouths |
|---|
| 52 | LOGICAL :: ln_traadv_ubs ! UBS scheme flag |
|---|
| 53 | INTEGER :: nn_ubs_v ! =2/4 : vertical choice of the order of UBS scheme |
|---|
| 54 | LOGICAL :: ln_traadv_qck ! QUICKEST scheme flag |
|---|
| 55 | |
|---|
| 56 | INTEGER :: nadv ! choice of the type of advection scheme |
|---|
| 57 | ! |
|---|
| 58 | ! ! associated indices: |
|---|
| 59 | INTEGER, PARAMETER :: np_NO_adv = 0 ! no T-S advection |
|---|
| 60 | INTEGER, PARAMETER :: np_CEN = 1 ! 2nd/4th order centered scheme |
|---|
| 61 | INTEGER, PARAMETER :: np_FCT = 2 ! 2nd/4th order Flux Corrected Transport scheme |
|---|
| 62 | INTEGER, PARAMETER :: np_FCT_zts = 3 ! 2nd order FCT scheme with vertical sub-timestepping |
|---|
| 63 | INTEGER, PARAMETER :: np_MUS = 4 ! MUSCL scheme |
|---|
| 64 | INTEGER, PARAMETER :: np_UBS = 5 ! 3rd order Upstream Biased Scheme |
|---|
| 65 | INTEGER, PARAMETER :: np_QCK = 6 ! QUICK scheme |
|---|
| 66 | |
|---|
| 67 | !! * Substitutions |
|---|
| 68 | # include "vectopt_loop_substitute.h90" |
|---|
| 69 | !!---------------------------------------------------------------------- |
|---|
| 70 | !! NEMO/OPA 3.7 , NEMO Consortium (2014) |
|---|
| 71 | !! $Id$ |
|---|
| 72 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 73 | !!---------------------------------------------------------------------- |
|---|
| 74 | CONTAINS |
|---|
| 75 | |
|---|
| 76 | SUBROUTINE tra_adv( kt ) |
|---|
| 77 | !!---------------------------------------------------------------------- |
|---|
| 78 | !! *** ROUTINE tra_adv *** |
|---|
| 79 | !! |
|---|
| 80 | !! ** Purpose : compute the ocean tracer advection trend. |
|---|
| 81 | !! |
|---|
| 82 | !! ** Method : - Update (ua,va) with the advection term following nadv |
|---|
| 83 | !!---------------------------------------------------------------------- |
|---|
| 84 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
|---|
| 85 | ! |
|---|
| 86 | INTEGER :: ji, jj, jk ! dummy loop index |
|---|
| 87 | REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn |
|---|
| 88 | !!---------------------------------------------------------------------- |
|---|
| 89 | ! |
|---|
| 90 | IF( nn_timing == 1 ) CALL timing_start('tra_adv') |
|---|
| 91 | ! |
|---|
| 92 | CALL wrk_alloc( jpi,jpj,jpk, zun, zvn, zwn ) |
|---|
| 93 | ! |
|---|
| 94 | ! ! set time step |
|---|
| 95 | IF( neuler == 0 .AND. kt == nit000 ) THEN ! at nit000 |
|---|
| 96 | r2dt = rdt ! = rdt (restarting with Euler time stepping) |
|---|
| 97 | ELSEIF( kt <= nit000 + 1) THEN ! at nit000 or nit000+1 |
|---|
| 98 | r2dt = 2._wp * rdt ! = 2 rdt (leapfrog) |
|---|
| 99 | ENDIF |
|---|
| 100 | ! |
|---|
| 101 | ! !== effective transport ==! |
|---|
| 102 | !$OMP PARALLEL DO schedule(static) private(jk) |
|---|
| 103 | DO jk = 1, jpkm1 |
|---|
| 104 | zun(:,:,jk) = e2u (:,:) * e3u_n(:,:,jk) * un(:,:,jk) ! eulerian transport only |
|---|
| 105 | zvn(:,:,jk) = e1v (:,:) * e3v_n(:,:,jk) * vn(:,:,jk) |
|---|
| 106 | zwn(:,:,jk) = e1e2t(:,:) * wn(:,:,jk) |
|---|
| 107 | END DO |
|---|
| 108 | ! |
|---|
| 109 | IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! add z-tilde and/or vvl corrections |
|---|
| 110 | !$OMP PARALLEL DO schedule(static) private(jk, jj, ji) |
|---|
| 111 | DO jk = 1, jpk |
|---|
| 112 | DO jj = 1, jpj |
|---|
| 113 | DO ji = 1, jpi |
|---|
| 114 | zun(ji,jj,jk) = zun(ji,jj,jk) + un_td(ji,jj,jk) |
|---|
| 115 | zvn(ji,jj,jk) = zvn(ji,jj,jk) + vn_td(ji,jj,jk) |
|---|
| 116 | END DO |
|---|
| 117 | END DO |
|---|
| 118 | END DO |
|---|
| 119 | ENDIF |
|---|
| 120 | ! |
|---|
| 121 | !$OMP PARALLEL DO schedule(static) private(jj, ji) |
|---|
| 122 | DO jj = 1, jpj |
|---|
| 123 | DO ji = 1, jpi |
|---|
| 124 | zun(ji,jj,jpk) = 0._wp ! no transport trough the bottom |
|---|
| 125 | zvn(ji,jj,jpk) = 0._wp |
|---|
| 126 | zwn(ji,jj,jpk) = 0._wp |
|---|
| 127 | END DO |
|---|
| 128 | END DO |
|---|
| 129 | ! |
|---|
| 130 | IF( ln_ldfeiv .AND. .NOT. ln_traldf_triad ) & |
|---|
| 131 | & CALL ldf_eiv_trp( kt, nit000, zun, zvn, zwn, 'TRA' ) ! add the eiv transport (if necessary) |
|---|
| 132 | ! |
|---|
| 133 | IF( ln_mle ) CALL tra_adv_mle( kt, nit000, zun, zvn, zwn, 'TRA' ) ! add the mle transport (if necessary) |
|---|
| 134 | ! |
|---|
| 135 | CALL iom_put( "uocetr_eff", zun ) ! output effective transport |
|---|
| 136 | CALL iom_put( "vocetr_eff", zvn ) |
|---|
| 137 | CALL iom_put( "wocetr_eff", zwn ) |
|---|
| 138 | ! |
|---|
| 139 | !!gm ??? |
|---|
| 140 | IF( ln_diaptr ) CALL dia_ptr( zvn ) ! diagnose the effective MSF |
|---|
| 141 | !!gm ??? |
|---|
| 142 | ! |
|---|
| 143 | SELECT CASE ( nadv ) !== compute advection trend and add it to general trend ==! |
|---|
| 144 | ! |
|---|
| 145 | CASE ( np_CEN ) ! Centered scheme : 2nd / 4th order |
|---|
| 146 | CALL tra_adv_cen ( kt, nit000, 'TRA', zun, zvn, zwn , tsn, tsa, jpts, nn_cen_h, nn_cen_v ) |
|---|
| 147 | CASE ( np_FCT ) ! FCT scheme : 2nd / 4th order |
|---|
| 148 | CALL tra_adv_fct ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts, nn_fct_h, nn_fct_v ) |
|---|
| 149 | CASE ( np_FCT_zts ) ! 2nd order FCT with vertical time-splitting |
|---|
| 150 | CALL tra_adv_fct_zts( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts , nn_fct_zts ) |
|---|
| 151 | CASE ( np_MUS ) ! MUSCL |
|---|
| 152 | CALL tra_adv_mus ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsa, jpts , ln_mus_ups ) |
|---|
| 153 | CASE ( np_UBS ) ! UBS |
|---|
| 154 | CALL tra_adv_ubs ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts , nn_ubs_v ) |
|---|
| 155 | CASE ( np_QCK ) ! QUICKEST |
|---|
| 156 | CALL tra_adv_qck ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts ) |
|---|
| 157 | ! |
|---|
| 158 | END SELECT |
|---|
| 159 | ! |
|---|
| 160 | ! ! print mean trends (used for debugging) |
|---|
| 161 | IF(ln_ctl) CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv - Ta: ', mask1=tmask, & |
|---|
| 162 | & tab3d_2=tsa(:,:,:,jp_sal), clinfo2= ' Sa: ', mask2=tmask, clinfo3='tra' ) |
|---|
| 163 | ! |
|---|
| 164 | IF( nn_timing == 1 ) CALL timing_stop( 'tra_adv' ) |
|---|
| 165 | ! |
|---|
| 166 | CALL wrk_dealloc( jpi,jpj,jpk, zun, zvn, zwn ) |
|---|
| 167 | ! |
|---|
| 168 | END SUBROUTINE tra_adv |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | SUBROUTINE tra_adv_init |
|---|
| 172 | !!--------------------------------------------------------------------- |
|---|
| 173 | !! *** ROUTINE tra_adv_init *** |
|---|
| 174 | !! |
|---|
| 175 | !! ** Purpose : Control the consistency between namelist options for |
|---|
| 176 | !! tracer advection schemes and set nadv |
|---|
| 177 | !!---------------------------------------------------------------------- |
|---|
| 178 | INTEGER :: ioptio, ios ! Local integers |
|---|
| 179 | ! |
|---|
| 180 | NAMELIST/namtra_adv/ ln_traadv_cen, nn_cen_h, nn_cen_v, & ! CEN |
|---|
| 181 | & ln_traadv_fct, nn_fct_h, nn_fct_v, nn_fct_zts, & ! FCT |
|---|
| 182 | & ln_traadv_mus, ln_mus_ups, & ! MUSCL |
|---|
| 183 | & ln_traadv_ubs, nn_ubs_v, & ! UBS |
|---|
| 184 | & ln_traadv_qck ! QCK |
|---|
| 185 | !!---------------------------------------------------------------------- |
|---|
| 186 | ! |
|---|
| 187 | ! !== Namelist ==! |
|---|
| 188 | REWIND( numnam_ref ) ! Namelist namtra_adv in reference namelist : Tracer advection scheme |
|---|
| 189 | READ ( numnam_ref, namtra_adv, IOSTAT = ios, ERR = 901) |
|---|
| 190 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in reference namelist', lwp ) |
|---|
| 191 | ! |
|---|
| 192 | REWIND( numnam_cfg ) ! Namelist namtra_adv in configuration namelist : Tracer advection scheme |
|---|
| 193 | READ ( numnam_cfg, namtra_adv, IOSTAT = ios, ERR = 902 ) |
|---|
| 194 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in configuration namelist', lwp ) |
|---|
| 195 | IF(lwm) WRITE( numond, namtra_adv ) |
|---|
| 196 | ! |
|---|
| 197 | IF(lwp) THEN ! Namelist print |
|---|
| 198 | WRITE(numout,*) |
|---|
| 199 | WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme' |
|---|
| 200 | WRITE(numout,*) '~~~~~~~~~~~' |
|---|
| 201 | WRITE(numout,*) ' Namelist namtra_adv : chose a advection scheme for tracers' |
|---|
| 202 | WRITE(numout,*) ' centered scheme ln_traadv_cen = ', ln_traadv_cen |
|---|
| 203 | WRITE(numout,*) ' horizontal 2nd/4th order nn_cen_h = ', nn_fct_h |
|---|
| 204 | WRITE(numout,*) ' vertical 2nd/4th order nn_cen_v = ', nn_fct_v |
|---|
| 205 | WRITE(numout,*) ' Flux Corrected Transport scheme ln_traadv_fct = ', ln_traadv_fct |
|---|
| 206 | WRITE(numout,*) ' horizontal 2nd/4th order nn_fct_h = ', nn_fct_h |
|---|
| 207 | WRITE(numout,*) ' vertical 2nd/4th order nn_fct_v = ', nn_fct_v |
|---|
| 208 | WRITE(numout,*) ' 2nd order + vertical sub-timestepping nn_fct_zts = ', nn_fct_zts |
|---|
| 209 | WRITE(numout,*) ' MUSCL scheme ln_traadv_mus = ', ln_traadv_mus |
|---|
| 210 | WRITE(numout,*) ' + upstream scheme near river mouths ln_mus_ups = ', ln_mus_ups |
|---|
| 211 | WRITE(numout,*) ' UBS scheme ln_traadv_ubs = ', ln_traadv_ubs |
|---|
| 212 | WRITE(numout,*) ' vertical 2nd/4th order nn_ubs_v = ', nn_ubs_v |
|---|
| 213 | WRITE(numout,*) ' QUICKEST scheme ln_traadv_qck = ', ln_traadv_qck |
|---|
| 214 | ENDIF |
|---|
| 215 | ! |
|---|
| 216 | ioptio = 0 !== Parameter control ==! |
|---|
| 217 | IF( ln_traadv_cen ) ioptio = ioptio + 1 |
|---|
| 218 | IF( ln_traadv_fct ) ioptio = ioptio + 1 |
|---|
| 219 | IF( ln_traadv_mus ) ioptio = ioptio + 1 |
|---|
| 220 | IF( ln_traadv_ubs ) ioptio = ioptio + 1 |
|---|
| 221 | IF( ln_traadv_qck ) ioptio = ioptio + 1 |
|---|
| 222 | ! |
|---|
| 223 | IF( ioptio == 0 ) THEN |
|---|
| 224 | nadv = np_NO_adv |
|---|
| 225 | CALL ctl_warn( 'tra_adv_init: You are running without tracer advection.' ) |
|---|
| 226 | ENDIF |
|---|
| 227 | IF( ioptio /= 1 ) CALL ctl_stop( 'tra_adv_init: Choose ONE advection scheme in namelist namtra_adv' ) |
|---|
| 228 | ! |
|---|
| 229 | IF( ln_traadv_cen .AND. ( nn_cen_h /= 2 .AND. nn_cen_h /= 4 ) & ! Centered |
|---|
| 230 | .AND. ( nn_cen_v /= 2 .AND. nn_cen_v /= 4 ) ) THEN |
|---|
| 231 | CALL ctl_stop( 'tra_adv_init: CEN scheme, choose 2nd or 4th order' ) |
|---|
| 232 | ENDIF |
|---|
| 233 | IF( ln_traadv_fct .AND. ( nn_fct_h /= 2 .AND. nn_fct_h /= 4 ) & ! FCT |
|---|
| 234 | .AND. ( nn_fct_v /= 2 .AND. nn_fct_v /= 4 ) ) THEN |
|---|
| 235 | CALL ctl_stop( 'tra_adv_init: FCT scheme, choose 2nd or 4th order' ) |
|---|
| 236 | ENDIF |
|---|
| 237 | IF( ln_traadv_fct .AND. nn_fct_zts > 0 ) THEN |
|---|
| 238 | IF( nn_fct_h == 4 ) THEN |
|---|
| 239 | nn_fct_h = 2 |
|---|
| 240 | CALL ctl_stop( 'tra_adv_init: force 2nd order FCT scheme, 4th order does not exist with sub-timestepping' ) |
|---|
| 241 | ENDIF |
|---|
| 242 | IF( .NOT.ln_linssh ) THEN |
|---|
| 243 | CALL ctl_stop( 'tra_adv_init: vertical sub-timestepping not allow in non-linear free surface' ) |
|---|
| 244 | ENDIF |
|---|
| 245 | IF( nn_fct_zts == 1 ) CALL ctl_warn( 'tra_adv_init: FCT with ONE sub-timestep = FCT without sub-timestep' ) |
|---|
| 246 | ENDIF |
|---|
| 247 | IF( ln_traadv_ubs .AND. ( nn_ubs_v /= 2 .AND. nn_ubs_v /= 4 ) ) THEN ! UBS |
|---|
| 248 | CALL ctl_stop( 'tra_adv_init: UBS scheme, choose 2nd or 4th order' ) |
|---|
| 249 | ENDIF |
|---|
| 250 | IF( ln_traadv_ubs .AND. nn_ubs_v == 4 ) THEN |
|---|
| 251 | CALL ctl_warn( 'tra_adv_init: UBS scheme, only 2nd FCT scheme available on the vertical. It will be used' ) |
|---|
| 252 | ENDIF |
|---|
| 253 | IF( ln_isfcav ) THEN ! ice-shelf cavities |
|---|
| 254 | IF( ln_traadv_cen .AND. nn_cen_v == 4 .OR. & ! NO 4th order with ISF |
|---|
| 255 | & ln_traadv_fct .AND. nn_fct_v == 4 ) CALL ctl_stop( 'tra_adv_init: 4th order COMPACT scheme not allowed with ISF' ) |
|---|
| 256 | ENDIF |
|---|
| 257 | ! |
|---|
| 258 | ! !== used advection scheme ==! |
|---|
| 259 | ! ! set nadv |
|---|
| 260 | IF( ln_traadv_cen ) nadv = np_CEN |
|---|
| 261 | IF( ln_traadv_fct ) nadv = np_FCT |
|---|
| 262 | IF( ln_traadv_fct .AND. nn_fct_zts > 0 ) nadv = np_FCT_zts |
|---|
| 263 | IF( ln_traadv_mus ) nadv = np_MUS |
|---|
| 264 | IF( ln_traadv_ubs ) nadv = np_UBS |
|---|
| 265 | IF( ln_traadv_qck ) nadv = np_QCK |
|---|
| 266 | ! |
|---|
| 267 | IF(lwp) THEN ! Print the choice |
|---|
| 268 | WRITE(numout,*) |
|---|
| 269 | SELECT CASE ( nadv ) |
|---|
| 270 | CASE( np_NO_adv ) ; WRITE(numout,*) ' NO T-S advection' |
|---|
| 271 | CASE( np_CEN ) ; WRITE(numout,*) ' CEN scheme is used. Horizontal order: ', nn_cen_h, & |
|---|
| 272 | & ' Vertical order: ', nn_cen_v |
|---|
| 273 | CASE( np_FCT ) ; WRITE(numout,*) ' FCT scheme is used. Horizontal order: ', nn_fct_h, & |
|---|
| 274 | & ' Vertical order: ', nn_fct_v |
|---|
| 275 | CASE( np_FCT_zts ) ; WRITE(numout,*) ' use 2nd order FCT with ', nn_fct_zts,'vertical sub-timestepping' |
|---|
| 276 | CASE( np_MUS ) ; WRITE(numout,*) ' MUSCL scheme is used' |
|---|
| 277 | CASE( np_UBS ) ; WRITE(numout,*) ' UBS scheme is used' |
|---|
| 278 | CASE( np_QCK ) ; WRITE(numout,*) ' QUICKEST scheme is used' |
|---|
| 279 | END SELECT |
|---|
| 280 | ENDIF |
|---|
| 281 | ! |
|---|
| 282 | CALL tra_adv_mle_init !== initialisation of the Mixed Layer Eddy parametrisation (MLE) ==! |
|---|
| 283 | ! |
|---|
| 284 | END SUBROUTINE tra_adv_init |
|---|
| 285 | |
|---|
| 286 | !!====================================================================== |
|---|
| 287 | END MODULE traadv |
|---|
