source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 8280

Last change on this file since 8280 was 8280, checked in by timgraham, 4 years ago

331: Merge of MEDUSA stable branch and HadGEM3 coupling branches into GO6 package branch.

File size: 12.0 KB
Line 
1MODULE 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 traadv_mle      ! ML eddy induced velocity  (tra_adv_mle    routine)
27   USE ldftra_oce      ! lateral diffusion coefficient on tracers
28   USE trd_oce
29   USE trdtra
30   USE prtctl_trc      ! Print control
31   !! USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   trc_adv          ! routine called by step module
37   PUBLIC   trc_adv_alloc    ! routine called by nemogcm module
38
39   INTEGER ::   nadv   ! choice of the type of advection scheme
40   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt  ! vertical profile time-step, = 2 rdttra
41   !                                                    ! except at nitrrc000 (=rdttra) if neuler=0
42
43   !! * Substitutions
44#  include "domzgr_substitute.h90"
45#  include "vectopt_loop_substitute.h90"
46   !!----------------------------------------------------------------------
47   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
48   !! $Id$
49   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
51CONTAINS
52
53   INTEGER FUNCTION trc_adv_alloc()
54      !!----------------------------------------------------------------------
55      !!                  ***  ROUTINE trc_adv_alloc  ***
56      !!----------------------------------------------------------------------
57
58      ALLOCATE( r2dt(jpk), STAT=trc_adv_alloc )
59
60      IF( trc_adv_alloc /= 0 ) CALL ctl_warn('trc_adv_alloc : failed to allocate array.')
61
62   END FUNCTION trc_adv_alloc
63
64
65   SUBROUTINE trc_adv( kt )
66      !!----------------------------------------------------------------------
67      !!                  ***  ROUTINE trc_adv  ***
68      !!
69      !! ** Purpose :   compute the ocean tracer advection trend.
70      !!
71      !! ** Method  : - Update the tracer with the advection term following nadv
72      !!----------------------------------------------------------------------
73      !!
74      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
75      !
76      INTEGER ::   jk, jn 
77      CHARACTER (len=22) ::   charout
78      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn  ! effective velocity
79      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   ztrtrd
80      !!----------------------------------------------------------------------
81      !
82      IF( nn_timing == 1 )  CALL timing_start('trc_adv')
83      !
84      CALL wrk_alloc( jpi, jpj, jpk, zun, zvn, zwn )
85      !
86
87      IF( kt == nittrc000 )   CALL trc_adv_ctl          ! initialisation & control of options
88
89      IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN     ! at nittrc000
90         r2dt(:) =  rdttrc(:)           ! = rdttrc (use or restarting with Euler time stepping)
91      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nittrc000 or nittrc000+1
92         r2dt(:) = 2. * rdttrc(:)       ! = 2 rdttrc (leapfrog)
93      ENDIF
94      !                                                   ! effective transport
95      DO jk = 1, jpkm1
96         !                                                ! eulerian transport only
97         zun(:,:,jk) = e2u  (:,:) * fse3u(:,:,jk) * un(:,:,jk)
98         zvn(:,:,jk) = e1v  (:,:) * fse3v(:,:,jk) * vn(:,:,jk)
99         zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk)
100         !
101      END DO
102      !
103      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
104         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
105         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
106      ENDIF
107      !
108      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
109      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
110      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
111      !
112      !! Jpalm -- 14-01-2016 -- restart and proc pb - try this...
113      !! DO jn = 1, jptra
114      !!   CALL lbc_lnk( trn(:,:,:,jn), 'T', 1. )
115      !!   CALL lbc_lnk( trb(:,:,:,jn), 'T', 1. )
116      !! END DO
117      !
118
119      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &  ! add the eiv transport (if necessary)
120         &              CALL tra_adv_eiv( kt, nittrc000, zun, zvn, zwn, 'TRC' )
121      !
122      IF( ln_mle    )   CALL tra_adv_mle( kt, nittrc000, zun, zvn, zwn, 'TRC' )    ! add the mle transport (if necessary)
123      !
124      IF( l_trdtrc )  THEN
125         CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrtrd )
126         ztrtrd(:,:,:,:)  = tra(:,:,:,:)
127      ENDIF
128      !
129      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
130      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
131      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
132      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra, ln_trcadv_msc_ups )   !  MUSCL
133      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
134      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
135      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
136      !
137      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
138         CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )         
139         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
140                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
141         CALL tra_adv_tvd   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
142         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
143                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
144         CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra, ln_trcadv_msc_ups  )         
145         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
146                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
147         CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
148         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
149                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
150         CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
151         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
152                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
153         CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
154         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
155                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
156         !
157      END SELECT
158      !
159      IF( l_trdtrc )   THEN                      ! save the advective trends for further diagnostics
160        DO jn = 1, jptra
161           ztrtrd(:,:,:,jn) = tra(:,:,:,jn) - ztrtrd(:,:,:,jn)
162           CALL trd_tra( kt, 'TRC', jn, jptra_totad, ztrtrd(:,:,:,jn) )
163        END DO
164        CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrtrd )
165      ENDIF
166
167      !                                              ! print mean trends (used for debugging)
168      IF( ln_ctl )   THEN
169         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
170                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
171      END IF
172      !
173      CALL wrk_dealloc( jpi, jpj, jpk, zun, zvn, zwn )
174      !
175      IF( nn_timing == 1 )  CALL timing_stop('trc_adv')
176      !
177   END SUBROUTINE trc_adv
178
179
180   SUBROUTINE trc_adv_ctl
181      !!---------------------------------------------------------------------
182      !!                  ***  ROUTINE trc_adv_ctl  ***
183      !!               
184      !! ** Purpose : Control the consistency between namelist options for
185      !!              passive tracer advection schemes and set nadv
186      !!----------------------------------------------------------------------
187      INTEGER ::   ioptio
188      !!----------------------------------------------------------------------
189
190      ioptio = 0                      ! Parameter control
191      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
192      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
193      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
194      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
195      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
196      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
197      IF( lk_esopa         )   ioptio =          1
198
199      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
200
201      !                              ! Set nadv
202      IF( ln_trcadv_cen2   )   nadv =  1
203      IF( ln_trcadv_tvd    )   nadv =  2
204      IF( ln_trcadv_muscl  )   nadv =  3
205      IF( ln_trcadv_muscl2 )   nadv =  4
206      IF( ln_trcadv_ubs    )   nadv =  5
207      IF( ln_trcadv_qck    )   nadv =  6
208      IF( lk_esopa         )   nadv = -1
209
210      IF(lwp) THEN                   ! Print the choice
211         WRITE(numout,*)
212         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
213         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
214         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
215         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
216         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
217         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
218         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
219      ENDIF
220      !
221   END SUBROUTINE trc_adv_ctl
222   
223#else
224   !!----------------------------------------------------------------------
225   !!   Default option                                         Empty module
226   !!----------------------------------------------------------------------
227CONTAINS
228   SUBROUTINE trc_adv( kt )
229      INTEGER, INTENT(in) :: kt
230      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
231   END SUBROUTINE trc_adv
232#endif
233
234  !!======================================================================
235END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.