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