New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
trcadv.F90 in branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 7910

Last change on this file since 7910 was 7910, checked in by timgraham, 7 years ago

All wrk_alloc removed
  • Property svn:keywords set to Id
File size: 14.8 KB
Line 
1MODULE trcadv
2   !!==============================================================================
3   !!                       ***  MODULE  trcadv  ***
4   !! Ocean passive tracers:  advection trend
5   !!==============================================================================
6   !! History :  2.0  !  2005-11  (G. Madec)  Original code
7   !!            3.0  !  2010-06  (C. Ethe)   Adapted to passive tracers
8   !!            3.7  !  2014-05  (G. Madec, C. Ethe)  Add 2nd/4th order cases for CEN and FCT schemes
9   !!----------------------------------------------------------------------
10#if defined key_top
11   !!----------------------------------------------------------------------
12   !!   'key_top'                                                TOP models
13   !!----------------------------------------------------------------------
14   !!   trc_adv       : compute ocean tracer advection trend
15   !!   trc_adv_ini   : 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 traadv_cen     ! centered scheme           (tra_adv_cen  routine)
20   USE traadv_fct     ! FCT      scheme           (tra_adv_fct  routine)
21   USE traadv_mus     ! MUSCL    scheme           (tra_adv_mus  routine)
22   USE traadv_ubs     ! UBS      scheme           (tra_adv_ubs  routine)
23   USE traadv_qck     ! QUICKEST scheme           (tra_adv_qck  routine)
24   USE traadv_mle     ! ML eddy induced velocity  (tra_adv_mle  routine)
25   USE ldftra         ! lateral diffusion coefficient on tracers
26   USE ldfslp         ! Lateral diffusion: slopes of neutral surfaces
27   !
28   USE prtctl_trc     ! Print control
29
30   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC   trc_adv       
34   PUBLIC   trc_adv_ini 
35
36   !                            !!* Namelist namtrc_adv *
37   LOGICAL ::   ln_trcadv_cen    ! centered scheme flag
38   INTEGER ::      nn_cen_h, nn_cen_v   ! =2/4 : horizontal and vertical choices of the order of CEN scheme
39   LOGICAL ::   ln_trcadv_fct    ! FCT scheme flag
40   INTEGER ::      nn_fct_h, nn_fct_v   ! =2/4 : horizontal and vertical choices of the order of FCT scheme
41   INTEGER ::      nn_fct_zts           ! >=1 : 2nd order FCT with vertical sub-timestepping
42   LOGICAL ::   ln_trcadv_mus    ! MUSCL scheme flag
43   LOGICAL ::      ln_mus_ups           ! use upstream scheme in vivcinity of river mouths
44   LOGICAL ::   ln_trcadv_ubs    ! UBS scheme flag
45   INTEGER ::      nn_ubs_v             ! =2/4 : vertical choice of the order of UBS scheme
46   LOGICAL ::   ln_trcadv_qck    ! QUICKEST scheme flag
47
48   !                                        ! choices of advection scheme:
49   INTEGER, PARAMETER ::   np_NO_adv  = 0   ! no T-S advection
50   INTEGER, PARAMETER ::   np_CEN     = 1   ! 2nd/4th order centered scheme
51   INTEGER, PARAMETER ::   np_FCT     = 2   ! 2nd/4th order Flux Corrected Transport scheme
52   INTEGER, PARAMETER ::   np_FCT_zts = 3   ! 2nd order FCT scheme with vertical sub-timestepping
53   INTEGER, PARAMETER ::   np_MUS     = 4   ! MUSCL scheme
54   INTEGER, PARAMETER ::   np_UBS     = 5   ! 3rd order Upstream Biased Scheme
55   INTEGER, PARAMETER ::   np_QCK     = 6   ! QUICK scheme
56
57   INTEGER ::              nadv             ! chosen advection scheme
58   !
59   !! * Substitutions
60#  include "vectopt_loop_substitute.h90"
61   !!----------------------------------------------------------------------
62   !! NEMO/TOP 3.7 , NEMO Consortium (2015)
63   !! $Id$
64   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
65   !!----------------------------------------------------------------------
66CONTAINS
67
68   SUBROUTINE trc_adv( kt )
69      !!----------------------------------------------------------------------
70      !!                  ***  ROUTINE trc_adv  ***
71      !!
72      !! ** Purpose :   compute the ocean tracer advection trend.
73      !!
74      !! ** Method  : - Update the tracer with the advection term following nadv
75      !!----------------------------------------------------------------------
76      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
77      !
78      INTEGER ::   jk   ! dummy loop index
79      CHARACTER (len=22) ::   charout
80      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zun, zvn, zwn  ! effective velocity
81      !!----------------------------------------------------------------------
82      !
83      IF( nn_timing == 1 )   CALL timing_start('trc_adv')
84      !
85      !                                               !==  effective transport  ==!
86      IF( l_offline ) THEN
87         zun(:,:,:) = un(:,:,:)     ! effective transport already in un/vn/wn
88         zvn(:,:,:) = vn(:,:,:)
89         zwn(:,:,:) = wn(:,:,:)
90      ELSE
91         !       
92         DO jk = 1, jpkm1
93            zun(:,:,jk) = e2u  (:,:) * e3u_n(:,:,jk) * un(:,:,jk)                   ! eulerian transport
94            zvn(:,:,jk) = e1v  (:,:) * e3v_n(:,:,jk) * vn(:,:,jk)
95            zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk)
96         END DO
97         !
98         IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN                                 ! add z-tilde and/or vvl corrections
99            zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
100            zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
101         ENDIF
102         !
103         IF( ln_ldfeiv .AND. .NOT. ln_traldf_triad )   & 
104            &              CALL ldf_eiv_trp( kt, nittrc000, zun, zvn, zwn, 'TRC' )  ! add the eiv transport
105         !
106         IF( ln_mle    )   CALL tra_adv_mle( kt, nittrc000, zun, zvn, zwn, 'TRC' )  ! add the mle transport
107         !
108         zun(:,:,jpk) = 0._wp                                                       ! no transport trough the bottom
109         zvn(:,:,jpk) = 0._wp
110         zwn(:,:,jpk) = 0._wp
111         !
112      ENDIF
113      !
114      SELECT CASE ( nadv )                      !==  compute advection trend and add it to general trend  ==!
115      !
116      CASE ( np_CEN )                                    ! Centered : 2nd / 4th order
117         CALL tra_adv_cen    ( kt, nittrc000,'TRC',       zun, zvn, zwn     , trn, tra, jptra, nn_cen_h, nn_cen_v )
118      CASE ( np_FCT )                                    ! FCT      : 2nd / 4th order
119         CALL tra_adv_fct    ( kt, nittrc000,'TRC', r2dttrc, zun, zvn, zwn, trb, trn, tra, jptra, nn_fct_h, nn_fct_v )
120      CASE ( np_FCT_zts )                                ! 2nd order FCT with vertical time-splitting
121         CALL tra_adv_fct_zts( kt, nittrc000,'TRC', r2dttrc, zun, zvn, zwn, trb, trn, tra, jptra        , nn_fct_zts )
122      CASE ( np_MUS )                                    ! MUSCL
123         CALL tra_adv_mus    ( kt, nittrc000,'TRC', r2dttrc, zun, zvn, zwn, trb,      tra, jptra        , ln_mus_ups ) 
124      CASE ( np_UBS )                                    ! UBS
125         CALL tra_adv_ubs    ( kt, nittrc000,'TRC', r2dttrc, zun, zvn, zwn, trb, trn, tra, jptra        , nn_ubs_v   )
126      CASE ( np_QCK )                                    ! QUICKEST
127         CALL tra_adv_qck    ( kt, nittrc000,'TRC', r2dttrc, zun, zvn, zwn, trb, trn, tra, jptra                     )
128      !
129      END SELECT
130      !                 
131      IF( ln_ctl )   THEN                             !== print mean trends (used for debugging)
132         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
133                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
134      END IF
135      !
136      !
137      IF( nn_timing == 1 )  CALL timing_stop('trc_adv')
138      !
139   END SUBROUTINE trc_adv
140
141
142   SUBROUTINE trc_adv_ini
143      !!---------------------------------------------------------------------
144      !!                  ***  ROUTINE trc_adv_ini  ***
145      !!               
146      !! ** Purpose : Control the consistency between namelist options for
147      !!              passive tracer advection schemes and set nadv
148      !!----------------------------------------------------------------------
149      INTEGER ::   ioptio
150      INTEGER ::  ios                 ! Local integer output status for namelist read
151      !!
152      NAMELIST/namtrc_adv/ ln_trcadv_cen, nn_cen_h, nn_cen_v,               &   ! CEN
153         &                 ln_trcadv_fct, nn_fct_h, nn_fct_v, nn_fct_zts,   &   ! FCT
154         &                 ln_trcadv_mus,                     ln_mus_ups,   &   ! MUSCL
155         &                 ln_trcadv_ubs,           nn_ubs_v,               &   ! UBS
156         &                 ln_trcadv_qck                                        ! QCK
157      !!----------------------------------------------------------------------
158      !
159      REWIND( numnat_ref )              !  namtrc_adv in reference namelist
160      READ  ( numnat_ref, namtrc_adv, IOSTAT = ios, ERR = 901)
161901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in reference namelist', lwp )
162
163      REWIND( numnat_cfg )              ! namtrc_adv in configuration namelist
164      READ  ( numnat_cfg, namtrc_adv, IOSTAT = ios, ERR = 902 )
165902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in configuration namelist', lwp )
166      IF(lwm) WRITE ( numont, namtrc_adv )
167
168      IF(lwp) THEN                    ! Namelist print
169         WRITE(numout,*)
170         WRITE(numout,*) 'trc_adv_ini : choice/control of the tracer advection scheme'
171         WRITE(numout,*) '~~~~~~~~~~~'
172         WRITE(numout,*) '   Namelist namtrc_adv : chose a advection scheme for tracers'
173         WRITE(numout,*) '      centered scheme                           ln_trcadv_cen = ', ln_trcadv_cen
174         WRITE(numout,*) '            horizontal 2nd/4th order               nn_cen_h   = ', nn_fct_h
175         WRITE(numout,*) '            vertical   2nd/4th order               nn_cen_v   = ', nn_fct_v
176         WRITE(numout,*) '      Flux Corrected Transport scheme           ln_trcadv_fct = ', ln_trcadv_fct
177         WRITE(numout,*) '            horizontal 2nd/4th order               nn_fct_h   = ', nn_fct_h
178         WRITE(numout,*) '            vertical   2nd/4th order               nn_fct_v   = ', nn_fct_v
179         WRITE(numout,*) '            2nd order + vertical sub-timestepping  nn_fct_zts = ', nn_fct_zts
180         WRITE(numout,*) '      MUSCL scheme                              ln_trcadv_mus = ', ln_trcadv_mus
181         WRITE(numout,*) '            + upstream scheme near river mouths    ln_mus_ups = ', ln_mus_ups
182         WRITE(numout,*) '      UBS scheme                                ln_trcadv_ubs = ', ln_trcadv_ubs
183         WRITE(numout,*) '            vertical   2nd/4th order               nn_ubs_v   = ', nn_ubs_v
184         WRITE(numout,*) '      QUICKEST scheme                           ln_trcadv_qck = ', ln_trcadv_qck
185      ENDIF
186      !
187
188      ioptio = 0                       !==  Parameter control  ==!
189      IF( ln_trcadv_cen )   ioptio = ioptio + 1
190      IF( ln_trcadv_fct )   ioptio = ioptio + 1
191      IF( ln_trcadv_mus )   ioptio = ioptio + 1
192      IF( ln_trcadv_ubs )   ioptio = ioptio + 1
193      IF( ln_trcadv_qck )   ioptio = ioptio + 1
194
195      !
196      IF( ioptio == 0 ) THEN
197         nadv = np_NO_adv
198         CALL ctl_warn( 'trc_adv_init: You are running without tracer advection.' )
199      ENDIF
200      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
201      !
202      IF( ln_trcadv_cen .AND. ( nn_cen_h /= 2 .AND. nn_cen_h /= 4 )   &
203                        .AND. ( nn_cen_v /= 2 .AND. nn_cen_v /= 4 )   ) THEN
204        CALL ctl_stop( 'trc_adv_init: CEN scheme, choose 2nd or 4th order' )
205      ENDIF
206      IF( ln_trcadv_fct .AND. ( nn_fct_h /= 2 .AND. nn_fct_h /= 4 )   &
207                        .AND. ( nn_fct_v /= 2 .AND. nn_fct_v /= 4 )   ) THEN
208        CALL ctl_stop( 'trc_adv_init: FCT scheme, choose 2nd or 4th order' )
209      ENDIF
210      IF( ln_trcadv_fct .AND. nn_fct_zts > 0 ) THEN
211         IF( nn_fct_h == 4 ) THEN
212            nn_fct_h = 2
213            CALL ctl_stop( 'trc_adv_init: force 2nd order FCT scheme, 4th order does not exist with sub-timestepping' )
214         ENDIF
215         IF( .NOT.ln_linssh ) THEN
216            CALL ctl_stop( 'trc_adv_init: vertical sub-timestepping not allow in non-linear free surface' )
217         ENDIF
218         IF( nn_fct_zts == 1 )   CALL ctl_warn( 'trc_adv_init: FCT with ONE sub-timestep = FCT without sub-timestep' )
219      ENDIF
220      IF( ln_trcadv_ubs .AND. ( nn_ubs_v /= 2 .AND. nn_ubs_v /= 4 )   ) THEN
221        CALL ctl_stop( 'trc_adv_init: UBS scheme, choose 2nd or 4th order' )
222      ENDIF
223      IF( ln_trcadv_ubs .AND. nn_ubs_v == 4 ) THEN
224         CALL ctl_warn( 'trc_adv_init: UBS scheme, only 2nd FCT scheme available on the vertical. It will be used' )
225      ENDIF
226      IF( ln_isfcav ) THEN                                                       ! ice-shelf cavities
227         IF(  ln_trcadv_cen .AND. nn_cen_v /= 4    .OR.   &                            ! NO 4th order with ISF
228            & ln_trcadv_fct .AND. nn_fct_v /= 4   )   CALL ctl_stop( 'tra_adv_init: 4th order COMPACT scheme not allowed with ISF' )
229      ENDIF
230      !
231      !                                !==  used advection scheme  ==!
232      !                                      ! set nadv
233      IF( ln_trcadv_cen                      )   nadv = np_CEN
234      IF( ln_trcadv_fct                      )   nadv = np_FCT
235      IF( ln_trcadv_fct .AND. nn_fct_zts > 0 )   nadv = np_FCT_zts
236      IF( ln_trcadv_mus                      )   nadv = np_MUS
237      IF( ln_trcadv_ubs                      )   nadv = np_UBS
238      IF( ln_trcadv_qck                      )   nadv = np_QCK
239      !
240      IF(lwp) THEN                   ! Print the choice
241         WRITE(numout,*)
242         IF( nadv == np_NO_adv  )   WRITE(numout,*) '         NO passive tracer advection'
243         IF( nadv == np_CEN     )   WRITE(numout,*) '         CEN      scheme is used. Horizontal order: ', nn_cen_h,   &
244            &                                                                        ' Vertical   order: ', nn_cen_v
245         IF( nadv == np_FCT     )   WRITE(numout,*) '         FCT      scheme is used. Horizontal order: ', nn_fct_h,   &
246            &                                                                       ' Vertical   order: ', nn_fct_v
247         IF( nadv == np_FCT_zts )   WRITE(numout,*) '         use 2nd order FCT with ', nn_fct_zts,'vertical sub-timestepping'
248         IF( nadv == np_MUS     )   WRITE(numout,*) '         MUSCL    scheme is used'
249         IF( nadv == np_UBS     )   WRITE(numout,*) '         UBS      scheme is used'
250         IF( nadv == np_QCK     )   WRITE(numout,*) '         QUICKEST scheme is used'
251      ENDIF
252      !
253   END SUBROUTINE trc_adv_ini
254   
255#else
256   !!----------------------------------------------------------------------
257   !!   Default option                                         Empty module
258   !!----------------------------------------------------------------------
259CONTAINS
260   SUBROUTINE trc_adv( kt )
261      INTEGER, INTENT(in) :: kt
262      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
263   END SUBROUTINE trc_adv
264#endif
265
266  !!======================================================================
267END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.