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

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

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