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.
traadv.F90 in branches/UKMO/AMM15_v3_6_STABLE_package_collate/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/UKMO/AMM15_v3_6_STABLE_package_collate/NEMOGCM/NEMO/OPA_SRC/TRA/traadv.F90 @ 11277

Last change on this file since 11277 was 11277, checked in by kingr, 5 years ago

Merged Juan's changes for running AMM15 woth wave coupling.
Corrected minor logic error to allow AMM7-uncoupled to reproduce earlier results.
Few line spacing changes to allow merging with OBS br and trunk rvn 5518.
File size: 14.8 KB
Line 
1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
6   !! History :  2.0  !  2005-11  (G. Madec)  Original code
7   !!            3.3  !  2010-09  (C. Ethe, G. Madec)  merge TRC-TRA + switch from velocity to transport
8   !!            3.6  !  2015-06  (E. Clementi) Addition of Stokes drift in case of wave coupling
9   !!            4.0  !  2011-06  (G. Madec)  Addition of Mixed Layer Eddy parameterisation
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   tra_adv      : compute ocean tracer advection trend
14   !!   tra_adv_ctl  : control the different options of advection scheme
15   !!----------------------------------------------------------------------
16   USE oce             ! ocean dynamics and active tracers
17   USE dom_oce         ! ocean space and time domain
18   USE domvvl          ! variable vertical scale factors
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 cla             ! cross land advection      (cla_traadv     routine)
28   USE ldftra_oce      ! lateral diffusion coefficient on tracers
29   !
30   USE in_out_manager  ! I/O manager
31   USE iom             ! I/O module
32   USE prtctl          ! Print control
33   USE lib_mpp         ! MPP library
34   USE wrk_nemo        ! Memory Allocation
35   USE timing          ! Timing
36   USE sbc_oce
37   USE sbcwave        ! wave module 
38   USE sbc_oce        ! surface boundary condition: ocean 
39   USE diaptr         ! Poleward heat transport
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   tra_adv        ! routine called by step module
45   PUBLIC   tra_adv_init   ! routine called by opa module
46
47   !                              !!* Namelist namtra_adv *
48   LOGICAL ::   ln_traadv_cen2     ! 2nd order centered scheme flag
49   LOGICAL ::   ln_traadv_tvd      ! TVD scheme flag
50   LOGICAL ::   ln_traadv_tvd_zts  ! TVD scheme flag with vertical sub time-stepping
51   LOGICAL ::   ln_traadv_muscl    ! MUSCL scheme flag
52   LOGICAL ::   ln_traadv_muscl2   ! MUSCL2 scheme flag
53   LOGICAL ::   ln_traadv_ubs      ! UBS scheme flag
54   LOGICAL ::   ln_traadv_qck      ! QUICKEST scheme flag
55   LOGICAL ::   ln_traadv_msc_ups  ! use upstream scheme within muscl
56
57
58   INTEGER ::   nadv   ! choice of the type of advection scheme
59
60   !! * Substitutions
61#  include "domzgr_substitute.h90"
62#  include "vectopt_loop_substitute.h90"
63   !!----------------------------------------------------------------------
64   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
65   !! $Id$
66   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
67   !!----------------------------------------------------------------------
68CONTAINS
69
70   SUBROUTINE tra_adv( kt )
71      !!----------------------------------------------------------------------
72      !!                  ***  ROUTINE tra_adv  ***
73      !!
74      !! ** Purpose :   compute the ocean tracer advection trend.
75      !!
76      !! ** Method  : - Update (ua,va) with the advection term following nadv
77      !!----------------------------------------------------------------------
78      !
79      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
80      !
81      INTEGER ::   jk   ! dummy loop index
82      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn
83      !!----------------------------------------------------------------------
84      !
85      IF( nn_timing == 1 )  CALL timing_start('tra_adv')
86      !
87      CALL wrk_alloc( jpi, jpj, jpk, zun, zvn, zwn )
88      !                                          ! set time step
89      zun(:,:,:) = 0.0 
90      zvn(:,:,:) = 0.0 
91      zwn(:,:,:) = 0.0 
92      !
93      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
94         r2dtra(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
95      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
96         r2dtra(:) = 2._wp * rdttra(:)                   ! = 2 rdttra (leapfrog)
97      ENDIF
98      !
99      IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 )   CALL cla_traadv( kt )       !==  Cross Land Advection  ==! (hor. advection)
100      !
101      !                                               !==  effective transport  ==!
102      IF(ln_wave .AND. ln_sdw) THEN 
103         DO jk = 1, jpkm1                                                                      ! eulerian transport + Stokes Drift 
104            zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * ( un(:,:,jk) + usd(:,:,jk) ) 
105            zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * ( vn(:,:,jk) + vsd(:,:,jk) ) 
106            zwn(:,:,jk) = e1e2t(:,:)               * ( wn(:,:,jk) + wsd(:,:,jk) ) 
107         END DO 
108      ELSE 
109         DO jk = 1, jpkm1 
110            zun(:,:,jk) = e2u  (:,:) * fse3u(:,:,jk) * un(:,:,jk)             ! eulerian transport only 
111            zvn(:,:,jk) = e1v  (:,:) * fse3v(:,:,jk) * vn(:,:,jk) 
112            zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk) 
113         END DO 
114      ENDIF
115      !
116      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
117         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
118         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
119      ENDIF
120      !
121      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
122      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
123      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
124      !
125      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &
126         &              CALL tra_adv_eiv( kt, nit000, zun, zvn, zwn, 'TRA' )    ! add the eiv transport (if necessary)
127      !
128      IF( ln_mle    )   CALL tra_adv_mle( kt, nit000, zun, zvn, zwn, 'TRA' )    ! add the mle transport (if necessary)
129      !
130      CALL iom_put( "uocetr_eff", zun )                                         ! output effective transport     
131      CALL iom_put( "vocetr_eff", zvn )
132      CALL iom_put( "wocetr_eff", zwn )
133      !
134      IF( ln_diaptr )   CALL dia_ptr( zvn )                                     ! diagnose the effective MSF
135      !
136   
137      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
138      CASE ( 1 )   ;    CALL tra_adv_cen2   ( kt, nit000, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  2nd order centered
139      CASE ( 2 )   ;    CALL tra_adv_tvd    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD
140      CASE ( 3 )   ;    CALL tra_adv_muscl  ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts, ln_traadv_msc_ups )   !  MUSCL
141      CASE ( 4 )   ;    CALL tra_adv_muscl2 ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  MUSCL2
142      CASE ( 5 )   ;    CALL tra_adv_ubs    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  UBS
143      CASE ( 6 )   ;    CALL tra_adv_qck    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  QUICKEST
144      CASE ( 7 )   ;    CALL tra_adv_tvd_zts( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD ZTS
145      !
146      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
147         CALL tra_adv_cen2  ( kt, nit000, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )         
148         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv0 - Ta: ', mask1=tmask,               &
149            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
150         CALL tra_adv_tvd   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
151         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv1 - Ta: ', mask1=tmask,               &
152            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
153         CALL tra_adv_muscl ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts, ln_traadv_msc_ups )         
154         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv3 - Ta: ', mask1=tmask,               &
155            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
156         CALL tra_adv_muscl2( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
157         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv4 - Ta: ', mask1=tmask,               &
158            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
159         CALL tra_adv_ubs   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
160         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv5 - Ta: ', mask1=tmask,               &
161            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
162         CALL tra_adv_qck   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
163         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv6 - Ta: ', mask1=tmask,               &
164            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
165      END SELECT
166      !
167      !                                              ! print mean trends (used for debugging)
168      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv  - Ta: ', mask1=tmask,               &
169         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
170      !
171      IF( nn_timing == 1 )  CALL timing_stop( 'tra_adv' )
172      !
173      CALL wrk_dealloc( jpi, jpj, jpk, zun, zvn, zwn )
174      !                                         
175   END SUBROUTINE tra_adv
176
177
178   SUBROUTINE tra_adv_init
179      !!---------------------------------------------------------------------
180      !!                  ***  ROUTINE tra_adv_init  ***
181      !!               
182      !! ** Purpose :   Control the consistency between namelist options for
183      !!              tracer advection schemes and set nadv
184      !!----------------------------------------------------------------------
185      INTEGER ::   ioptio
186      INTEGER ::   ios                 ! Local integer output status for namelist read
187      !!
188      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,     &
189         &                 ln_traadv_muscl, ln_traadv_muscl2,  &
190         &                 ln_traadv_ubs  , ln_traadv_qck,     &
191         &                 ln_traadv_msc_ups, ln_traadv_tvd_zts
192      !!----------------------------------------------------------------------
193
194      REWIND( numnam_ref )              ! Namelist namtra_adv in reference namelist : Tracer advection scheme
195      READ  ( numnam_ref, namtra_adv, IOSTAT = ios, ERR = 901)
196901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in reference namelist', lwp )
197
198      REWIND( numnam_cfg )              ! Namelist namtra_adv in configuration namelist : Tracer advection scheme
199      READ  ( numnam_cfg, namtra_adv, IOSTAT = ios, ERR = 902 )
200902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in configuration namelist', lwp )
201      IF(lwm) WRITE ( numond, namtra_adv )
202
203      IF(lwp) THEN                    ! Namelist print
204         WRITE(numout,*)
205         WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme'
206         WRITE(numout,*) '~~~~~~~~~~~'
207         WRITE(numout,*) '   Namelist namtra_adv : chose a advection scheme for tracers'
208         WRITE(numout,*) '      2nd order advection scheme     ln_traadv_cen2    = ', ln_traadv_cen2
209         WRITE(numout,*) '      TVD advection scheme           ln_traadv_tvd     = ', ln_traadv_tvd
210         WRITE(numout,*) '      MUSCL  advection scheme        ln_traadv_muscl   = ', ln_traadv_muscl
211         WRITE(numout,*) '      MUSCL2 advection scheme        ln_traadv_muscl2  = ', ln_traadv_muscl2
212         WRITE(numout,*) '      UBS    advection scheme        ln_traadv_ubs     = ', ln_traadv_ubs
213         WRITE(numout,*) '      QUICKEST advection scheme      ln_traadv_qck     = ', ln_traadv_qck
214         WRITE(numout,*) '      upstream scheme within muscl   ln_traadv_msc_ups = ', ln_traadv_msc_ups
215         WRITE(numout,*) '      TVD advection scheme with zts  ln_traadv_tvd_zts = ', ln_traadv_tvd_zts
216      ENDIF
217
218      ioptio = 0                      ! Parameter control
219      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
220      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
221      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
222      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
223      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
224      IF( ln_traadv_qck    )   ioptio = ioptio + 1
225      IF( ln_traadv_tvd_zts)   ioptio = ioptio + 1
226      IF( lk_esopa         )   ioptio =          1
227
228      IF( ( ln_traadv_muscl .OR. ln_traadv_muscl2 .OR. ln_traadv_ubs .OR. ln_traadv_qck .OR. ln_traadv_tvd_zts )   &
229         .AND. ln_isfcav )   CALL ctl_stop( 'Only traadv_cen2 and traadv_tvd is compatible with ice shelf cavity')
230
231      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
232
233      !                              ! Set nadv
234      IF( ln_traadv_cen2   )   nadv =  1
235      IF( ln_traadv_tvd    )   nadv =  2
236      IF( ln_traadv_muscl  )   nadv =  3
237      IF( ln_traadv_muscl2 )   nadv =  4
238      IF( ln_traadv_ubs    )   nadv =  5
239      IF( ln_traadv_qck    )   nadv =  6
240      IF( ln_traadv_tvd_zts)   nadv =  7
241      IF( lk_esopa         )   nadv = -1
242
243      IF(lwp) THEN                   ! Print the choice
244         WRITE(numout,*)
245         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
246         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
247         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
248         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
249         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
250         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
251         IF( nadv ==  7 )   WRITE(numout,*) '         TVD ZTS   scheme is used'
252         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
253      ENDIF
254      !
255      CALL tra_adv_mle_init          ! initialisation of the Mixed Layer Eddy parametrisation (MLE)
256      !
257   END SUBROUTINE tra_adv_init
258
259  !!======================================================================
260END MODULE traadv
Note: See TracBrowser for help on using the repository browser.