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 @ 2696

Last change on this file since 2696 was 2690, checked in by gm, 13 years ago

dynamic mem: #785 ; homogeneization of the coding style associated with dyn allocation

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