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 @ 2034

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

cosmetic changes
File size: 9.4 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   INTEGER ::   nadv   ! choice of the type of advection scheme
36
37   !! * Substitutions
38#  include "domzgr_substitute.h90"
39#  include "vectopt_loop_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/OPA 3.3 , LOCEAN-IPSL (2010)
42   !! $Id: trcadv.F90 2024 2010-07-29 10:57:35Z cetlod $
43   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45
46CONTAINS
47
48   SUBROUTINE trc_adv( kt )
49      !!----------------------------------------------------------------------
50      !!                  ***  ROUTINE trc_adv  ***
51      !!
52      !! ** Purpose :   compute the ocean tracer advection trend.
53      !!
54      !! ** Method  : - Update the tracer with the advection term following nadv
55      !!----------------------------------------------------------------------
56      !!
57      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
58      !
59      INTEGER :: jk 
60      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective velocity
61      CHARACTER (len=22) :: charout
62      !!----------------------------------------------------------------------
63
64      IF( kt == nittrc000 )   CALL trc_adv_ctl          ! initialisation & control of options
65
66      !                                                   ! effective transport
67      DO jk = 1, jpkm1
68         !                                                ! eulerian transport only
69         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
70         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
71         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
72         !
73      END DO
74      zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
75
76      !                                                   ! add the eiv transport (if necessary)
77      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRC' )
78      !
79      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
80      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
81      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
82      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRC', zun, zvn, zwn, trb,      tra, jptra )   !  MUSCL
83      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
84      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
85      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
86      !
87      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
88         CALL tra_adv_cen2  ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )         
89         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
90                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
91         CALL tra_adv_tvd   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )         
92         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
93                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
94         CALL tra_adv_muscl ( kt, 'TRC', zun, zvn, zwn, trb,      tra, jptra )         
95         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
96                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
97         CALL tra_adv_muscl2( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )         
98         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
99                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
100         CALL tra_adv_ubs   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )         
101         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
102                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
103         CALL tra_adv_qck   ( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )         
104         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
105                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
106         !
107      END SELECT
108
109      !                                              ! print mean trends (used for debugging)
110      IF( ln_ctl )   THEN
111         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
112                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
113      END IF
114      !
115   END SUBROUTINE trc_adv
116
117
118   SUBROUTINE trc_adv_ctl
119      !!---------------------------------------------------------------------
120      !!                  ***  ROUTINE trc_adv_ctl  ***
121      !!               
122      !! ** Purpose : Control the consistency between namelist options for
123      !!              passive tracer advection schemes and set nadv
124      !!----------------------------------------------------------------------
125      INTEGER ::   ioptio
126      !!----------------------------------------------------------------------
127
128      ioptio = 0                      ! Parameter control
129      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
130      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
131      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
132      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
133      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
134      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
135      IF( lk_esopa         )   ioptio =          1
136
137      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
138
139      IF( n_cla == 1 .AND. .NOT. ln_trcadv_cen2 )   &
140         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
141
142      !                              ! Set nadv
143      IF( ln_trcadv_cen2   )   nadv =  1
144      IF( ln_trcadv_tvd    )   nadv =  2
145      IF( ln_trcadv_muscl  )   nadv =  3
146      IF( ln_trcadv_muscl2 )   nadv =  4
147      IF( ln_trcadv_ubs    )   nadv =  5
148      IF( ln_trcadv_qck    )   nadv =  6
149      IF( lk_esopa         )   nadv = -1
150
151      IF(lwp) THEN                   ! Print the choice
152         WRITE(numout,*)
153         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
154         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
155         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
156         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
157         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
158         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
159         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
160      ENDIF
161      !
162   END SUBROUTINE trc_adv_ctl
163#else
164   !!----------------------------------------------------------------------
165   !!   Default option                                         Empty module
166   !!----------------------------------------------------------------------
167CONTAINS
168   SUBROUTINE trc_adv( kt )
169      INTEGER, INTENT(in) :: kt
170      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
171   END SUBROUTINE trc_adv
172#endif
173  !!======================================================================
174END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.