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.
traadv.F90 in branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/TRA/traadv.F90 @ 2633

Last change on this file since 2633 was 2633, checked in by trackstand2, 13 years ago

Renamed wrk_use => wrk_in_use and wrk_release => wrk_not_released
  • Property svn:keywords set to Id
File size: 11.6 KB
Line 
1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
6   !! History :  2.0  !  2005-11  (G. Madec)  Original code
7   !!            3.3  !  2010-09  (C. Ethe, G. Madec)  merge TRC-TRA + switch from velocity to transport
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   tra_adv      : compute ocean tracer advection trend
12   !!   tra_adv_ctl  : control the different options of advection scheme
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and active tracers
15   USE dom_oce         ! ocean space and time domain
16   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
17   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
18   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
19   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
20   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
21   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
22   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
23   USE cla             ! cross land advection      (cla_traadv     routine)
24   USE ldftra_oce      ! lateral diffusion coefficient on tracers
25   USE in_out_manager  ! I/O manager
26   USE prtctl          ! Print control
27   USE iom
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   tra_adv        ! routine called by step module
33   PUBLIC   tra_adv_init   ! routine called by opa module
34
35   !                                        !!* Namelist namtra_adv *
36   LOGICAL ::   ln_traadv_cen2   = .TRUE.    ! 2nd order centered scheme flag
37   LOGICAL ::   ln_traadv_tvd    = .FALSE.   ! TVD scheme flag
38   LOGICAL ::   ln_traadv_muscl  = .FALSE.   ! MUSCL scheme flag
39   LOGICAL ::   ln_traadv_muscl2 = .FALSE.   ! MUSCL2 scheme flag
40   LOGICAL ::   ln_traadv_ubs    = .FALSE.   ! UBS scheme flag
41   LOGICAL ::   ln_traadv_qck    = .FALSE.   ! QUICKEST scheme flag
42
43   INTEGER ::   nadv   ! choice of the type of advection scheme
44
45   !! * Substitutions
46#  include "domzgr_substitute.h90"
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE tra_adv( kt )
56      !!----------------------------------------------------------------------
57      !!                  ***  ROUTINE tra_adv  ***
58      !!
59      !! ** Purpose :   compute the ocean tracer advection trend.
60      !!
61      !! ** Method  : - Update (ua,va) with the advection term following nadv
62      !!----------------------------------------------------------------------
63      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
64      USE wrk_nemo, ONLY:   zun => wrk_3d_1, zvn => wrk_3d_2, zwn => wrk_3d_3   ! 3D workspace
65      !
66      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
67      !
68      INTEGER ::   jk   ! dummy loop index
69      !!----------------------------------------------------------------------
70      !
71      IF(wrk_in_use(3, 1,2,3) ) THEN
72         CALL ctl_stop('tra_adv: requested workspace arrays unavailable')   ;   RETURN
73      END IF
74      !                                          ! set time step
75      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
76         r2dtra(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
77      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
78         r2dtra(:) = 2._wp * rdttra(:)                   ! = 2 rdttra (leapfrog)
79      ENDIF
80      !
81      IF( nn_cla == 1 )   CALL cla_traadv( kt )       !==  Cross Land Advection  ==! (hor. advection)
82      !
83      !                                               !==  effective transport  ==!
84      DO jk = 1, jpkm1
85         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)                  ! eulerian transport only
86         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
87         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
88      END DO
89      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
90      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
91      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
92      !
93      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &
94         &              CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRA' )          ! add the eiv transport (if necessary)
95      !
96      CALL iom_put( "uocetr_eff", zun )                                         ! output effective transport     
97      CALL iom_put( "vocetr_eff", zvn )
98      CALL iom_put( "wocetr_eff", zwn )
99
100      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
101      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  2nd order centered
102      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD
103      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts )   !  MUSCL
104      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  MUSCL2
105      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  UBS
106      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  QUICKEST
107      !
108      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
109         CALL tra_adv_cen2  ( kt, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )         
110         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv0 - Ta: ', mask1=tmask,               &
111            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
112         CALL tra_adv_tvd   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
113         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv1 - Ta: ', mask1=tmask,               &
114            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
115         CALL tra_adv_muscl ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts )         
116         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv3 - Ta: ', mask1=tmask,               &
117            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
118         CALL tra_adv_muscl2( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
119         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv4 - Ta: ', mask1=tmask,               &
120            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
121         CALL tra_adv_ubs   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
122         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv5 - Ta: ', mask1=tmask,               &
123            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
124         CALL tra_adv_qck   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
125         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv6 - Ta: ', mask1=tmask,               &
126            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
127      END SELECT
128      !
129      !                                              ! print mean trends (used for debugging)
130      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv  - Ta: ', mask1=tmask,               &
131         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
132      !
133      IF(wrk_not_released(3,1,2,3) )   CALL ctl_stop('tra_adv: failed to release workspace arrays')
134      !
135   END SUBROUTINE tra_adv
136
137
138   SUBROUTINE tra_adv_init
139      !!---------------------------------------------------------------------
140      !!                  ***  ROUTINE tra_adv_init  ***
141      !!               
142      !! ** Purpose :   Control the consistency between namelist options for
143      !!              tracer advection schemes and set nadv
144      !!----------------------------------------------------------------------
145      INTEGER ::   ioptio
146      !!
147      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,     &
148         &                 ln_traadv_muscl, ln_traadv_muscl2,  &
149         &                 ln_traadv_ubs  , ln_traadv_qck
150      !!----------------------------------------------------------------------
151
152      REWIND( numnam )                ! Read Namelist namtra_adv : tracer advection scheme
153      READ  ( numnam, namtra_adv )
154
155      IF(lwp) THEN                    ! Namelist print
156         WRITE(numout,*)
157         WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme'
158         WRITE(numout,*) '~~~~~~~~~~~'
159         WRITE(numout,*) '   Namelist namtra_adv : chose a advection scheme for tracers'
160         WRITE(numout,*) '      2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
161         WRITE(numout,*) '      TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
162         WRITE(numout,*) '      MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
163         WRITE(numout,*) '      MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
164         WRITE(numout,*) '      UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
165         WRITE(numout,*) '      QUICKEST advection scheme      ln_traadv_qck    = ', ln_traadv_qck
166      ENDIF
167
168      ioptio = 0                      ! Parameter control
169      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
170      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
171      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
172      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
173      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
174      IF( ln_traadv_qck    )   ioptio = ioptio + 1
175      IF( lk_esopa         )   ioptio =          1
176
177      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
178
179      !                              ! Set nadv
180      IF( ln_traadv_cen2   )   nadv =  1
181      IF( ln_traadv_tvd    )   nadv =  2
182      IF( ln_traadv_muscl  )   nadv =  3
183      IF( ln_traadv_muscl2 )   nadv =  4
184      IF( ln_traadv_ubs    )   nadv =  5
185      IF( ln_traadv_qck    )   nadv =  6
186      IF( lk_esopa         )   nadv = -1
187
188      IF(lwp) THEN                   ! Print the choice
189         WRITE(numout,*)
190         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
191         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
192         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
193         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
194         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
195         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
196         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
197      ENDIF
198      !
199   END SUBROUTINE tra_adv_init
200
201  !!======================================================================
202END MODULE traadv
Note: See TracBrowser for help on using the repository browser.