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

source: branches/DEV_r2191_3partymerge2010/NEMO/OPA_SRC/TRA/traadv.F90 @ 2205

Last change on this file since 2205 was 2205, checked in by acc, 13 years ago

#733 DEV_r2191_3partymerge2010. Merged in changes from DEV_r1924_nocs_latphys

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