[2030] | 1 | MODULE trcadv |
---|
| 2 | !!============================================================================== |
---|
| 3 | !! *** MODULE trcadv *** |
---|
| 4 | !! Ocean passive tracers: advection trend |
---|
| 5 | !!============================================================================== |
---|
| 6 | !! History : 2.0 ! 05-11 (G. Madec) Original code |
---|
| 7 | !! 3.0 ! 10-06 (C. Ethe) Adapted to passive tracers |
---|
| 8 | !!---------------------------------------------------------------------- |
---|
| 9 | #if defined key_top |
---|
| 10 | !!---------------------------------------------------------------------- |
---|
| 11 | !! 'key_top' TOP models |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
| 13 | !!---------------------------------------------------------------------- |
---|
| 14 | !! trc_adv : compute ocean tracer advection trend |
---|
| 15 | !! trc_adv_ctl : control the different options of advection scheme |
---|
| 16 | !!---------------------------------------------------------------------- |
---|
| 17 | USE oce_trc ! ocean dynamics and active tracers |
---|
| 18 | USE trc ! ocean passive tracers variables |
---|
| 19 | USE trcnam_trp ! passive tracers transport namelist variables |
---|
| 20 | USE traadv_cen2 ! 2nd order centered scheme (tra_adv_cen2 routine) |
---|
| 21 | USE traadv_tvd ! TVD scheme (tra_adv_tvd routine) |
---|
| 22 | USE traadv_muscl ! MUSCL scheme (tra_adv_muscl routine) |
---|
| 23 | USE traadv_muscl2 ! MUSCL2 scheme (tra_adv_muscl2 routine) |
---|
| 24 | USE traadv_ubs ! UBS scheme (tra_adv_ubs routine) |
---|
| 25 | USE traadv_qck ! QUICKEST scheme (tra_adv_qck routine) |
---|
| 26 | USE traadv_eiv ! eddy induced velocity (tra_adv_eiv routine) |
---|
| 27 | USE ldftra_oce ! lateral diffusion coefficient on tracers |
---|
| 28 | USE in_out_manager ! I/O manager |
---|
| 29 | USE prtctl_trc ! Print control |
---|
| 30 | |
---|
| 31 | IMPLICIT NONE |
---|
| 32 | PRIVATE |
---|
| 33 | |
---|
| 34 | PUBLIC trc_adv ! routine called by step module |
---|
[2082] | 35 | |
---|
[2030] | 36 | INTEGER :: nadv ! choice of the type of advection scheme |
---|
[2082] | 37 | REAL(wp), DIMENSION(jpk) :: r2dt ! vertical profile time-step, = 2 rdttra |
---|
| 38 | ! ! except at nit000 (=rdttra) if neuler=0 |
---|
[2030] | 39 | |
---|
| 40 | !! * Substitutions |
---|
| 41 | # include "domzgr_substitute.h90" |
---|
| 42 | # include "vectopt_loop_substitute.h90" |
---|
| 43 | !!---------------------------------------------------------------------- |
---|
[2287] | 44 | !! NEMO/TOP 3.3 , NEMO Consortium (2010) |
---|
[2281] | 45 | !! $Id$ |
---|
[2287] | 46 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[2030] | 47 | !!---------------------------------------------------------------------- |
---|
| 48 | |
---|
| 49 | CONTAINS |
---|
| 50 | |
---|
| 51 | SUBROUTINE trc_adv( kt ) |
---|
| 52 | !!---------------------------------------------------------------------- |
---|
| 53 | !! *** ROUTINE trc_adv *** |
---|
| 54 | !! |
---|
| 55 | !! ** Purpose : compute the ocean tracer advection trend. |
---|
| 56 | !! |
---|
| 57 | !! ** Method : - Update the tracer with the advection term following nadv |
---|
| 58 | !!---------------------------------------------------------------------- |
---|
| 59 | !! |
---|
| 60 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
| 61 | ! |
---|
| 62 | INTEGER :: jk |
---|
| 63 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zun, zvn, zwn ! effective velocity |
---|
| 64 | CHARACTER (len=22) :: charout |
---|
| 65 | !!---------------------------------------------------------------------- |
---|
| 66 | |
---|
[2148] | 67 | IF( kt == nit000 ) CALL trc_adv_ctl ! initialisation & control of options |
---|
[2030] | 68 | |
---|
[2192] | 69 | #if ! defined key_pisces |
---|
[2148] | 70 | IF( neuler == 0 .AND. kt == nit000 ) THEN ! at nit000 |
---|
[2082] | 71 | r2dt(:) = rdttra(:) * FLOAT(nn_dttrc) ! = rdtra (restarting with Euler time stepping) |
---|
[2148] | 72 | ELSEIF( kt <= nit000 + nn_dttrc ) THEN ! at nit000 or nit000+1 |
---|
[2082] | 73 | r2dt(:) = 2. * rdttra(:) * FLOAT(nn_dttrc) ! = 2 rdttra (leapfrog) |
---|
| 74 | ENDIF |
---|
[2192] | 75 | #else |
---|
| 76 | r2dt(:) = rdttra(:) * FLOAT(nn_dttrc) ! = rdtra (restarting with Euler time stepping) |
---|
| 77 | #endif |
---|
[2082] | 78 | |
---|
[2030] | 79 | ! ! effective transport |
---|
| 80 | DO jk = 1, jpkm1 |
---|
| 81 | ! ! eulerian transport only |
---|
| 82 | zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk) |
---|
| 83 | zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk) |
---|
| 84 | zwn(:,:,jk) = e1t(:,:) * e2t(:,:) * wn(:,:,jk) |
---|
| 85 | ! |
---|
| 86 | END DO |
---|
| 87 | zwn(:,:,jpk) = 0.e0 ! no transport trough the bottom |
---|
| 88 | |
---|
| 89 | ! ! add the eiv transport (if necessary) |
---|
| 90 | IF( lk_traldf_eiv ) CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRC' ) |
---|
| 91 | ! |
---|
[2034] | 92 | SELECT CASE ( nadv ) !== compute advection trend and add it to general trend ==! |
---|
[2082] | 93 | CASE ( 1 ) ; CALL tra_adv_cen2 ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra ) ! 2nd order centered |
---|
| 94 | CASE ( 2 ) ; CALL tra_adv_tvd ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) ! TVD |
---|
| 95 | CASE ( 3 ) ; CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, tra, jptra ) ! MUSCL |
---|
| 96 | CASE ( 4 ) ; CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) ! MUSCL2 |
---|
| 97 | CASE ( 5 ) ; CALL tra_adv_ubs ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) ! UBS |
---|
| 98 | CASE ( 6 ) ; CALL tra_adv_qck ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) ! QUICKEST |
---|
[2034] | 99 | ! |
---|
| 100 | CASE (-1 ) !== esopa: test all possibility with control print ==! |
---|
[2082] | 101 | CALL tra_adv_cen2 ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra ) |
---|
[2034] | 102 | WRITE(charout, FMT="('adv1')") ; CALL prt_ctl_trc_info(charout) |
---|
| 103 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
[2082] | 104 | CALL tra_adv_tvd ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) |
---|
[2034] | 105 | WRITE(charout, FMT="('adv2')") ; CALL prt_ctl_trc_info(charout) |
---|
| 106 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
[2082] | 107 | CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, tra, jptra ) |
---|
[2034] | 108 | WRITE(charout, FMT="('adv3')") ; CALL prt_ctl_trc_info(charout) |
---|
| 109 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
[2082] | 110 | CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) |
---|
[2034] | 111 | WRITE(charout, FMT="('adv4')") ; CALL prt_ctl_trc_info(charout) |
---|
| 112 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
[2082] | 113 | CALL tra_adv_ubs ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) |
---|
[2034] | 114 | WRITE(charout, FMT="('adv5')") ; CALL prt_ctl_trc_info(charout) |
---|
| 115 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
[2082] | 116 | CALL tra_adv_qck ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra ) |
---|
[2034] | 117 | WRITE(charout, FMT="('adv6')") ; CALL prt_ctl_trc_info(charout) |
---|
| 118 | CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd') |
---|
| 119 | ! |
---|
[2030] | 120 | END SELECT |
---|
| 121 | |
---|
| 122 | ! ! print mean trends (used for debugging) |
---|
| 123 | IF( ln_ctl ) THEN |
---|
| 124 | WRITE(charout, FMT="('adv ')") ; CALL prt_ctl_trc_info(charout) |
---|
| 125 | CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' ) |
---|
| 126 | END IF |
---|
| 127 | ! |
---|
| 128 | END SUBROUTINE trc_adv |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | SUBROUTINE trc_adv_ctl |
---|
| 132 | !!--------------------------------------------------------------------- |
---|
| 133 | !! *** ROUTINE trc_adv_ctl *** |
---|
| 134 | !! |
---|
| 135 | !! ** Purpose : Control the consistency between namelist options for |
---|
| 136 | !! passive tracer advection schemes and set nadv |
---|
| 137 | !!---------------------------------------------------------------------- |
---|
| 138 | INTEGER :: ioptio |
---|
| 139 | !!---------------------------------------------------------------------- |
---|
| 140 | |
---|
| 141 | ioptio = 0 ! Parameter control |
---|
| 142 | IF( ln_trcadv_cen2 ) ioptio = ioptio + 1 |
---|
| 143 | IF( ln_trcadv_tvd ) ioptio = ioptio + 1 |
---|
| 144 | IF( ln_trcadv_muscl ) ioptio = ioptio + 1 |
---|
| 145 | IF( ln_trcadv_muscl2 ) ioptio = ioptio + 1 |
---|
| 146 | IF( ln_trcadv_ubs ) ioptio = ioptio + 1 |
---|
| 147 | IF( ln_trcadv_qck ) ioptio = ioptio + 1 |
---|
| 148 | IF( lk_esopa ) ioptio = 1 |
---|
| 149 | |
---|
| 150 | IF( ioptio /= 1 ) CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' ) |
---|
| 151 | |
---|
| 152 | IF( n_cla == 1 .AND. .NOT. ln_trcadv_cen2 ) & |
---|
| 153 | & CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' ) |
---|
| 154 | |
---|
| 155 | ! ! Set nadv |
---|
| 156 | IF( ln_trcadv_cen2 ) nadv = 1 |
---|
| 157 | IF( ln_trcadv_tvd ) nadv = 2 |
---|
| 158 | IF( ln_trcadv_muscl ) nadv = 3 |
---|
| 159 | IF( ln_trcadv_muscl2 ) nadv = 4 |
---|
| 160 | IF( ln_trcadv_ubs ) nadv = 5 |
---|
| 161 | IF( ln_trcadv_qck ) nadv = 6 |
---|
| 162 | IF( lk_esopa ) nadv = -1 |
---|
| 163 | |
---|
| 164 | IF(lwp) THEN ! Print the choice |
---|
| 165 | WRITE(numout,*) |
---|
| 166 | IF( nadv == 1 ) WRITE(numout,*) ' 2nd order scheme is used' |
---|
| 167 | IF( nadv == 2 ) WRITE(numout,*) ' TVD scheme is used' |
---|
| 168 | IF( nadv == 3 ) WRITE(numout,*) ' MUSCL scheme is used' |
---|
| 169 | IF( nadv == 4 ) WRITE(numout,*) ' MUSCL2 scheme is used' |
---|
| 170 | IF( nadv == 5 ) WRITE(numout,*) ' UBS scheme is used' |
---|
| 171 | IF( nadv == 6 ) WRITE(numout,*) ' QUICKEST scheme is used' |
---|
| 172 | IF( nadv == -1 ) WRITE(numout,*) ' esopa test: use all advection scheme' |
---|
| 173 | ENDIF |
---|
| 174 | ! |
---|
| 175 | END SUBROUTINE trc_adv_ctl |
---|
| 176 | #else |
---|
| 177 | !!---------------------------------------------------------------------- |
---|
| 178 | !! Default option Empty module |
---|
| 179 | !!---------------------------------------------------------------------- |
---|
| 180 | CONTAINS |
---|
| 181 | SUBROUTINE trc_adv( kt ) |
---|
| 182 | INTEGER, INTENT(in) :: kt |
---|
| 183 | WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt |
---|
| 184 | END SUBROUTINE trc_adv |
---|
| 185 | #endif |
---|
| 186 | !!====================================================================== |
---|
| 187 | END MODULE trcadv |
---|