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/2011/dev_NOC_2011_MERGE/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2011/dev_NOC_2011_MERGE/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 2980

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

Branch dev_NOC_2011_MERGE. #874. Step 2: Add changes from the 2011/dev_r2782_NOCS_Griffies branch
  • Property svn:keywords set to Id
File size: 10.6 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   !!   trc_adv      : compute ocean tracer advection trend
14   !!   trc_adv_ctl  : control the different options of advection scheme
15   !!----------------------------------------------------------------------
16   USE oce_trc         ! ocean dynamics and active tracers
17   USE trc             ! ocean passive tracers variables
18   USE trcnam_trp      ! passive tracers transport namelist variables
19   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
20   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
21   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
22   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
23   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
24   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
25   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
26   USE ldftra_oce      ! lateral diffusion coefficient on tracers
27   USE prtctl_trc      ! Print control
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   trc_adv          ! routine called by step module
33   PUBLIC   trc_adv_alloc    ! routine called by nemogcm module
34
35   INTEGER ::   nadv   ! choice of the type of advection scheme
36   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt  ! vertical profile time-step, = 2 rdttra
37   !                                                    ! except at nit000 (=rdttra) if neuler=0
38
39   !! * Substitutions
40#  include "domzgr_substitute.h90"
41#  include "vectopt_loop_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
44   !! $Id$
45   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   INTEGER FUNCTION trc_adv_alloc()
50      !!----------------------------------------------------------------------
51      !!                  ***  ROUTINE trc_adv_alloc  ***
52      !!----------------------------------------------------------------------
53
54      ALLOCATE( r2dt(jpk), STAT=trc_adv_alloc )
55
56      IF( trc_adv_alloc /= 0 ) CALL ctl_warn('trc_adv_alloc : failed to allocate array.')
57
58   END FUNCTION trc_adv_alloc
59
60
61   SUBROUTINE trc_adv( kt )
62      !!----------------------------------------------------------------------
63      !!                  ***  ROUTINE trc_adv  ***
64      !!
65      !! ** Purpose :   compute the ocean tracer advection trend.
66      !!
67      !! ** Method  : - Update the tracer with the advection term following nadv
68      !!----------------------------------------------------------------------
69      USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released
70      USE wrk_nemo, ONLY: zun => wrk_3d_4, zvn => wrk_3d_5, zwn => wrk_3d_6   ! effective velocity
71      !!
72      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
73      !
74      INTEGER ::   jk 
75      CHARACTER (len=22) ::   charout
76      !!----------------------------------------------------------------------
77      !
78      IF( wrk_in_use(3, 4,5,6) ) THEN
79         CALL ctl_stop('trc_adv : requested workspace arrays unavailable')   ;   RETURN
80      ENDIF
81
82      IF( kt == nit000 )   CALL trc_adv_ctl          ! initialisation & control of options
83
84#if ! defined key_pisces
85      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
86         r2dt(:) =  rdttrc(:)           ! = rdttrc (restarting with Euler time stepping)
87      ELSEIF( kt <= nit000 + nn_dttrc ) THEN          ! at nit000 or nit000+1
88         r2dt(:) = 2. * rdttrc(:)       ! = 2 rdttrc (leapfrog)
89      ENDIF
90#else
91      r2dt(:) =  rdttrc(:)              ! = rdttrc (for PISCES use Euler time stepping)
92#endif
93
94      !                                                   ! effective transport
95      DO jk = 1, jpkm1
96         !                                                ! eulerian transport only
97         zun(:,:,jk) = e2u  (:,:) * fse3u(:,:,jk) * un(:,:,jk)
98         zvn(:,:,jk) = e1v  (:,:) * fse3v(:,:,jk) * vn(:,:,jk)
99         zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk)
100         !
101      END DO
102      zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
103
104      !                                                   ! add the eiv transport (if necessary)
105      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &
106         &              CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRC' )          ! add the eiv transport (if necessary)
107      !
108      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
109      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
110      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
111      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )   !  MUSCL
112      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
113      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
114      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
115      !
116      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
117         CALL tra_adv_cen2  ( kt, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )         
118         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
119                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
120         CALL tra_adv_tvd   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
121         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
122                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
123         CALL tra_adv_muscl ( kt, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )         
124         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
125                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
126         CALL tra_adv_muscl2( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
127         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
128                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
129         CALL tra_adv_ubs   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
130         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
131                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
132         CALL tra_adv_qck   ( kt, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
133         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
134                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
135         !
136      END SELECT
137
138      !                                              ! print mean trends (used for debugging)
139      IF( ln_ctl )   THEN
140         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
141                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
142      END IF
143      !
144      IF( wrk_not_released(3, 4,5,6) ) CALL ctl_stop('trc_adv : failed to release workspace arrays.')
145      !
146   END SUBROUTINE trc_adv
147
148
149   SUBROUTINE trc_adv_ctl
150      !!---------------------------------------------------------------------
151      !!                  ***  ROUTINE trc_adv_ctl  ***
152      !!               
153      !! ** Purpose : Control the consistency between namelist options for
154      !!              passive tracer advection schemes and set nadv
155      !!----------------------------------------------------------------------
156      INTEGER ::   ioptio
157      !!----------------------------------------------------------------------
158
159      ioptio = 0                      ! Parameter control
160      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
161      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
162      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
163      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
164      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
165      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
166      IF( lk_esopa         )   ioptio =          1
167
168      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
169
170      !                              ! Set nadv
171      IF( ln_trcadv_cen2   )   nadv =  1
172      IF( ln_trcadv_tvd    )   nadv =  2
173      IF( ln_trcadv_muscl  )   nadv =  3
174      IF( ln_trcadv_muscl2 )   nadv =  4
175      IF( ln_trcadv_ubs    )   nadv =  5
176      IF( ln_trcadv_qck    )   nadv =  6
177      IF( lk_esopa         )   nadv = -1
178
179      IF(lwp) THEN                   ! Print the choice
180         WRITE(numout,*)
181         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
182         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
183         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
184         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
185         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
186         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
187         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
188      ENDIF
189      !
190   END SUBROUTINE trc_adv_ctl
191   
192#else
193   !!----------------------------------------------------------------------
194   !!   Default option                                         Empty module
195   !!----------------------------------------------------------------------
196CONTAINS
197   SUBROUTINE trc_adv( kt )
198      INTEGER, INTENT(in) :: kt
199      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
200   END SUBROUTINE trc_adv
201#endif
202
203  !!======================================================================
204END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.