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/2015/dev_r5721_CNRS9_NOC3_LDF/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2015/dev_r5721_CNRS9_NOC3_LDF/NEMOGCM/NEMO/TOP_SRC/TRP/trcadv.F90 @ 5766

Last change on this file since 5766 was 5766, checked in by cetlod, 9 years ago

LDF: phasing the improvements/simplifications of TOP component
  • Property svn:keywords set to Id
File size: 11.0 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_ini  : 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 traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
19   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
20   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
21   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
22   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
23   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
24   USE traadv_mle      ! ML eddy induced velocity  (tra_adv_mle    routine)
25   USE ldftra          ! lateral diffusion coefficient on tracers
26   USE prtctl_trc      ! Print control
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   trc_adv       
32   PUBLIC   trc_adv_alloc 
33   PUBLIC   trc_adv_ini 
34
35   !                                        !!: ** Advection (namtrc_adv) **
36   LOGICAL , PUBLIC ::   ln_trcadv_cen2      ! 2nd order centered scheme flag
37   LOGICAL , PUBLIC ::   ln_trcadv_tvd       ! TVD scheme flag
38   LOGICAL , PUBLIC ::   ln_trcadv_muscl     ! MUSCL scheme flag
39   LOGICAL , PUBLIC ::   ln_trcadv_muscl2    ! MUSCL2 scheme flag
40   LOGICAL , PUBLIC ::   ln_trcadv_ubs       ! UBS scheme flag
41   LOGICAL , PUBLIC ::   ln_trcadv_qck       ! QUICKEST scheme flag
42   LOGICAL , PUBLIC ::   ln_trcadv_msc_ups   ! use upstream scheme within muscl
43
44   INTEGER ::   nadv   ! choice of the type of advection scheme
45   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt  ! vertical profile time-step, = 2 rdttra
46   !                                                    ! except at nitrrc000 (=rdttra) if neuler=0
47
48   !! * Substitutions
49#  include "domzgr_substitute.h90"
50#  include "vectopt_loop_substitute.h90"
51   !!----------------------------------------------------------------------
52   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
53   !! $Id$
54   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
55   !!----------------------------------------------------------------------
56CONTAINS
57
58   INTEGER FUNCTION trc_adv_alloc()
59      !!----------------------------------------------------------------------
60      !!                  ***  ROUTINE trc_adv_alloc  ***
61      !!----------------------------------------------------------------------
62
63      ALLOCATE( r2dt(jpk), STAT=trc_adv_alloc )
64
65      IF( trc_adv_alloc /= 0 ) CALL ctl_warn('trc_adv_alloc : failed to allocate array.')
66
67   END FUNCTION trc_adv_alloc
68
69
70   SUBROUTINE trc_adv( kt )
71      !!----------------------------------------------------------------------
72      !!                  ***  ROUTINE trc_adv  ***
73      !!
74      !! ** Purpose :   compute the ocean tracer advection trend.
75      !!
76      !! ** Method  : - Update the tracer with the advection term following nadv
77      !!----------------------------------------------------------------------
78      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
79      !
80      INTEGER ::   jk 
81      CHARACTER (len=22) ::   charout
82      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn  ! effective velocity
83      !!----------------------------------------------------------------------
84      !
85      IF( nn_timing == 1 )   CALL timing_start('trc_adv')
86      !
87      CALL wrk_alloc( jpi,jpj,jpk,   zun, zvn, zwn )
88      !
89      IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN     ! at nittrc000
90         r2dt(:) =  rdttrc(:)           ! = rdttrc (use or restarting with Euler time stepping)
91      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nittrc000 or nittrc000+1
92         r2dt(:) = 2. * rdttrc(:)       ! = 2 rdttrc (leapfrog)
93      ENDIF
94      !                                               !==  effective transport  ==!
95      zun(:,:,jpk) = 0._wp                                                       ! no transport trough the bottom
96      zvn(:,:,jpk) = 0._wp
97      zwn(:,:,jpk) = 0._wp
98      DO jk = 1, jpkm1
99         zun(:,:,jk) = e2u  (:,:) * fse3u(:,:,jk) * un(:,:,jk)                   ! eulerian transport
100         zvn(:,:,jk) = e1v  (:,:) * fse3v(:,:,jk) * vn(:,:,jk)
101         zwn(:,:,jk) = e1e2t(:,:)                 * wn(:,:,jk)
102      END DO
103      !
104      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN                                 ! add z-tilde and/or vvl corrections
105         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
106         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
107      ENDIF
108      !
109      IF( ln_ldfeiv .AND. .NOT. ln_traldf_triad )   & 
110         &              CALL ldf_eiv_trp( kt, nittrc000, zun, zvn, zwn, 'TRC' )  ! add the eiv transport
111      !
112      IF( ln_mle    )   CALL tra_adv_mle( kt, nittrc000, zun, zvn, zwn, 'TRC' )  ! add the mle transport
113      !
114      !
115      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
116      !
117      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, nittrc000, 'TRC',       zun, zvn, zwn, trb, trn, tra, jptra )   !  2nd order centered
118      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  TVD
119      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb,      tra, jptra, ln_trcadv_msc_ups )   !  MUSCL
120      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  MUSCL2
121      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  UBS
122      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, nittrc000, 'TRC', r2dt, zun, zvn, zwn, trb, trn, tra, jptra )   !  QUICKEST
123      !
124      END SELECT
125      !                 
126      IF( ln_ctl )   THEN                             !== print mean trends (used for debugging)
127         WRITE(charout, FMT="('adv ')")  ;  CALL prt_ctl_trc_info(charout)
128                                            CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
129      END IF
130      !
131      CALL wrk_dealloc( jpi,jpj,jpk,   zun, zvn, zwn )
132      !
133      IF( nn_timing == 1 )  CALL timing_stop('trc_adv')
134      !
135   END SUBROUTINE trc_adv
136
137
138   SUBROUTINE trc_adv_ini
139      !!---------------------------------------------------------------------
140      !!                  ***  ROUTINE trc_adv_ini  ***
141      !!               
142      !! ** Purpose : Control the consistency between namelist options for
143      !!              passive tracer advection schemes and set nadv
144      !!----------------------------------------------------------------------
145      INTEGER ::   ioptio
146      INTEGER ::  ios                 ! Local integer output status for namelist read
147      !!
148      NAMELIST/namtrc_adv/ ln_trcadv_cen2 , ln_trcadv_tvd   ,    &
149         &                 ln_trcadv_muscl, ln_trcadv_muscl2,    &
150         &                 ln_trcadv_ubs  , ln_trcadv_qck, ln_trcadv_msc_ups
151      !!----------------------------------------------------------------------
152      !
153      REWIND( numnat_ref )              !  namtrc_adv in reference namelist
154      READ  ( numnat_ref, namtrc_adv, IOSTAT = ios, ERR = 901)
155901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in reference namelist', lwp )
156
157      REWIND( numnat_cfg )              ! namtrc_adv in configuration namelist
158      READ  ( numnat_cfg, namtrc_adv, IOSTAT = ios, ERR = 902 )
159902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_adv in configuration namelist', lwp )
160      IF(lwm) WRITE ( numont, namtrc_adv )
161
162      IF(lwp) THEN                    ! Namelist print
163         WRITE(numout,*)
164         WRITE(numout,*) 'trc_adv_ini : choice/control of the tracer advection scheme'
165         WRITE(numout,*) '~~~~~~~~~~~'
166         WRITE(numout,*) '   Namelist namtrc_adv : chose a advection scheme for tracers'
167         WRITE(numout,*) '      2nd order advection scheme     ln_trcadv_cen2   = ', ln_trcadv_cen2
168         WRITE(numout,*) '      TVD advection scheme           ln_trcadv_tvd    = ', ln_trcadv_tvd
169         WRITE(numout,*) '      MUSCL  advection scheme        ln_trcadv_muscl  = ', ln_trcadv_muscl
170         WRITE(numout,*) '      MUSCL2 advection scheme        ln_trcadv_muscl2 = ', ln_trcadv_muscl2
171         WRITE(numout,*) '      UBS    advection scheme        ln_trcadv_ubs    = ', ln_trcadv_ubs
172         WRITE(numout,*) '      QUICKEST advection scheme      ln_trcadv_qck    = ', ln_trcadv_qck
173      ENDIF
174      !
175
176      ioptio = 0                      ! Parameter control
177      IF( ln_trcadv_cen2   )   ioptio = ioptio + 1
178      IF( ln_trcadv_tvd    )   ioptio = ioptio + 1
179      IF( ln_trcadv_muscl  )   ioptio = ioptio + 1
180      IF( ln_trcadv_muscl2 )   ioptio = ioptio + 1
181      IF( ln_trcadv_ubs    )   ioptio = ioptio + 1
182      IF( ln_trcadv_qck    )   ioptio = ioptio + 1
183      !
184      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtrc_adv' )
185      !
186      !                              ! Set nadv
187      IF( ln_trcadv_cen2   )   nadv =  1
188      IF( ln_trcadv_tvd    )   nadv =  2
189      IF( ln_trcadv_muscl  )   nadv =  3
190      IF( ln_trcadv_muscl2 )   nadv =  4
191      IF( ln_trcadv_ubs    )   nadv =  5
192      IF( ln_trcadv_qck    )   nadv =  6
193      !
194      IF(lwp) THEN                   ! Print the choice
195         WRITE(numout,*)
196         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
197         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
198         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
199         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
200         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
201         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
202      ENDIF
203      !
204   END SUBROUTINE trc_adv_ini
205   
206#else
207   !!----------------------------------------------------------------------
208   !!   Default option                                         Empty module
209   !!----------------------------------------------------------------------
210CONTAINS
211   SUBROUTINE trc_adv( kt )
212      INTEGER, INTENT(in) :: kt
213      WRITE(*,*) 'trc_adv: You should not have seen this print! error?', kt
214   END SUBROUTINE trc_adv
215#endif
216
217  !!======================================================================
218END MODULE trcadv
Note: See TracBrowser for help on using the repository browser.