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.
tranxt.F90 in branches/2011/UKMO_MERCATOR_obc_bdy_merge/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/2011/UKMO_MERCATOR_obc_bdy_merge/NEMOGCM/NEMO/OPA_SRC/TRA/tranxt.F90 @ 2797

Last change on this file since 2797 was 2797, checked in by davestorkey, 13 years ago

Delete BDY module and first implementation of new OBC module.

  1. Initial restructuring.
  2. Use fldread to read open boundary data.
  • Property svn:keywords set to Id
File size: 16.6 KB
Line 
1MODULE tranxt
2   !!======================================================================
3   !!                       ***  MODULE  tranxt  ***
4   !! Ocean active tracers:  time stepping on temperature and salinity
5   !!======================================================================
6   !! History :  OPA  !  1991-11  (G. Madec)  Original code
7   !!            7.0  !  1993-03  (M. Guyon)  symetrical conditions
8   !!            8.0  !  1996-02  (G. Madec & M. Imbard)  opa release 8.0
9   !!             -   !  1996-04  (A. Weaver)  Euler forward step
10   !!            8.2  !  1999-02  (G. Madec, N. Grima)  semi-implicit pressure grad.
11   !!  NEMO      1.0  !  2002-08  (G. Madec)  F90: Free form and module
12   !!             -   !  2002-11  (C. Talandier, A-M Treguier) Open boundaries
13   !!             -   !  2005-04  (C. Deltel) Add Asselin trend in the ML budget
14   !!            2.0  !  2006-02  (L. Debreu, C. Mazauric) Agrif implementation
15   !!            3.0  !  2008-06  (G. Madec)  time stepping always done in trazdf
16   !!            3.1  !  2009-02  (G. Madec, R. Benshila)  re-introduce the vvl option
17   !!            3.3  !  2010-04  (M. Leclair, G. Madec)  semi-implicit hpg with asselin filter + modified LF-RA
18   !!             -   !  2010-05  (C. Ethe, G. Madec)  merge TRC-TRA
19   !!----------------------------------------------------------------------
20
21   !!----------------------------------------------------------------------
22   !!   tra_nxt       : time stepping on tracers
23   !!   tra_nxt_fix   : time stepping on tracers : fixed    volume case
24   !!   tra_nxt_vvl   : time stepping on tracers : variable volume case
25   !!----------------------------------------------------------------------
26   USE oce             ! ocean dynamics and tracers variables
27   USE dom_oce         ! ocean space and time domain variables
28   USE sbc_oce         ! surface boundary condition: ocean
29   USE zdf_oce         ! ???
30   USE domvvl          ! variable volume
31   USE dynspg_oce      ! surface     pressure gradient variables
32   USE dynhpg          ! hydrostatic pressure gradient
33   USE trdmod_oce      ! ocean space and time domain variables
34   USE trdtra          ! ocean active tracers trends
35   USE phycst
36   USE obc_oce
37   USE obctra          ! open boundary condition (obc_tra routine)
38   USE in_out_manager  ! I/O manager
39   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
40   USE prtctl          ! Print control
41   USE traqsr          ! penetrative solar radiation (needed for nksr)
42   USE traswp          ! swap array
43#if defined key_agrif
44   USE agrif_opa_update
45   USE agrif_opa_interp
46#endif
47
48   IMPLICIT NONE
49   PRIVATE
50
51   PUBLIC   tra_nxt       ! routine called by step.F90
52   PUBLIC   tra_nxt_fix   ! to be used in trcnxt
53   PUBLIC   tra_nxt_vvl   ! to be used in trcnxt
54
55   REAL(wp) ::   rbcp   ! Brown & Campana parameters for semi-implicit hpg
56
57   !! * Substitutions
58#  include "domzgr_substitute.h90"
59   !!----------------------------------------------------------------------
60   !! NEMO/OPA 3.3 , NEMO-Consortium (2010)
61   !! $Id$
62   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
63   !!----------------------------------------------------------------------
64CONTAINS
65
66   SUBROUTINE tra_nxt( kt )
67      !!----------------------------------------------------------------------
68      !!                   ***  ROUTINE tranxt  ***
69      !!
70      !! ** Purpose :   Apply the boundary condition on the after temperature 
71      !!             and salinity fields, achieved the time stepping by adding
72      !!             the Asselin filter on now fields and swapping the fields.
73      !!
74      !! ** Method  :   At this stage of the computation, ta and sa are the
75      !!             after temperature and salinity as the time stepping has
76      !!             been performed in trazdf_imp or trazdf_exp module.
77      !!
78      !!              - Apply lateral boundary conditions on (ta,sa)
79      !!             at the local domain   boundaries through lbc_lnk call,
80      !!             at the one-way open boundaries (lk_obc=T),
81      !!             at the AGRIF zoom     boundaries (lk_agrif=T)
82      !!
83      !!              - Update lateral boundary conditions on AGRIF children
84      !!             domains (lk_agrif=T)
85      !!
86      !! ** Action  : - (tb,sb) and (tn,sn) ready for the next time step
87      !!              - (ta,sa) time averaged (t,s)   (ln_dynhpg_imp = T)
88      !!----------------------------------------------------------------------
89      INTEGER, INTENT(in) ::   kt    ! ocean time-step index
90      !!
91      INTEGER  ::   jk, jn    ! dummy loop indices
92      REAL(wp) ::   zfact     ! local scalars
93      REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  ztrdt, ztrds
94      !!----------------------------------------------------------------------
95
96      IF( kt == nit000 ) THEN
97         IF(lwp) WRITE(numout,*)
98         IF(lwp) WRITE(numout,*) 'tra_nxt : achieve the time stepping by Asselin filter and array swap'
99         IF(lwp) WRITE(numout,*) '~~~~~~~'
100         !
101         rbcp = 0.25 * (1. + atfp) * (1. + atfp) * ( 1. - atfp)      ! Brown & Campana parameter for semi-implicit hpg
102      ENDIF
103
104      ! Update after tracer on domain lateral boundaries
105      !
106      CALL lbc_lnk( tsa(:,:,:,jp_tem), 'T', 1. )      ! local domain boundaries  (T-point, unchanged sign)
107      CALL lbc_lnk( tsa(:,:,:,jp_sal), 'T', 1. )
108      !
109#if defined key_obc || defined key_agrif
110      CALL tra_unswap
111#endif
112
113#if defined key_obc 
114      IF( lk_obc )   CALL obc_tra( kt )  ! OBC open boundaries
115#endif
116#if defined key_agrif
117      CALL Agrif_tra                     ! AGRIF zoom boundaries
118#endif
119
120#if defined key_obc || defined key_agrif
121      CALL tra_swap
122#endif
123 
124      ! set time step size (Euler/Leapfrog)
125      IF( neuler == 0 .AND. kt == nit000 ) THEN   ;   r2dtra(:) =     rdttra(:)      ! at nit000             (Euler)
126      ELSEIF( kt <= nit000 + 1 )           THEN   ;   r2dtra(:) = 2.* rdttra(:)      ! at nit000 or nit000+1 (Leapfrog)
127      ENDIF
128
129      ! trends computation initialisation
130      IF( l_trdtra )   THEN                    ! store now fields before applying the Asselin filter
131         ALLOCATE( ztrdt(jpi,jpj,jpk) )   ;    ztrdt(:,:,:) = tsn(:,:,:,jp_tem) 
132         ALLOCATE( ztrds(jpi,jpj,jpk) )   ;    ztrds(:,:,:) = tsn(:,:,:,jp_sal)
133      ENDIF
134
135      IF( neuler == 0 .AND. kt == nit000 ) THEN       ! Euler time-stepping at first time-step (only swap)
136         DO jn = 1, jpts
137            DO jk = 1, jpkm1
138               tsn(:,:,jk,jn) = tsa(:,:,jk,jn)   
139            END DO
140         END DO
141      ELSE                                            ! Leap-Frog + Asselin filter time stepping
142         !
143         IF( lk_vvl )  THEN   ;   CALL tra_nxt_vvl( kt, 'TRA', tsb, tsn, tsa, jpts )  ! variable volume level (vvl)     
144         ELSE                 ;   CALL tra_nxt_fix( kt, 'TRA', tsb, tsn, tsa, jpts )  ! fixed    volume level
145         ENDIF
146      ENDIF 
147      !
148#if defined key_agrif
149      ! Update tracer at AGRIF zoom boundaries
150      CALL tra_unswap
151      IF( .NOT.Agrif_Root() )    CALL Agrif_Update_Tra( kt )      ! children only
152      CALL tra_swap
153#endif     
154      !
155      ! trends computation
156      IF( l_trdtra ) THEN      ! trend of the Asselin filter (tb filtered - tb)/dt     
157         DO jk = 1, jpkm1
158            zfact = 1.e0 / r2dtra(jk)             
159            ztrdt(:,:,jk) = ( tsb(:,:,jk,jp_tem) - ztrdt(:,:,jk) ) * zfact
160            ztrds(:,:,jk) = ( tsb(:,:,jk,jp_sal) - ztrds(:,:,jk) ) * zfact
161         END DO
162         CALL trd_tra( kt, 'TRA', jp_tem, jptra_trd_atf, ztrdt )
163         CALL trd_tra( kt, 'TRA', jp_sal, jptra_trd_atf, ztrds )
164         DEALLOCATE( ztrdt )      ;     DEALLOCATE( ztrds ) 
165      END IF
166      !
167      !                        ! control print
168      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' nxt  - Tn: ', mask1=tmask,   &
169         &                       tab3d_2=tsn(:,:,:,jp_sal), clinfo2=       ' Sn: ', mask2=tmask )
170      !
171   END SUBROUTINE tra_nxt
172
173
174   SUBROUTINE tra_nxt_fix( kt, cdtype, ptb, ptn, pta, kjpt )
175      !!----------------------------------------------------------------------
176      !!                   ***  ROUTINE tra_nxt_fix  ***
177      !!
178      !! ** Purpose :   fixed volume: apply the Asselin time filter and
179      !!                swap the tracer fields.
180      !!
181      !! ** Method  : - Apply a Asselin time filter on now fields.
182      !!              - save in (ta,sa) an average over the three time levels
183      !!             which will be used to compute rdn and thus the semi-implicit
184      !!             hydrostatic pressure gradient (ln_dynhpg_imp = T)
185      !!              - swap tracer fields to prepare the next time_step.
186      !!                This can be summurized for tempearture as:
187      !!             ztm = tn + rbcp * [ta -2 tn + tb ]       ln_dynhpg_imp = T
188      !!             ztm = 0                                   otherwise
189      !!                   with rbcp=1/4 * (1-atfp^4) / (1-atfp)
190      !!             tb  = tn + atfp*[ tb - 2 tn + ta ]
191      !!             tn  = ta 
192      !!             ta  = ztm       (NB: reset to 0 after eos_bn2 call)
193      !!
194      !! ** Action  : - (tb,sb) and (tn,sn) ready for the next time step
195      !!              - (ta,sa) time averaged (t,s)   (ln_dynhpg_imp = T)
196      !!----------------------------------------------------------------------
197      INTEGER         , INTENT(in   )                               ::   kt       ! ocean time-step index
198      CHARACTER(len=3), INTENT(in   )                               ::   cdtype   ! =TRA or TRC (tracer indicator)
199      INTEGER         , INTENT(in   )                               ::   kjpt     ! number of tracers
200      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptb      ! before tracer fields
201      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptn      ! now tracer fields
202      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   pta      ! tracer trend
203      !
204      INTEGER  ::   ji, jj, jk, jn   ! dummy loop indices
205      LOGICAL  ::   ll_tra_hpg       ! local logical
206      REAL(wp) ::   ztn, ztd         ! local scalars
207      !!----------------------------------------------------------------------
208
209      IF( kt == nit000 )  THEN
210         IF(lwp) WRITE(numout,*)
211         IF(lwp) WRITE(numout,*) 'tra_nxt_fix : time stepping'
212         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
213      ENDIF
214      !
215      IF( cdtype == 'TRA' )  THEN   ;   ll_tra_hpg = ln_dynhpg_imp    ! active  tracers case  and  semi-implicit hpg   
216      ELSE                          ;   ll_tra_hpg = .FALSE.          ! passive tracers case or NO semi-implicit hpg
217      ENDIF
218      !
219      DO jn = 1, kjpt
220         !
221         DO jk = 1, jpkm1
222            DO jj = 1, jpj
223               DO ji = 1, jpi
224                  ztn = ptn(ji,jj,jk,jn)                                   
225                  ztd = pta(ji,jj,jk,jn) - 2. * ztn + ptb(ji,jj,jk,jn)      !  time laplacian on tracers
226                  !
227                  ptb(ji,jj,jk,jn) = ztn + atfp * ztd                       ! ptb <-- filtered ptn
228                  ptn(ji,jj,jk,jn) = pta(ji,jj,jk,jn)                       ! ptn <-- pta
229                  !
230                  IF( ll_tra_hpg )   pta(ji,jj,jk,jn) = ztn + rbcp * ztd    ! pta <-- Brown & Campana average
231               END DO
232           END DO
233         END DO
234         !
235      END DO
236      !
237   END SUBROUTINE tra_nxt_fix
238
239
240   SUBROUTINE tra_nxt_vvl( kt, cdtype, ptb, ptn, pta, kjpt )
241      !!----------------------------------------------------------------------
242      !!                   ***  ROUTINE tra_nxt_vvl  ***
243      !!
244      !! ** Purpose :   Time varying volume: apply the Asselin time filter 
245      !!                and swap the tracer fields.
246      !!
247      !! ** Method  : - Apply a thickness weighted Asselin time filter on now fields.
248      !!              - save in (ta,sa) a thickness weighted average over the three
249      !!             time levels which will be used to compute rdn and thus the semi-
250      !!             implicit hydrostatic pressure gradient (ln_dynhpg_imp = T)
251      !!              - swap tracer fields to prepare the next time_step.
252      !!                This can be summurized for tempearture as:
253      !!             ztm = ( e3t_n*tn + rbcp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] )   ln_dynhpg_imp = T
254      !!                  /( e3t_n    + rbcp*[ e3t_b    - 2 e3t_n    + e3t_a    ] )   
255      !!             ztm = 0                                                       otherwise
256      !!             tb  = ( e3t_n*tn + atfp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] )
257      !!                  /( e3t_n    + atfp*[ e3t_b    - 2 e3t_n    + e3t_a    ] )
258      !!             tn  = ta
259      !!             ta  = zt        (NB: reset to 0 after eos_bn2 call)
260      !!
261      !! ** Action  : - (tb,sb) and (tn,sn) ready for the next time step
262      !!              - (ta,sa) time averaged (t,s)   (ln_dynhpg_imp = T)
263      !!----------------------------------------------------------------------
264      INTEGER         , INTENT(in   )                               ::   kt       ! ocean time-step index
265      CHARACTER(len=3), INTENT(in   )                               ::   cdtype   ! =TRA or TRC (tracer indicator)
266      INTEGER         , INTENT(in   )                               ::   kjpt     ! number of tracers
267      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptb      ! before tracer fields
268      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptn      ! now tracer fields
269      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   pta      ! tracer trend
270      !!     
271      LOGICAL  ::   ll_tra, ll_tra_hpg, ll_traqsr   ! local logical
272      INTEGER  ::   ji, jj, jk, jn              ! dummy loop indices
273      REAL(wp) ::   zfact1, ztc_a , ztc_n , ztc_b , ztc_f , ztc_d    ! local scalar
274      REAL(wp) ::   zfact2, ze3t_b, ze3t_n, ze3t_a, ze3t_f, ze3t_d   !   -      -
275      !!----------------------------------------------------------------------
276
277      IF( kt == nit000 ) THEN
278         IF(lwp) WRITE(numout,*)
279         IF(lwp) WRITE(numout,*) 'tra_nxt_vvl : time stepping'
280         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
281      ENDIF
282      !
283      IF( cdtype == 'TRA' )  THEN   
284         ll_tra     = .TRUE.           ! active tracers case 
285         ll_tra_hpg = ln_dynhpg_imp    ! active  tracers case  and  semi-implicit hpg
286         ll_traqsr  = ln_traqsr        ! active  tracers case  and  solar penetration
287      ELSE                         
288         ll_tra     = .FALSE.          ! passive tracers case
289         ll_tra_hpg = .FALSE.          ! passive tracers case or NO semi-implicit hpg
290         ll_traqsr  = .FALSE.          ! active  tracers case and NO solar penetration
291      ENDIF
292      !
293      DO jn = 1, kjpt     
294         DO jk = 1, jpkm1
295            zfact1 = atfp * rdttra(jk)
296            zfact2 = zfact1 / rau0
297            DO jj = 1, jpj
298               DO ji = 1, jpi
299                  ze3t_b = fse3t_b(ji,jj,jk)
300                  ze3t_n = fse3t_n(ji,jj,jk)
301                  ze3t_a = fse3t_a(ji,jj,jk)
302                  !                                         ! tracer content at Before, now and after
303                  ztc_b  = ptb(ji,jj,jk,jn) * ze3t_b
304                  ztc_n  = ptn(ji,jj,jk,jn) * ze3t_n
305                  ztc_a  = pta(ji,jj,jk,jn) * ze3t_a
306                  !
307                  ze3t_d = ze3t_a - 2. * ze3t_n + ze3t_b
308                  ztc_d  = ztc_a  - 2. * ztc_n  + ztc_b
309                  !
310                  ze3t_f = ze3t_n + atfp * ze3t_d
311                  ztc_f  = ztc_n  + atfp * ztc_d
312                  !
313                  IF( ll_tra .AND. jk == 1 ) THEN           ! first level only for T & S
314                      ze3t_f = ze3t_f - zfact2 * ( emp_b(ji,jj) - emp(ji,jj) )
315                      ztc_f  = ztc_f  - zfact1 * ( sbc_tsc(ji,jj,jn) - sbc_tsc_b(ji,jj,jn) )
316                  ENDIF
317                  IF( ll_traqsr .AND. jn == jp_tem .AND. jk <= nksr )   &     ! solar penetration (temperature only)
318                     &     ztc_f  = ztc_f  - zfact1 * ( qsr_hc(ji,jj,jk) - qsr_hc_b(ji,jj,jk) ) 
319
320                   ze3t_f = 1.e0 / ze3t_f
321                   ptb(ji,jj,jk,jn) = ztc_f * ze3t_f       ! ptb <-- ptn filtered
322                   ptn(ji,jj,jk,jn) = pta(ji,jj,jk,jn)     ! ptn <-- pta
323                   !
324                   IF( ll_tra_hpg ) THEN        ! semi-implicit hpg (T & S only)
325                      ze3t_d           = 1.e0   / ( ze3t_n + rbcp * ze3t_d )
326                      pta(ji,jj,jk,jn) = ze3t_d * ( ztc_n  + rbcp * ztc_d  )   ! ta <-- Brown & Campana average
327                   ENDIF
328               END DO
329            END DO
330         END DO
331         !
332      END DO
333      !
334   END SUBROUTINE tra_nxt_vvl
335
336   !!======================================================================
337END MODULE tranxt
Note: See TracBrowser for help on using the repository browser.