source: branches/UKMO/r6232_tracer_advection/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 9295

Last change on this file since 9295 was 9295, checked in by jcastill, 3 years ago

Remove svn keywords

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