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.
trcadv.F90 in branches/DEV_r2006_merge_TRA_TRC/NEMO/TOP_SRC/TRP – NEMO

source: branches/DEV_r2006_merge_TRA_TRC/NEMO/TOP_SRC/TRP/trcadv.F90 @ 2082

Last change on this file since 2082 was 2082, checked in by cetlod, 14 years ago

Improve the merge of TRA-TRC, see ticket #717
File size: 9.9 KB
Line 
1MODULE trcadv
2   !!==============================================================================
3   !!                       ***  MODULE  trcadv  ***
4   !! Ocean passive tracers:  advection trend
5   !!==============================================================================
6   !! History :  2.0  !  05-11  (G. Madec)  Original code
7   !!            3.0  !  10-06  (C. Ethe)   Adapted to passive tracers
8   !!----------------------------------------------------------------------
9#if defined key_top
10   !!----------------------------------------------------------------------
11   !!   'key_top'                                                TOP models
12   !!----------------------------------------------------------------------
13   !!----------------------------------------------------------------------
14   !!   trc_adv      : compute ocean tracer advection trend
15   !!   trc_adv_ctl  : control the different options of advection scheme
16   !!----------------------------------------------------------------------
17   USE oce_trc         ! ocean dynamics and active tracers
18   USE trc             ! ocean passive tracers variables
19   USE trcnam_trp      ! passive tracers transport namelist variables
20   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
21   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
22   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
23   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
24   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
25   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
26   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
27   USE ldftra_oce      ! lateral diffusion coefficient on tracers
28   USE in_out_manager  ! I/O manager
29   USE prtctl_trc          ! Print control
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC   trc_adv    ! routine called by step module
35
36   INTEGER ::   nadv   ! choice of the type of advection scheme
37   REAL(wp), DIMENSION(jpk) ::   r2dt  ! vertical profile time-step, = 2 rdttra
38      !                                ! except at nit000 (=rdttra) if neuler=0
39
40   !! * Substitutions
41#  include "domzgr_substitute.h90"
42#  include "vectopt_loop_substitute.h90"
43   !!----------------------------------------------------------------------
44   !! NEMO/OPA 3.3 , LOCEAN-IPSL (2010)
45   !! $Id: trcadv.F90 2024 2010-07-29 10:57:35Z cetlod $
46   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
47   !!----------------------------------------------------------------------
48
49CONTAINS
50
51   SUBROUTINE trc_adv( kt )
52      !!----------------------------------------------------------------------
53      !!                  ***  ROUTINE trc_adv  ***
54      !!
55      !! ** Purpose :   compute the ocean tracer advection trend.
56      !!
57      !! ** Method  : - Update the tracer with the advection term following nadv
58      !!----------------------------------------------------------------------
59      !!
60      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
61      !
62      INTEGER :: jk 
63      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective velocity
64      CHARACTER (len=22) :: charout
65      !!----------------------------------------------------------------------
66
67      IF( kt == nittrc000 )   CALL trc_adv_ctl          ! initialisation & control of options
68
69      IF( neuler == 0 .AND. kt == nittrc000 ) THEN     ! at nit000
70         r2dt(:) =  rdttra(:) * FLOAT(nn_dttrc)          ! = rdtra (restarting with Euler time stepping)
71      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nit000 or nit000+1
72         r2dt(:) = 2. * rdttra(:) * FLOAT(nn_dttrc)      ! = 2 rdttra (leapfrog)
73      ENDIF
74
75      !                                                   ! effective transport
76      DO jk = 1, jpkm1
77         !                                                ! eulerian transport only
78         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
79         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
80         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
81         !
82      END DO
83      zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
84
85      !                                                   ! add the eiv transport (if necessary)
86      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRC' )
87      !
88      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
89      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
90      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
91      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )   !  MUSCL
92      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
93      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
94      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
95      !
96      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
97         CALL tra_adv_cen2  ( kt, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )         
98         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
99                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
100         CALL tra_adv_tvd   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
101         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
102                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
103         CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )         
104         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
105                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
106         CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
107         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
108                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
109         CALL tra_adv_ubs   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
110         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
111                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
112         CALL tra_adv_qck   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
113         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
114                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
115         !
116      END SELECT
117
118      !                                              ! print mean trends (used for debugging)
119      IF( ln_ctl )   THEN
120         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
121                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
122      END IF
123      !
124   END SUBROUTINE trc_adv
125
126
127   SUBROUTINE trc_adv_ctl
128      !!---------------------------------------------------------------------
129      !!                  ***  ROUTINE trc_adv_ctl  ***
130      !!               
131      !! ** Purpose : Control the consistency between namelist options for
132      !!              passive tracer advection schemes and set nadv
133      !!----------------------------------------------------------------------
134      INTEGER ::   ioptio
135      !!----------------------------------------------------------------------
136
137      ioptio = 0                      ! Parameter control
138      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
139      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
140      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
141      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
142      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
143      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
144      IF( lk_esopa         )   ioptio =          1
145
146      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
147
148      IF( n_cla == 1 .AND. .NOT. ln_trcadv_cen2 )   &
149         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
150
151      !                              ! Set nadv
152      IF( ln_trcadv_cen2   )   nadv =  1
153      IF( ln_trcadv_tvd    )   nadv =  2
154      IF( ln_trcadv_muscl  )   nadv =  3
155      IF( ln_trcadv_muscl2 )   nadv =  4
156      IF( ln_trcadv_ubs    )   nadv =  5
157      IF( ln_trcadv_qck    )   nadv =  6
158      IF( lk_esopa         )   nadv = -1
159
160      IF(lwp) THEN                   ! Print the choice
161         WRITE(numout,*)
162         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
163         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
164         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
165         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
166         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
167         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
168         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
169      ENDIF
170      !
171   END SUBROUTINE trc_adv_ctl
172#else
173   !!----------------------------------------------------------------------
174   !!   Default option                                         Empty module
175   !!----------------------------------------------------------------------
176CONTAINS
177   SUBROUTINE trc_adv( kt )
178      INTEGER, INTENT(in) :: kt
179      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
180   END SUBROUTINE trc_adv
181#endif
182  !!======================================================================
183END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.