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/2014/dev_r4822_INGV_WAVE/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/2014/dev_r4822_INGV_WAVE/NEMOGCM/NEMO/OPA_SRC/TRA/traadv.F90 @ 5457

Last change on this file since 5457 was 5457, checked in by emanuelaclementi, 9 years ago

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