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.
trcnxt.F90 in branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2015/dev_r5003_MERCATOR6_CRS/NEMOGCM/NEMO/TOP_SRC/TRP/trcnxt.F90 @ 8754

Last change on this file since 8754 was 8754, checked in by cbricaud, 6 years ago

bugfix for coarsening branch
  • Property svn:keywords set to Id
File size: 8.1 KB
Line 
1MODULE trcnxt
2   !!======================================================================
3   !!                       ***  MODULE  trcnxt  ***
4   !! Ocean passive tracers:  time stepping on passives tracers
5   !!======================================================================
6   !! History :  7.0  !  1991-11  (G. Madec)  Original code
7   !!                 !  1993-03  (M. Guyon)  symetrical conditions
8   !!                 !  1995-02  (M. Levy)   passive tracers
9   !!                 !  1996-02  (G. Madec & M. Imbard)  opa release 8.0
10   !!            8.0  !  1996-04  (A. Weaver)  Euler forward step
11   !!            8.2  !  1999-02  (G. Madec, N. Grima)  semi-implicit pressure grad.
12   !!  NEMO      1.0  !  2002-08  (G. Madec)  F90: Free form and module
13   !!                 !  2002-08  (G. Madec)  F90: Free form and module
14   !!                 !  2002-11  (C. Talandier, A-M Treguier) Open boundaries
15   !!                 !  2004-03  (C. Ethe) passive tracers
16   !!                 !  2007-02  (C. Deltel) Diagnose ML trends for passive tracers
17   !!            2.0  !  2006-02  (L. Debreu, C. Mazauric) Agrif implementation
18   !!            3.0  !  2008-06  (G. Madec)  time stepping always done in trazdf
19   !!            3.1  !  2009-02  (G. Madec, R. Benshila)  re-introduce the vvl option
20   !!            3.3  !  2010-06  (C. Ethe, G. Madec) Merge TRA-TRC
21   !!----------------------------------------------------------------------
22#if defined key_top
23   !!----------------------------------------------------------------------
24   !!   'key_top'                                                TOP models
25   !!----------------------------------------------------------------------
26   !!   trc_nxt     : time stepping on passive tracers
27   !!----------------------------------------------------------------------
28   USE oce_trc         ! ocean dynamics and tracers variables
29   USE trc, ONLY : nittrc000, tra, jptra,rdttrc,trb, trn,tra,ctrcnm,sbc_trc,sbc_trc_b ! ocean passive tracers variables
30   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
31   USE prtctl_trc      ! Print control for debbuging
32   USE trd_oce
33   USE trdtra
34   USE tranxt
35# if defined key_agrif
36   USE agrif_top_interp
37# endif
38   USE crs, ONLY : ln_crs_top
39   USE ieee_arithmetic
40#if defined key_crs
41   USE crslbclnk , ONLY : crs_lbc_lnk
42#endif
43
44   IMPLICIT NONE
45   PRIVATE
46
47   PUBLIC   trc_nxt          ! routine called by step.F90
48   PUBLIC   trc_nxt_alloc    ! routine called by nemogcm.F90
49
50   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) ::   r2dt
51
52   !!----------------------------------------------------------------------
53   !! NEMO/TOP 3.3 , NEMO Consortium (2010)
54   !! $Id$
55   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
56   !!----------------------------------------------------------------------
57CONTAINS
58
59   INTEGER FUNCTION trc_nxt_alloc()
60      !!----------------------------------------------------------------------
61      !!                   ***  ROUTINE trc_nxt_alloc  ***
62      !!----------------------------------------------------------------------
63      ALLOCATE( r2dt(jpk), STAT=trc_nxt_alloc )
64      !
65      IF( trc_nxt_alloc /= 0 )   CALL ctl_warn('trc_nxt_alloc : failed to allocate array')
66      !
67   END FUNCTION trc_nxt_alloc
68
69
70   SUBROUTINE trc_nxt( kt )
71      !!----------------------------------------------------------------------
72      !!                   ***  ROUTINE trcnxt  ***
73      !!
74      !! ** Purpose :   Compute the passive tracers fields at the
75      !!      next time-step from their temporal trends and swap the fields.
76      !!
77      !! ** Method  :   Apply lateral boundary conditions on (ua,va) through
78      !!      call to lbc_lnk routine
79      !!   default:
80      !!      arrays swap
81      !!         (trn) = (tra) ; (tra) = (0,0)
82      !!         (trb) = (trn)
83      !!
84      !!   For Arakawa or TVD Scheme :
85      !!      A Asselin time filter applied on now tracers (trn) to avoid
86      !!      the divergence of two consecutive time-steps and tr arrays
87      !!      to prepare the next time_step:
88      !!         (trb) = (trn) + atfp [ (trb) + (tra) - 2 (trn) ]
89      !!         (trn) = (tra) ; (tra) = (0,0)
90      !!
91      !!
92      !! ** Action  : - update trb, trn
93      !!----------------------------------------------------------------------
94      INTEGER, INTENT( in ) ::   kt     ! ocean time-step index
95      !
96      INTEGER  ::   ji,jj,jk, jn   ! dummy loop indices
97      REAL(wp) ::   zfact            ! temporary scalar
98      CHARACTER (len=22) :: charout
99      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::  ztrdt 
100      !!----------------------------------------------------------------------
101      !
102      IF( nn_timing == 1 )  CALL timing_start('trc_nxt')
103      !
104      IF( kt == nittrc000 .AND. lwp ) THEN
105         WRITE(numout,*)
106         WRITE(numout,*) 'trc_nxt : time stepping on passive tracers'
107      ENDIF
108
109#if defined key_agrif
110      CALL Agrif_trc                   ! AGRIF zoom boundaries
111#endif
112      ! Update after tracer on domain lateral boundaries
113      DO jn = 1, jptra
114#if defined key_crs
115         CALL crs_lbc_lnk( tra(:,:,:,jn), 'T', 1. )   
116#else
117         CALL lbc_lnk( tra(:,:,:,jn), 'T', 1. )   
118#endif
119      END DO
120
121
122#if defined key_bdy
123!!      CALL bdy_trc( kt )               ! BDY open boundaries
124#endif
125
126
127      ! set time step size (Euler/Leapfrog)
128      IF( neuler == 0 .AND. kt ==  nittrc000 ) THEN  ;  r2dt(:) =     rdttrc(:)   ! at nittrc000             (Euler)
129      ELSEIF( kt <= nittrc000 + nn_dttrc )     THEN  ;  r2dt(:) = 2.* rdttrc(:)   ! at nit000 or nit000+1 (Leapfrog)
130      ENDIF
131
132      ! trends computation initialisation
133      IF( l_trdtrc )  THEN
134         CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrdt )  !* store now fields before applying the Asselin filter
135         ztrdt(:,:,:,:)  = trn(:,:,:,:)
136      ENDIF
137      ! Leap-Frog + Asselin filter time stepping
138      IF( neuler == 0 .AND. kt == nittrc000 ) THEN        ! Euler time-stepping at first time-step
139         !                                                ! (only swap)
140         DO jn = 1, jptra
141            DO jk = 1, jpkm1
142               trn(:,:,jk,jn) = tra(:,:,jk,jn)
143            END DO
144         END DO
145         !                                             
146      ELSE
147         ! Leap-Frog + Asselin filter time stepping
148         IF( lk_vvl ) THEN   
149
150            IF( ln_crs_top )THEN
151               CALL tra_nxt_vvl_crs( kt, nittrc000, rdttrc, 'TRC', trb, trn, tra,      &
152              &                                              sbc_trc, sbc_trc_b, jptra )      ! variable volume level (vvl)
153            ELSE
154               CALL tra_nxt_vvl( kt, nittrc000, rdttrc, 'TRC', trb, trn, tra,      &
155              &                                          sbc_trc, sbc_trc_b, jptra )      ! variable volume level (vvl)
156            ENDIF
157         ELSE                   ;   CALL tra_nxt_fix( kt, nittrc000,         'TRC', trb, trn, tra, jptra )      ! fixed    volume level
158         ENDIF
159      ENDIF
160
161      ! trends computation
162      IF( l_trdtrc ) THEN                                      ! trends
163         DO jn = 1, jptra
164            DO jk = 1, jpkm1
165               zfact = 1.e0 / r2dt(jk) 
166               ztrdt(:,:,jk,jn) = ( trb(:,:,jk,jn) - ztrdt(:,:,jk,jn) ) * zfact 
167               CALL trd_tra( kt, 'TRC', jn, jptra_atf, ztrdt )
168            END DO
169         END DO
170         CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrdt ) 
171      END IF
172      !
173      IF(ln_ctl)   THEN  ! print mean trends (used for debugging)
174         WRITE(charout, FMT="('nxt')")
175         CALL prt_ctl_trc_info(charout)
176         CALL prt_ctl_trc(tab4d=trn, mask=tmask, clinfo=ctrcnm)
177      ENDIF
178      !
179      IF( nn_timing == 1 )  CALL timing_stop('trc_nxt')
180      !
181   END SUBROUTINE trc_nxt
182
183#else
184   !!----------------------------------------------------------------------
185   !!   Default option                                         Empty module
186   !!----------------------------------------------------------------------
187CONTAINS
188   SUBROUTINE trc_nxt( kt ) 
189      INTEGER, INTENT(in) :: kt
190      WRITE(*,*) 'trc_nxt: You should not have seen this print! error?', kt
191   END SUBROUTINE trc_nxt
192#endif
193   !!======================================================================
194END MODULE trcnxt
Note: See TracBrowser for help on using the repository browser.