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_crs.F90 in branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv_crs.F90 @ 6101

Last change on this file since 6101 was 5105, checked in by cbricaud, 9 years ago

bug correction
  • Property svn:executable set to *
File size: 11.6 KB
Line 
1MODULE trcadv_crs
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 oce_trc, ONLY: un,vn,wn
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_crs  ! 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 prtctl_trc      ! Print control
29   USE crs , ONLY : e2e3u_msk , e1e3v_msk , e1e2w_msk,jpi_crs,jpj_crs
30   USE timing
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   trc_adv_crs          ! routine called by step module
36   PUBLIC   trc_adv_alloc_crs   ! routine called by nemogcm module
37
38   INTEGER ::   nadv   ! choice of the type of advection scheme
39   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt  ! vertical profile time-step, = 2 rdttra
40   !                                                    ! except at nitrrc000 (=rdttra) if neuler=0
41
42   !! * Substitutions
43#  include "domzgr_substitute.h90"
44#  include "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
47   !! $Id: trcadv.F90 3294 2012-01-28 16:44:18Z rblod $
48   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   INTEGER FUNCTION trc_adv_alloc_crs()
53      !!----------------------------------------------------------------------
54      !!                  ***  ROUTINE trc_adv_alloc  ***
55      !!----------------------------------------------------------------------
56
57      ALLOCATE( r2dt(jpk), STAT=trc_adv_alloc_crs )
58
59      IF( trc_adv_alloc_crs /= 0 ) CALL ctl_warn('trc_adv_alloc : failed to allocate array.')
60
61   END FUNCTION trc_adv_alloc_crs
62
63
64   SUBROUTINE trc_adv_crs( kt )
65      !!----------------------------------------------------------------------
66      !!                  ***  ROUTINE trc_adv  ***
67      !!
68      !! ** Purpose :   compute the ocean tracer advection trend.
69      !!
70      !! ** Method  : - Update the tracer with the advection term following nadv
71      !!----------------------------------------------------------------------
72      !!
73      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
74      !
75      INTEGER ::   jk 
76      INTEGER ::   ji,jj
77      CHARACTER (len=22) ::   charout
78      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn  ! effective velocity
79      !!----------------------------------------------------------------------
80      !
81     
82      IF( nn_timing == 1 )  CALL timing_start('trc_adv')
83      !
84      CALL wrk_alloc( jpi, jpj, jpk, zun, zvn, zwn )
85      !
86
87      IF( kt == nittrc000 )   CALL trc_adv_ctl_crs          ! initialisation & control of options
88
89#if ! defined key_pisces
90      IF( neuler == 0 .AND. kt == nittrc000 ) THEN     ! at nittrc000
91         r2dt(:) =  rdttrc(:)           ! = rdttrc (restarting with Euler time stepping)
92      ELSEIF( kt <= nittrc000 + 1 ) THEN          ! at nittrc000 or nittrc000+1
93         r2dt(:) = 2. * rdttrc(:)       ! = 2 rdttrc (leapfrog)
94      ENDIF
95#else
96      r2dt(:) =  rdttrc(:)              ! = rdttrc (for PISCES use Euler time stepping)
97#endif
98
99  !    IF(lwp) WRITE(numout,*) 'TEST', e1e2t
100      !                                                   ! effective transport
101!         IF(lwp) WRITE(numout,*) 'un', maxval(un(:,:,:))
102!         IF(lwp) WRITE(numout,*) 'un', minval(un(:,:,:))
103!         IF(lwp) WRITE(numout,*) 'vn', maxval(vn(:,:,:))
104!         IF(lwp) WRITE(numout,*) 'vn', minval(vn(:,:,:))
105!         IF(lwp) WRITE(numout,*) 'wn', maxval(wn(:,:,:))
106!         IF(lwp) WRITE(numout,*) 'wn', minval(wn(:,:,:))
107      DO jk = 1, jpkm1
108         !                                                ! eulerian transport only
109         zun(:,:,jk) = e2e3u_msk(:,:,jk) * un(:,:,jk)
110         zvn(:,:,jk) = e1e3v_msk(:,:,jk) * vn(:,:,jk)
111         zwn(:,:,jk) = e1e2w_msk(:,:,jk) * wn(:,:,jk)
112         !
113      END DO
114
115         IF(lwp)WRITE(numout,*)"jpi_crs jpj_crs jpk ",jpi_crs,jpj_crs,jpk
116         DO jk=1,jpk
117           DO jj = 1, jpj_crs
118               DO ji = 1, jpi_crs
119                  IF( zwn(ji,jj,jk) .NE. zwn(ji,jj,jk) )WRITE(narea+200,*)"trcadv_zwn",zwn(ji,jj,jk) ; call flush(narea+200)
120               END DO
121            END DO
122         END DO
123
124
125      zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
126
127      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &  ! add the eiv transport (if necessary)
128         &              CALL tra_adv_eiv( kt, nittrc000, zun, zvn, zwn, 'TRC' )
129      !
130      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
131!cbr      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
132      CASE ( 2 )   ;    CALL tra_adv_tvd_crs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
133!cbr      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )   !  MUSCL
134!cbr      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
135!cbr      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
136!cbr      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
137      !
138      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
139!         CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )         
140!         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
141!                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
142         CALL tra_adv_tvd_crs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
143         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
144                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
145!         CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra )         
146!         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
147!                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
148!         CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
149!         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
150!                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
151!         CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
152!         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
153!                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
154!         CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
155!         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
156                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
157         !
158      END SELECT
159
160      !                                              ! print mean trends (used for debugging)
161      IF( ln_ctl )   THEN
162         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
163                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
164      END IF
165      !
166      CALL wrk_dealloc( jpi, jpj, jpk, zun, zvn, zwn )
167      !
168      IF( nn_timing == 1 )  CALL timing_stop('trc_adv')
169      !
170   END SUBROUTINE trc_adv_crs
171
172
173   SUBROUTINE trc_adv_ctl_crs
174      !!---------------------------------------------------------------------
175      !!                  ***  ROUTINE trc_adv_ctl  ***
176      !!               
177      !! ** Purpose : Control the consistency between namelist options for
178      !!              passive tracer advection schemes and set nadv
179      !!----------------------------------------------------------------------
180      INTEGER ::   ioptio
181      !!----------------------------------------------------------------------
182
183      ioptio = 0                      ! Parameter control
184      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
185      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
186      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
187      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
188      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
189      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
190      IF( lk_esopa         )   ioptio =          1
191
192      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
193
194      !                              ! Set nadv
195      IF( ln_trcadv_cen2   )   nadv =  1
196      IF( ln_trcadv_tvd    )   nadv =  2
197      IF( ln_trcadv_muscl  )   nadv =  3
198      IF( ln_trcadv_muscl2 )   nadv =  4
199      IF( ln_trcadv_ubs    )   nadv =  5
200      IF( ln_trcadv_qck    )   nadv =  6
201      IF( lk_esopa         )   nadv = -1
202
203      IF(lwp) THEN                   ! Print the choice
204         WRITE(numout,*)
205         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
206         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
207         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
208         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
209         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
210         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
211         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
212      ENDIF
213      !
214   END SUBROUTINE trc_adv_ctl_crs
215   
216#else
217   !!----------------------------------------------------------------------
218   !!   Default option                                         Empty module
219   !!----------------------------------------------------------------------
220CONTAINS
221   SUBROUTINE trc_adv_crs( kt )
222      INTEGER, INTENT(in) :: kt
223      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
224   END SUBROUTINE trc_adv_crs
225#endif
226
227  !!======================================================================
228END MODULE trcadv_crs
Note: See TracBrowser for help on using the repository browser.