[458] | 1 | MODULE traadv |
---|
| 2 | !!============================================================================== |
---|
| 3 | !! *** MODULE traadv *** |
---|
| 4 | !! Ocean active tracers: advection trend |
---|
| 5 | !!============================================================================== |
---|
[2528] | 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 |
---|
[5836] | 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 |
---|
[7646] | 11 | !! 3.6 ! 2015-06 (E. Clementi) Addition of Stokes drift in case of wave coupling |
---|
[458] | 12 | !!---------------------------------------------------------------------- |
---|
[503] | 13 | |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
[5836] | 15 | !! tra_adv : compute ocean tracer advection trend |
---|
[9019] | 16 | !! tra_adv_init : control the different options of advection scheme |
---|
[458] | 17 | !!---------------------------------------------------------------------- |
---|
[5836] | 18 | USE oce ! ocean dynamics and active tracers |
---|
| 19 | USE dom_oce ! ocean space and time domain |
---|
| 20 | USE domvvl ! variable vertical scale factors |
---|
[9019] | 21 | USE sbcwave ! wave module |
---|
| 22 | USE sbc_oce ! surface boundary condition: ocean |
---|
[9531] | 23 | USE traadv_cen ! centered scheme (tra_adv_cen routine) |
---|
| 24 | USE traadv_fct ! FCT scheme (tra_adv_fct routine) |
---|
| 25 | USE traadv_mus ! MUSCL scheme (tra_adv_mus routine) |
---|
| 26 | USE traadv_ubs ! UBS scheme (tra_adv_ubs routine) |
---|
| 27 | USE traadv_qck ! QUICKEST scheme (tra_adv_qck routine) |
---|
| 28 | USE tramle ! Mixed Layer Eddy transport (tra_mle_trp routine) |
---|
| 29 | USE ldftra ! Eddy Induced transport (ldf_eiv_trp routine) |
---|
[5836] | 30 | USE ldfslp ! Lateral diffusion: slopes of neutral surfaces |
---|
[9019] | 31 | USE trd_oce ! trends: ocean variables |
---|
| 32 | USE trdtra ! trends manager: tracers |
---|
| 33 | USE diaptr ! Poleward heat transport |
---|
[5147] | 34 | ! |
---|
[5836] | 35 | USE in_out_manager ! I/O manager |
---|
| 36 | USE iom ! I/O module |
---|
| 37 | USE prtctl ! Print control |
---|
| 38 | USE lib_mpp ! MPP library |
---|
| 39 | USE timing ! Timing |
---|
| 40 | |
---|
[458] | 41 | IMPLICIT NONE |
---|
| 42 | PRIVATE |
---|
| 43 | |
---|
[9019] | 44 | PUBLIC tra_adv ! called by step.F90 |
---|
| 45 | PUBLIC tra_adv_init ! called by nemogcm.F90 |
---|
[2715] | 46 | |
---|
[5836] | 47 | ! !!* Namelist namtra_adv * |
---|
[9526] | 48 | LOGICAL :: ln_traadv_OFF ! no advection on T and S |
---|
[5836] | 49 | LOGICAL :: ln_traadv_cen ! centered scheme flag |
---|
| 50 | INTEGER :: nn_cen_h, nn_cen_v ! =2/4 : horizontal and vertical choices of the order of CEN scheme |
---|
| 51 | LOGICAL :: ln_traadv_fct ! FCT scheme flag |
---|
| 52 | INTEGER :: nn_fct_h, nn_fct_v ! =2/4 : horizontal and vertical choices of the order of FCT scheme |
---|
| 53 | LOGICAL :: ln_traadv_mus ! MUSCL scheme flag |
---|
| 54 | LOGICAL :: ln_mus_ups ! use upstream scheme in vivcinity of river mouths |
---|
| 55 | LOGICAL :: ln_traadv_ubs ! UBS scheme flag |
---|
| 56 | INTEGER :: nn_ubs_v ! =2/4 : vertical choice of the order of UBS scheme |
---|
| 57 | LOGICAL :: ln_traadv_qck ! QUICKEST scheme flag |
---|
[458] | 58 | |
---|
[9019] | 59 | INTEGER :: nadv ! choice of the type of advection scheme |
---|
| 60 | ! ! associated indices: |
---|
[5836] | 61 | INTEGER, PARAMETER :: np_NO_adv = 0 ! no T-S advection |
---|
| 62 | INTEGER, PARAMETER :: np_CEN = 1 ! 2nd/4th order centered scheme |
---|
| 63 | INTEGER, PARAMETER :: np_FCT = 2 ! 2nd/4th order Flux Corrected Transport scheme |
---|
[9019] | 64 | INTEGER, PARAMETER :: np_MUS = 3 ! MUSCL scheme |
---|
| 65 | INTEGER, PARAMETER :: np_UBS = 4 ! 3rd order Upstream Biased Scheme |
---|
| 66 | INTEGER, PARAMETER :: np_QCK = 5 ! QUICK scheme |
---|
[5836] | 67 | |
---|
[458] | 68 | !! * Substitutions |
---|
[503] | 69 | # include "vectopt_loop_substitute.h90" |
---|
[458] | 70 | !!---------------------------------------------------------------------- |
---|
[9598] | 71 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[2528] | 72 | !! $Id$ |
---|
[10068] | 73 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[458] | 74 | !!---------------------------------------------------------------------- |
---|
| 75 | CONTAINS |
---|
| 76 | |
---|
| 77 | SUBROUTINE tra_adv( kt ) |
---|
| 78 | !!---------------------------------------------------------------------- |
---|
| 79 | !! *** ROUTINE tra_adv *** |
---|
| 80 | !! |
---|
| 81 | !! ** Purpose : compute the ocean tracer advection trend. |
---|
| 82 | !! |
---|
[503] | 83 | !! ** Method : - Update (ua,va) with the advection term following nadv |
---|
[458] | 84 | !!---------------------------------------------------------------------- |
---|
[9019] | 85 | INTEGER, INTENT(in) :: kt ! ocean time-step index |
---|
[2528] | 86 | ! |
---|
[7753] | 87 | INTEGER :: jk ! dummy loop index |
---|
[9019] | 88 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zun, zvn, zwn ! 3D workspace |
---|
| 89 | REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: ztrdt, ztrds |
---|
[458] | 90 | !!---------------------------------------------------------------------- |
---|
[2715] | 91 | ! |
---|
[9019] | 92 | IF( ln_timing ) CALL timing_start('tra_adv') |
---|
[3294] | 93 | ! |
---|
[2528] | 94 | ! ! set time step |
---|
[9531] | 95 | IF( neuler == 0 .AND. kt == nit000 ) THEN ; r2dt = rdt ! at nit000 (Euler) |
---|
| 96 | ELSEIF( kt <= nit000 + 1 ) THEN ; r2dt = 2._wp * rdt ! at nit000 or nit000+1 (Leapfrog) |
---|
[458] | 97 | ENDIF |
---|
[2528] | 98 | ! |
---|
[5836] | 99 | ! !== effective transport ==! |
---|
[9019] | 100 | zun(:,:,jpk) = 0._wp |
---|
| 101 | zvn(:,:,jpk) = 0._wp |
---|
| 102 | zwn(:,:,jpk) = 0._wp |
---|
[7646] | 103 | IF( ln_wave .AND. ln_sdw ) THEN |
---|
| 104 | DO jk = 1, jpkm1 ! eulerian transport + Stokes Drift |
---|
[7753] | 105 | zun(:,:,jk) = e2u (:,:) * e3u_n(:,:,jk) * ( un(:,:,jk) + usd(:,:,jk) ) |
---|
| 106 | zvn(:,:,jk) = e1v (:,:) * e3v_n(:,:,jk) * ( vn(:,:,jk) + vsd(:,:,jk) ) |
---|
| 107 | zwn(:,:,jk) = e1e2t(:,:) * ( wn(:,:,jk) + wsd(:,:,jk) ) |
---|
[7646] | 108 | END DO |
---|
| 109 | ELSE |
---|
| 110 | DO jk = 1, jpkm1 |
---|
[7753] | 111 | zun(:,:,jk) = e2u (:,:) * e3u_n(:,:,jk) * un(:,:,jk) ! eulerian transport only |
---|
| 112 | zvn(:,:,jk) = e1v (:,:) * e3v_n(:,:,jk) * vn(:,:,jk) |
---|
| 113 | zwn(:,:,jk) = e1e2t(:,:) * wn(:,:,jk) |
---|
[7646] | 114 | END DO |
---|
| 115 | ENDIF |
---|
[4292] | 116 | ! |
---|
[5836] | 117 | IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! add z-tilde and/or vvl corrections |
---|
[7753] | 118 | zun(:,:,:) = zun(:,:,:) + un_td(:,:,:) |
---|
| 119 | zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:) |
---|
[4292] | 120 | ENDIF |
---|
| 121 | ! |
---|
[7753] | 122 | zun(:,:,jpk) = 0._wp ! no transport trough the bottom |
---|
| 123 | zvn(:,:,jpk) = 0._wp |
---|
| 124 | zwn(:,:,jpk) = 0._wp |
---|
[2528] | 125 | ! |
---|
[5836] | 126 | IF( ln_ldfeiv .AND. .NOT. ln_traldf_triad ) & |
---|
| 127 | & CALL ldf_eiv_trp( kt, nit000, zun, zvn, zwn, 'TRA' ) ! add the eiv transport (if necessary) |
---|
[2528] | 128 | ! |
---|
[9531] | 129 | IF( ln_mle ) CALL tra_mle_trp( kt, nit000, zun, zvn, zwn, 'TRA' ) ! add the mle transport (if necessary) |
---|
[5147] | 130 | ! |
---|
[5836] | 131 | CALL iom_put( "uocetr_eff", zun ) ! output effective transport |
---|
[2561] | 132 | CALL iom_put( "vocetr_eff", zvn ) |
---|
| 133 | CALL iom_put( "wocetr_eff", zwn ) |
---|
[5147] | 134 | ! |
---|
[5836] | 135 | !!gm ??? |
---|
| 136 | IF( ln_diaptr ) CALL dia_ptr( zvn ) ! diagnose the effective MSF |
---|
| 137 | !!gm ??? |
---|
[5147] | 138 | ! |
---|
[7646] | 139 | IF( l_trdtra ) THEN !* Save ta and sa trends |
---|
[9019] | 140 | ALLOCATE( ztrdt(jpi,jpj,jpk), ztrds(jpi,jpj,jpk) ) |
---|
[7753] | 141 | ztrdt(:,:,:) = tsa(:,:,:,jp_tem) |
---|
| 142 | ztrds(:,:,:) = tsa(:,:,:,jp_sal) |
---|
[7646] | 143 | ENDIF |
---|
| 144 | ! |
---|
[5836] | 145 | SELECT CASE ( nadv ) !== compute advection trend and add it to general trend ==! |
---|
[503] | 146 | ! |
---|
[9019] | 147 | CASE ( np_CEN ) ! Centered scheme : 2nd / 4th order |
---|
[5836] | 148 | CALL tra_adv_cen ( kt, nit000, 'TRA', zun, zvn, zwn , tsn, tsa, jpts, nn_cen_h, nn_cen_v ) |
---|
[9019] | 149 | CASE ( np_FCT ) ! FCT scheme : 2nd / 4th order |
---|
[6140] | 150 | CALL tra_adv_fct ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts, nn_fct_h, nn_fct_v ) |
---|
[9019] | 151 | CASE ( np_MUS ) ! MUSCL |
---|
[6140] | 152 | CALL tra_adv_mus ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsa, jpts , ln_mus_ups ) |
---|
[9019] | 153 | CASE ( np_UBS ) ! UBS |
---|
[6140] | 154 | CALL tra_adv_ubs ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts , nn_ubs_v ) |
---|
[9019] | 155 | CASE ( np_QCK ) ! QUICKEST |
---|
[6140] | 156 | CALL tra_adv_qck ( kt, nit000, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts ) |
---|
[5836] | 157 | ! |
---|
[458] | 158 | END SELECT |
---|
[2528] | 159 | ! |
---|
[7646] | 160 | IF( l_trdtra ) THEN ! save the advective trends for further diagnostics |
---|
| 161 | DO jk = 1, jpkm1 |
---|
[7753] | 162 | ztrdt(:,:,jk) = tsa(:,:,jk,jp_tem) - ztrdt(:,:,jk) |
---|
| 163 | ztrds(:,:,jk) = tsa(:,:,jk,jp_sal) - ztrds(:,:,jk) |
---|
[7646] | 164 | END DO |
---|
| 165 | CALL trd_tra( kt, 'TRA', jp_tem, jptra_totad, ztrdt ) |
---|
| 166 | CALL trd_tra( kt, 'TRA', jp_sal, jptra_totad, ztrds ) |
---|
[9019] | 167 | DEALLOCATE( ztrdt, ztrds ) |
---|
[7646] | 168 | ENDIF |
---|
| 169 | ! ! print mean trends (used for debugging) |
---|
[2528] | 170 | IF(ln_ctl) CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv - Ta: ', mask1=tmask, & |
---|
| 171 | & tab3d_2=tsa(:,:,:,jp_sal), clinfo2= ' Sa: ', mask2=tmask, clinfo3='tra' ) |
---|
[503] | 172 | ! |
---|
[9019] | 173 | IF( ln_timing ) CALL timing_stop( 'tra_adv' ) |
---|
[2715] | 174 | ! |
---|
[458] | 175 | END SUBROUTINE tra_adv |
---|
| 176 | |
---|
| 177 | |
---|
[2528] | 178 | SUBROUTINE tra_adv_init |
---|
[458] | 179 | !!--------------------------------------------------------------------- |
---|
[2528] | 180 | !! *** ROUTINE tra_adv_init *** |
---|
[458] | 181 | !! |
---|
[503] | 182 | !! ** Purpose : Control the consistency between namelist options for |
---|
| 183 | !! tracer advection schemes and set nadv |
---|
[458] | 184 | !!---------------------------------------------------------------------- |
---|
[5836] | 185 | INTEGER :: ioptio, ios ! Local integers |
---|
| 186 | ! |
---|
[9526] | 187 | NAMELIST/namtra_adv/ ln_traadv_OFF, & ! No advection |
---|
[9019] | 188 | & ln_traadv_cen , nn_cen_h, nn_cen_v, & ! CEN |
---|
| 189 | & ln_traadv_fct , nn_fct_h, nn_fct_v, & ! FCT |
---|
| 190 | & ln_traadv_mus , ln_mus_ups, & ! MUSCL |
---|
| 191 | & ln_traadv_ubs , nn_ubs_v, & ! UBS |
---|
| 192 | & ln_traadv_qck ! QCK |
---|
[458] | 193 | !!---------------------------------------------------------------------- |
---|
[5836] | 194 | ! |
---|
| 195 | ! !== Namelist ==! |
---|
| 196 | REWIND( numnam_ref ) ! Namelist namtra_adv in reference namelist : Tracer advection scheme |
---|
[4147] | 197 | READ ( numnam_ref, namtra_adv, IOSTAT = ios, ERR = 901) |
---|
[11536] | 198 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in reference namelist' ) |
---|
[5836] | 199 | ! |
---|
| 200 | REWIND( numnam_cfg ) ! Namelist namtra_adv in configuration namelist : Tracer advection scheme |
---|
[4147] | 201 | READ ( numnam_cfg, namtra_adv, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 202 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtra_adv in configuration namelist' ) |
---|
[6140] | 203 | IF(lwm) WRITE( numond, namtra_adv ) |
---|
| 204 | ! |
---|
[5836] | 205 | IF(lwp) THEN ! Namelist print |
---|
[458] | 206 | WRITE(numout,*) |
---|
[2528] | 207 | WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme' |
---|
[9019] | 208 | WRITE(numout,*) '~~~~~~~~~~~~' |
---|
[1601] | 209 | WRITE(numout,*) ' Namelist namtra_adv : chose a advection scheme for tracers' |
---|
[9526] | 210 | WRITE(numout,*) ' No advection on T & S ln_traadv_OFF = ', ln_traadv_OFF |
---|
[5836] | 211 | WRITE(numout,*) ' centered scheme ln_traadv_cen = ', ln_traadv_cen |
---|
| 212 | WRITE(numout,*) ' horizontal 2nd/4th order nn_cen_h = ', nn_fct_h |
---|
| 213 | WRITE(numout,*) ' vertical 2nd/4th order nn_cen_v = ', nn_fct_v |
---|
| 214 | WRITE(numout,*) ' Flux Corrected Transport scheme ln_traadv_fct = ', ln_traadv_fct |
---|
| 215 | WRITE(numout,*) ' horizontal 2nd/4th order nn_fct_h = ', nn_fct_h |
---|
| 216 | WRITE(numout,*) ' vertical 2nd/4th order nn_fct_v = ', nn_fct_v |
---|
| 217 | WRITE(numout,*) ' MUSCL scheme ln_traadv_mus = ', ln_traadv_mus |
---|
| 218 | WRITE(numout,*) ' + upstream scheme near river mouths ln_mus_ups = ', ln_mus_ups |
---|
| 219 | WRITE(numout,*) ' UBS scheme ln_traadv_ubs = ', ln_traadv_ubs |
---|
| 220 | WRITE(numout,*) ' vertical 2nd/4th order nn_ubs_v = ', nn_ubs_v |
---|
| 221 | WRITE(numout,*) ' QUICKEST scheme ln_traadv_qck = ', ln_traadv_qck |
---|
[2528] | 222 | ENDIF |
---|
[6140] | 223 | ! |
---|
[9019] | 224 | ! !== Parameter control & set nadv ==! |
---|
| 225 | ioptio = 0 |
---|
[9526] | 226 | IF( ln_traadv_OFF ) THEN ; ioptio = ioptio + 1 ; nadv = np_NO_adv ; ENDIF |
---|
| 227 | IF( ln_traadv_cen ) THEN ; ioptio = ioptio + 1 ; nadv = np_CEN ; ENDIF |
---|
| 228 | IF( ln_traadv_fct ) THEN ; ioptio = ioptio + 1 ; nadv = np_FCT ; ENDIF |
---|
| 229 | IF( ln_traadv_mus ) THEN ; ioptio = ioptio + 1 ; nadv = np_MUS ; ENDIF |
---|
| 230 | IF( ln_traadv_ubs ) THEN ; ioptio = ioptio + 1 ; nadv = np_UBS ; ENDIF |
---|
| 231 | IF( ln_traadv_qck ) THEN ; ioptio = ioptio + 1 ; nadv = np_QCK ; ENDIF |
---|
[5836] | 232 | ! |
---|
[9019] | 233 | IF( ioptio /= 1 ) CALL ctl_stop( 'tra_adv_init: Choose ONE advection option in namelist namtra_adv' ) |
---|
[5836] | 234 | ! |
---|
| 235 | IF( ln_traadv_cen .AND. ( nn_cen_h /= 2 .AND. nn_cen_h /= 4 ) & ! Centered |
---|
| 236 | .AND. ( nn_cen_v /= 2 .AND. nn_cen_v /= 4 ) ) THEN |
---|
| 237 | CALL ctl_stop( 'tra_adv_init: CEN scheme, choose 2nd or 4th order' ) |
---|
| 238 | ENDIF |
---|
| 239 | IF( ln_traadv_fct .AND. ( nn_fct_h /= 2 .AND. nn_fct_h /= 4 ) & ! FCT |
---|
| 240 | .AND. ( nn_fct_v /= 2 .AND. nn_fct_v /= 4 ) ) THEN |
---|
| 241 | CALL ctl_stop( 'tra_adv_init: FCT scheme, choose 2nd or 4th order' ) |
---|
| 242 | ENDIF |
---|
| 243 | IF( ln_traadv_ubs .AND. ( nn_ubs_v /= 2 .AND. nn_ubs_v /= 4 ) ) THEN ! UBS |
---|
| 244 | CALL ctl_stop( 'tra_adv_init: UBS scheme, choose 2nd or 4th order' ) |
---|
| 245 | ENDIF |
---|
| 246 | IF( ln_traadv_ubs .AND. nn_ubs_v == 4 ) THEN |
---|
| 247 | CALL ctl_warn( 'tra_adv_init: UBS scheme, only 2nd FCT scheme available on the vertical. It will be used' ) |
---|
| 248 | ENDIF |
---|
| 249 | IF( ln_isfcav ) THEN ! ice-shelf cavities |
---|
[6140] | 250 | IF( ln_traadv_cen .AND. nn_cen_v == 4 .OR. & ! NO 4th order with ISF |
---|
| 251 | & ln_traadv_fct .AND. nn_fct_v == 4 ) CALL ctl_stop( 'tra_adv_init: 4th order COMPACT scheme not allowed with ISF' ) |
---|
[5836] | 252 | ENDIF |
---|
| 253 | ! |
---|
[9019] | 254 | ! !== Print the choice ==! |
---|
| 255 | IF(lwp) THEN |
---|
[503] | 256 | WRITE(numout,*) |
---|
[6140] | 257 | SELECT CASE ( nadv ) |
---|
[9190] | 258 | CASE( np_NO_adv ) ; WRITE(numout,*) ' ==>>> NO T-S advection' |
---|
| 259 | CASE( np_CEN ) ; WRITE(numout,*) ' ==>>> CEN scheme is used. Horizontal order: ', nn_cen_h, & |
---|
| 260 | & ' Vertical order: ', nn_cen_v |
---|
| 261 | CASE( np_FCT ) ; WRITE(numout,*) ' ==>>> FCT scheme is used. Horizontal order: ', nn_fct_h, & |
---|
| 262 | & ' Vertical order: ', nn_fct_v |
---|
| 263 | CASE( np_MUS ) ; WRITE(numout,*) ' ==>>> MUSCL scheme is used' |
---|
| 264 | CASE( np_UBS ) ; WRITE(numout,*) ' ==>>> UBS scheme is used' |
---|
| 265 | CASE( np_QCK ) ; WRITE(numout,*) ' ==>>> QUICKEST scheme is used' |
---|
[6140] | 266 | END SELECT |
---|
[458] | 267 | ENDIF |
---|
[503] | 268 | ! |
---|
[9531] | 269 | CALL tra_mle_init !== initialisation of the Mixed Layer Eddy parametrisation (MLE) ==! |
---|
[4245] | 270 | ! |
---|
[2528] | 271 | END SUBROUTINE tra_adv_init |
---|
[458] | 272 | |
---|
| 273 | !!====================================================================== |
---|
| 274 | END MODULE traadv |
---|