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/dev_001_GM/NEMO/OPA_SRC/TRA – NEMO

source: branches/dev_001_GM/NEMO/OPA_SRC/TRA/traadv.F90 @ 791

Last change on this file since 791 was 791, checked in by gm, 16 years ago

dev_001_GM - TRA/traadv : switch from velocity to transport + optimised traadv_eiv2 introduced - compilation OK

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.8 KB
Line 
1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
6   !! History :  1.0  !  2005-11  (G. Madec)  Original code
7   !!            2.4  !  2008-01  (G. Madec)  merge TRC-TRA + switch from velocity to transport
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   tra_adv      : compute ocean tracer advection trend
12   !!   tra_adv_ctl  : control the different options of advection scheme
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and active tracers
15   USE dom_oce         ! ocean space and time domain
16   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
17   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
18   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
19   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
20   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
21   USE traadv_qck     !! QUICKEST scheme           (tra_adv_qck    routine)
22   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
23   USE trabbl          ! tracers: bottom boundary layer
24   USE ldftra_oce      ! lateral diffusion coefficient on tracers
25   USE in_out_manager  ! I/O manager
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   tra_adv    ! routine called by step module
31 
32   !!* Namelist nam_traadv
33   LOGICAL, PUBLIC ::   ln_traadv_cen2   = .TRUE.       ! 2nd order centered scheme flag
34   LOGICAL, PUBLIC ::   ln_traadv_tvd    = .FALSE.      ! TVD scheme flag
35   LOGICAL, PUBLIC ::   ln_traadv_muscl  = .FALSE.      ! MUSCL scheme flag
36   LOGICAL, PUBLIC ::   ln_traadv_muscl2 = .FALSE.      ! MUSCL2 scheme flag
37   LOGICAL, PUBLIC ::   ln_traadv_ubs    = .FALSE.      ! UBS scheme flag
38   LOGICAL, PUBLIC ::   ln_traadv_qck    = .FALSE.      ! QUICKEST scheme flag
39
40   INTEGER ::   nadv   ! choice of the type of advection scheme
41
42   !! * Substitutions
43#  include "domzgr_substitute.h90"
44#  include "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !!   OPA 9.0 , LOCEAN-IPSL (2006)
47   !! $Header: /home/opalod/NEMOCVSROOT/NEMO/OPA_SRC/TRA/traadv.F90,v 1.7 2007/06/05 11:00:53 opalod Exp $
48   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50
51CONTAINS
52
53   SUBROUTINE tra_adv( kt )
54      !!----------------------------------------------------------------------
55      !!                  ***  ROUTINE tra_adv  ***
56      !!
57      !! ** Purpose :   compute the ocean tracer advection trend.
58      !!
59      !! ** Method  : - Update (ua,va) with the advection term following nadv
60      !!----------------------------------------------------------------------
61      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
62      !!
63      INTEGER ::   jk   ! dummy loop index
64      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective transports
65      !!----------------------------------------------------------------------
66
67      IF( kt == nit000 )   CALL tra_adv_ctl          ! initialisation & control of options
68
69
70      !                                              ! effective transport
71      DO jk = 1, jpkm1 
72#if defined key_trabbl_adv
73         !                                                ! eulerian + bbl transport
74         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * ( un(:,:,jk) - u_bbl(:,:,jk) )
75         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * ( vn(:,:,jk) - v_bbl(:,:,jk) )
76         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * ( wn(:,:,jk) + w_bbl(:,:,jk) )
77#else
78         !                                                ! eulerian transport only
79         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) *   un(:,:,jk) 
80         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) *   vn(:,:,jk)
81         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      *   wn(:,:,jk)
82#endif
83      END DO
84      zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
85
86      !                                                   ! add the eiv transport (if necessary)
87      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn ) 
88
89
90      SELECT CASE ( nadv )                           ! compute advection trend and add it to general trend
91      !
92      CASE ( 1 )   ;   CALL tra_adv_cen2    ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! 2nd order centered
93                       CALL tra_adv_cen2    ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )    ! on T & S
94      !
95      CASE ( 2 )   ;   CALL tra_adv_tvd     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! TVD      scheme
96                       CALL tra_adv_tvd     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )    ! on T & S
97      !
98      CASE ( 3 )   ;   CALL tra_adv_muscl   ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb    , ta )    ! MUSCL    scheme
99                       CALL tra_adv_muscl   ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb    , sa )    ! on T & S
100      !
101      CASE ( 4 )   ;   CALL tra_adv_muscl2  ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! MUSCL2   scheme
102                       CALL tra_adv_muscl2  ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )    ! on T & S
103      !
104      CASE ( 5 )   ;   CALL tra_adv_ubs     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! UBS      scheme
105                       CALL tra_adv_ubs     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )    ! on T & S
106      !
107      CASE ( 6 )   ;   CALL tra_adv_qck     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! QUICKEST scheme
108                       CALL tra_adv_qck     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )    ! on T & S
109      !
110      CASE (-1 )                                     ! NEMO debug : test all the schemes at once
111                       CALL tra_adv_cen2    ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! 2nd order centered
112                       CALL tra_adv_cen2    ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa ) 
113                       CALL tra_adv_tvd     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! TVD      scheme
114                       CALL tra_adv_tvd     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa ) 
115                       CALL tra_adv_muscl   ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb    , ta )    ! MUSCL    scheme
116                       CALL tra_adv_muscl   ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb    , sa ) 
117                       CALL tra_adv_muscl2  ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! MUSCL2   scheme
118                       CALL tra_adv_muscl2  ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )
119                       CALL tra_adv_ubs     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! UBS      scheme
120                       CALL tra_adv_ubs     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )
121                       CALL tra_adv_qck     ( kt, 'TRA', jp_tem, zun, zvn, zwn, tb, tn, ta )    ! QUICKEST scheme
122                       CALL tra_adv_qck     ( kt, 'TRA', jp_sal, zun, zvn, zwn, sb, sn, sa )
123      END SELECT
124      !
125   END SUBROUTINE tra_adv
126
127
128   SUBROUTINE tra_adv_ctl
129      !!---------------------------------------------------------------------
130      !!                  ***  ROUTINE tra_adv_ctl  ***
131      !!               
132      !! ** Purpose :   Control the consistency between namelist options for
133      !!              tracer advection schemes and set nadv
134      !!----------------------------------------------------------------------
135      INTEGER ::   ioptio
136      !!
137      NAMELIST/nam_traadv/ ln_traadv_cen2 , ln_traadv_tvd,    &
138         &                 ln_traadv_muscl, ln_traadv_muscl2, &
139         &                 ln_traadv_ubs  , ln_traadv_qck
140      !!----------------------------------------------------------------------
141
142      REWIND ( numnam )               ! Read Namelist nam_traadv : tracer advection scheme
143      READ   ( numnam, nam_traadv )
144
145      IF(lwp) THEN                    ! Namelist print
146         WRITE(numout,*)
147         WRITE(numout,*) 'tra_adv_ctl : choice/control of the tracer advection scheme'
148         WRITE(numout,*) '~~~~~~~~~~~'
149         WRITE(numout,*) '       Namelist nam_traadv : chose a advection scheme for tracers'
150         WRITE(numout,*) '          2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
151         WRITE(numout,*) '          TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
152         WRITE(numout,*) '          MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
153         WRITE(numout,*) '          MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
154         WRITE(numout,*) '          UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
155         WRITE(numout,*) '          QUICKEST advection scheme      ln_traadv_qck    = ', ln_traadv_qck
156    ENDIF
157
158      ioptio = 0                      ! Parameter control
159      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
160      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
161      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
162      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
163      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
164      IF( ln_traadv_qck    )   ioptio = ioptio + 1
165      IF( lk_esopa         )   ioptio =          1
166
167      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist nam_traadv' )
168
169      IF( n_cla == 1 .AND. .NOT. ln_traadv_cen2 )   &
170         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
171
172      !                               ! Set nadv
173      IF( ln_traadv_cen2   )   nadv =  1
174      IF( ln_traadv_tvd    )   nadv =  2
175      IF( ln_traadv_muscl  )   nadv =  3
176      IF( ln_traadv_muscl2 )   nadv =  4
177      IF( ln_traadv_ubs    )   nadv =  5
178      IF( ln_traadv_qck    )   nadv =  6
179      IF( lk_esopa         )   nadv = -1
180
181      IF(lwp) THEN                    ! Print the choice
182         WRITE(numout,*)
183         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
184         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
185         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
186         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
187         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
188         IF( nadv ==  6 )   WRITE(numout,*) '         PPM       scheme is used'
189         IF( nadv ==  7 )   WRITE(numout,*) '         QUICKEST  scheme is used'
190         IF( nadv == -1 )   WRITE(numout,*) '         NEMO debug: test all advection scheme at once'
191      ENDIF
192      !
193   END SUBROUTINE tra_adv_ctl
194
195  !!======================================================================
196END MODULE traadv
Note: See TracBrowser for help on using the repository browser.