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

source: trunk/NEMO/OPA_SRC/TRA/traadv.F90 @ 1839

Last change on this file since 1839 was 1601, checked in by ctlod, 15 years ago

Doctor naming of OPA namelist variables , see ticket: #526
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 10.4 KB
RevLine 
[458]1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
[1482]6   !! History :  2.0  !  05-11  (G. Madec)  Original code
[458]7   !!----------------------------------------------------------------------
[503]8
9   !!----------------------------------------------------------------------
[458]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
[503]15   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
[637]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)
[458]21   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
[503]22   USE trabbl          ! tracers: bottom boundary layer
23   USE ldftra_oce      ! lateral diffusion coefficient on tracers
[458]24   USE in_out_manager  ! I/O manager
25   USE prtctl          ! Print control
[1482]26   USE iom
[458]27
28   IMPLICIT NONE
29   PRIVATE
30
[503]31   PUBLIC   tra_adv    ! routine called by step module
[458]32 
[1601]33   !                                                   !!* Namelist namtra_adv *
[503]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
[637]39   LOGICAL, PUBLIC ::   ln_traadv_qck    = .FALSE.      ! QUICKEST scheme flag
[458]40
[503]41   INTEGER ::   nadv   ! choice of the type of advection scheme
[458]42
43   !! * Substitutions
[503]44#  include "domzgr_substitute.h90"
45#  include "vectopt_loop_substitute.h90"
[458]46   !!----------------------------------------------------------------------
[1482]47   !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009)
[1152]48   !! $Id$
[503]49   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
[458]50   !!----------------------------------------------------------------------
51
52CONTAINS
53
54   SUBROUTINE tra_adv( kt )
55      !!----------------------------------------------------------------------
56      !!                  ***  ROUTINE tra_adv  ***
57      !!
58      !! ** Purpose :   compute the ocean tracer advection trend.
59      !!
[503]60      !! ** Method  : - Update (ua,va) with the advection term following nadv
[458]61      !!----------------------------------------------------------------------
62#if ( defined key_trabbl_adv || defined key_traldf_eiv )
[503]63      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective velocity
[458]64#else
[503]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       !
[458]68#endif
[503]69      !!
70      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
[458]71      !!----------------------------------------------------------------------
72
[503]73      IF( kt == nit000 )   CALL tra_adv_ctl          ! initialisation & control of options
[458]74
75#if defined key_trabbl_adv
[503]76      zun(:,:,:) = un(:,:,:) - u_bbl(:,:,:)          ! add the bbl velocity
[458]77      zvn(:,:,:) = vn(:,:,:) - v_bbl(:,:,:)
78      zwn(:,:,:) = wn(:,:,:) + w_bbl(:,:,:)
79#endif
[503]80      IF( lk_traldf_eiv ) THEN                       ! commpute and add the eiv velocity
[458]81         IF( .NOT. lk_trabbl_adv ) THEN
82            zun(:,:,:) = un(:,:,:)
83            zvn(:,:,:) = vn(:,:,:)
84            zwn(:,:,:) = wn(:,:,:)
85         ENDIF
[503]86         CALL tra_adv_eiv( kt, zun, zvn, zwn ) 
[458]87      ENDIF
88
[503]89      SELECT CASE ( nadv )                           ! compute advection trend and add it to general trend
[789]90      CASE ( 1 )   ;   CALL tra_adv_cen2    ( kt, zun, zvn, zwn )    ! 2nd order centered scheme
[637]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
[503]96      !
97      CASE (-1 )                                                     ! esopa: test all possibility with control print
[684]98                       CALL tra_adv_cen2    ( kt, zun, zvn, zwn )
99                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv0 - Ta: ', mask1=tmask,               &
[503]100            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[684]101                       CALL tra_adv_tvd     ( kt, zun, zvn, zwn )
102                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv2 - Ta: ', mask1=tmask,               &
[503]103            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[684]104                       CALL tra_adv_muscl   ( kt, zun, zvn, zwn )
105                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv3 - Ta: ', mask1=tmask,               &
[503]106            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[684]107                       CALL tra_adv_muscl2  ( kt, zun, zvn, zwn )
108                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv4 - Ta: ', mask1=tmask,               &
[503]109            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[684]110                       CALL tra_adv_ubs     ( kt, zun, zvn, zwn )
111                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv5 - Ta: ', mask1=tmask,               &
[503]112            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[684]113                       CALL tra_adv_qck     ( kt, zun, zvn, zwn )
114                       CALL prt_ctl( tab3d_1=ta, clinfo1=' adv6 - Ta: ', mask1=tmask,               &
[637]115            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[458]116      END SELECT
[1482]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
[503]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      !
[458]126   END SUBROUTINE tra_adv
127
128
129   SUBROUTINE tra_adv_ctl
130      !!---------------------------------------------------------------------
131      !!                  ***  ROUTINE tra_adv_ctl  ***
132      !!               
[503]133      !! ** Purpose :   Control the consistency between namelist options for
134      !!              tracer advection schemes and set nadv
[458]135      !!----------------------------------------------------------------------
136      INTEGER ::   ioptio
[541]137
[1601]138      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,    &
[637]139         &                 ln_traadv_muscl, ln_traadv_muscl2, &
140         &                 ln_traadv_ubs  , ln_traadv_qck
[458]141      !!----------------------------------------------------------------------
142
[1601]143      REWIND ( numnam )               ! Read Namelist namtra_adv : tracer advection scheme
144      READ   ( numnam, namtra_adv )
[458]145
[503]146      IF(lwp) THEN                    ! Namelist print
[458]147         WRITE(numout,*)
148         WRITE(numout,*) 'tra_adv_ctl : choice/control of the tracer advection scheme'
149         WRITE(numout,*) '~~~~~~~~~~~'
[1601]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
[637]157    ENDIF
[458]158
[503]159      ioptio = 0                      ! Parameter control
[458]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
[503]164      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
[637]165      IF( ln_traadv_qck    )   ioptio = ioptio + 1
[503]166      IF( lk_esopa         )   ioptio =          1
[458]167
[1601]168      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
[458]169
[503]170      IF( n_cla == 1 .AND. .NOT. ln_traadv_cen2 )   &
171         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
[458]172
[503]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
[637]179      IF( ln_traadv_qck    )   nadv =  6
[503]180      IF( lk_esopa         )   nadv = -1
[458]181
[503]182      IF(lwp) THEN                   ! Print the choice
183         WRITE(numout,*)
[789]184         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
[503]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'
[789]189         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
[503]190         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
[458]191      ENDIF
[503]192      !
[458]193   END SUBROUTINE tra_adv_ctl
194
195  !!======================================================================
196END MODULE traadv
Note: See TracBrowser for help on using the repository browser.