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/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 5 years ago

The Dr Hook changes from my perl code.
File size: 13.2 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 traadv_mle      ! ML eddy induced velocity  (tra_adv_mle    routine)
27   USE ldftra_oce      ! lateral diffusion coefficient on tracers
28   USE trd_oce
29   USE trdtra
30   USE prtctl_trc      ! Print control
31
32   USE yomhook, ONLY: lhook, dr_hook
33   USE parkind1, ONLY: jprb, jpim
34
35   IMPLICIT NONE
36   PRIVATE
37
38   PUBLIC   trc_adv          ! routine called by step module
39   PUBLIC   trc_adv_alloc    ! routine called by nemogcm module
40
41   INTEGER ::   nadv   ! choice of the type of advection scheme
42   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt  ! vertical profile time-step, = 2 rdttra
43   !                                                    ! except at nitrrc000 (=rdttra) if neuler=0
44
45   !! * Substitutions
46#  include "domzgr_substitute.h90"
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
50   !! $Id$
51   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   INTEGER FUNCTION trc_adv_alloc()
56   INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
57   INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
58   REAL(KIND=jprb)               :: zhook_handle
59
60   CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_ADV_ALLOC'
61
62   IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
63
64      !!----------------------------------------------------------------------
65      !!                  ***  ROUTINE trc_adv_alloc  ***
66      !!----------------------------------------------------------------------
67
68      ALLOCATE( r2dt(jpk), STAT=trc_adv_alloc )
69
70      IF( trc_adv_alloc /= 0 ) CALL ctl_warn('trc_adv_alloc : failed to allocate array.')
71
72   IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
73   END FUNCTION trc_adv_alloc
74
75
76   SUBROUTINE trc_adv( kt )
77      !!----------------------------------------------------------------------
78      !!                  ***  ROUTINE trc_adv  ***
79      !!
80      !! ** Purpose :   compute the ocean tracer advection trend.
81      !!
82      !! ** Method  : - Update the tracer with the advection term following nadv
83      !!----------------------------------------------------------------------
84      !!
85      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
86      !
87      INTEGER ::   jk, jn 
88      CHARACTER (len=22) ::   charout
89      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn  ! effective velocity
90      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   ztrtrd
91      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
92      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
93      REAL(KIND=jprb)               :: zhook_handle
94
95      CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_ADV'
96
97      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
98
99      !!----------------------------------------------------------------------
100      !
101      IF( nn_timing == 1 )  CALL timing_start('trc_adv')
102      !
103      CALL wrk_alloc( jpi, jpj, jpk, zun, zvn, zwn )
104      !
105
106      IF( kt == nittrc000 )   CALL trc_adv_ctl          ! initialisation & control of options
107
108      IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN     ! at nittrc000
109         r2dt(:) =  rdttrc(:)           ! = rdttrc (use or restarting with Euler time stepping)
110      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nittrc000 or nittrc000+1
111         r2dt(:) = 2. * rdttrc(:)       ! = 2 rdttrc (leapfrog)
112      ENDIF
113      !                                                   ! effective transport
114      DO jk = 1, jpkm1
115         !                                                ! eulerian transport only
116         zun(:,:,jk) = e2u  (:,:) * fse3u(:,:,jk) * un(:,:,jk)
117         zvn(:,:,jk) = e1v  (:,:) * fse3v(:,:,jk) * vn(:,:,jk)
118         zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk)
119         !
120      END DO
121      !
122      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
123         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
124         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
125      ENDIF
126      !
127      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
128      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
129      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
130
131      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &  ! add the eiv transport (if necessary)
132         &              CALL tra_adv_eiv( kt, nittrc000, zun, zvn, zwn, 'TRC' )
133      !
134      IF( ln_mle    )   CALL tra_adv_mle( kt, nittrc000, zun, zvn, zwn, 'TRC' )    ! add the mle transport (if necessary)
135      !
136      IF( l_trdtrc )  THEN
137         CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrtrd )
138         ztrtrd(:,:,:,:)  = tra(:,:,:,:)
139      ENDIF
140      !
141      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
142      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
143      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
144      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra, ln_trcadv_msc_ups )   !  MUSCL
145      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
146      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
147      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
148      !
149      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
150         CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )         
151         WRITE(charout, FMT="('adv1')")  ; CALL prt_ctl_trc_info(charout)
152                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
153         CALL tra_adv_tvd   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
154         WRITE(charout, FMT="('adv2')")  ; CALL prt_ctl_trc_info(charout)
155                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
156         CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra, ln_trcadv_msc_ups  )         
157         WRITE(charout, FMT="('adv3')")  ; CALL prt_ctl_trc_info(charout)
158                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
159         CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
160         WRITE(charout, FMT="('adv4')")  ; CALL prt_ctl_trc_info(charout)
161                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
162         CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
163         WRITE(charout, FMT="('adv5')")  ; CALL prt_ctl_trc_info(charout)
164                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
165         CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )         
166         WRITE(charout, FMT="('adv6')")  ; CALL prt_ctl_trc_info(charout)
167                                           CALL prt_ctl_trc(tab4d=tra, mask=tmask, clinfo=ctrcnm,clinfo2='trd')
168         !
169      END SELECT
170      !
171      IF( l_trdtrc )   THEN                      ! save the advective trends for further diagnostics
172        DO jn = 1, jptra
173           ztrtrd(:,:,:,jn) = tra(:,:,:,jn) - ztrtrd(:,:,:,jn)
174           CALL trd_tra( kt, 'TRC', jn, jptra_totad, ztrtrd(:,:,:,jn) )
175        END DO
176        CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrtrd )
177      ENDIF
178
179      !                                              ! print mean trends (used for debugging)
180      IF( ln_ctl )   THEN
181         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
182                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
183      END IF
184      !
185      CALL wrk_dealloc( jpi, jpj, jpk, zun, zvn, zwn )
186      !
187      IF( nn_timing == 1 )  CALL timing_stop('trc_adv')
188      !
189      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
190   END SUBROUTINE trc_adv
191
192
193   SUBROUTINE trc_adv_ctl
194      !!---------------------------------------------------------------------
195      !!                  ***  ROUTINE trc_adv_ctl  ***
196      !!               
197      !! ** Purpose : Control the consistency between namelist options for
198      !!              passive tracer advection schemes and set nadv
199      !!----------------------------------------------------------------------
200      INTEGER ::   ioptio
201      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
202      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
203      REAL(KIND=jprb)               :: zhook_handle
204
205      CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_ADV_CTL'
206
207      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
208
209      !!----------------------------------------------------------------------
210
211      ioptio = 0                      ! Parameter control
212      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
213      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
214      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
215      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
216      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
217      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
218      IF( lk_esopa         )   ioptio =          1
219
220      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
221
222      !                              ! Set nadv
223      IF( ln_trcadv_cen2   )   nadv =  1
224      IF( ln_trcadv_tvd    )   nadv =  2
225      IF( ln_trcadv_muscl  )   nadv =  3
226      IF( ln_trcadv_muscl2 )   nadv =  4
227      IF( ln_trcadv_ubs    )   nadv =  5
228      IF( ln_trcadv_qck    )   nadv =  6
229      IF( lk_esopa         )   nadv = -1
230
231      IF(lwp) THEN                   ! Print the choice
232         WRITE(numout,*)
233         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
234         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
235         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
236         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
237         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
238         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
239         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
240      ENDIF
241      !
242      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
243   END SUBROUTINE trc_adv_ctl
244   
245#else
246   !!----------------------------------------------------------------------
247   !!   Default option                                         Empty module
248   !!----------------------------------------------------------------------
249CONTAINS
250   SUBROUTINE trc_adv( kt )
251      INTEGER, INTENT(in) :: kt
252      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
253      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
254      REAL(KIND=jprb)               :: zhook_handle
255
256      CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_ADV'
257
258      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
259
260      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
261      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
262   END SUBROUTINE trc_adv
263#endif
264
265  !!======================================================================
266END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.