1 | MODULE 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 ! 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 | USE trcbdy ! BDY open boundaries |
---|
36 | USE bdy_par, only: lk_bdy |
---|
37 | USE iom |
---|
38 | # if defined key_agrif |
---|
39 | USE agrif_top_interp |
---|
40 | # endif |
---|
41 | |
---|
42 | IMPLICIT NONE |
---|
43 | PRIVATE |
---|
44 | |
---|
45 | PUBLIC trc_nxt ! routine called by step.F90 |
---|
46 | PUBLIC trc_nxt_alloc ! routine called by nemogcm.F90 |
---|
47 | |
---|
48 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:) :: r2dt |
---|
49 | |
---|
50 | !!---------------------------------------------------------------------- |
---|
51 | !! NEMO/TOP 3.3 , NEMO Consortium (2010) |
---|
52 | !! $Id$ |
---|
53 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
54 | !!---------------------------------------------------------------------- |
---|
55 | CONTAINS |
---|
56 | |
---|
57 | INTEGER FUNCTION trc_nxt_alloc() |
---|
58 | !!---------------------------------------------------------------------- |
---|
59 | !! *** ROUTINE trc_nxt_alloc *** |
---|
60 | !!---------------------------------------------------------------------- |
---|
61 | ALLOCATE( r2dt(jpk), STAT=trc_nxt_alloc ) |
---|
62 | ! |
---|
63 | IF( trc_nxt_alloc /= 0 ) CALL ctl_warn('trc_nxt_alloc : failed to allocate array') |
---|
64 | ! |
---|
65 | END FUNCTION trc_nxt_alloc |
---|
66 | |
---|
67 | |
---|
68 | SUBROUTINE trc_nxt( kt ) |
---|
69 | !!---------------------------------------------------------------------- |
---|
70 | !! *** ROUTINE trcnxt *** |
---|
71 | !! |
---|
72 | !! ** Purpose : Compute the passive tracers fields at the |
---|
73 | !! next time-step from their temporal trends and swap the fields. |
---|
74 | !! |
---|
75 | !! ** Method : Apply lateral boundary conditions on (ua,va) through |
---|
76 | !! call to lbc_lnk routine |
---|
77 | !! default: |
---|
78 | !! arrays swap |
---|
79 | !! (trn) = (tra) ; (tra) = (0,0) |
---|
80 | !! (trb) = (trn) |
---|
81 | !! |
---|
82 | !! For Arakawa or TVD Scheme : |
---|
83 | !! A Asselin time filter applied on now tracers (trn) to avoid |
---|
84 | !! the divergence of two consecutive time-steps and tr arrays |
---|
85 | !! to prepare the next time_step: |
---|
86 | !! (trb) = (trn) + atfp [ (trb) + (tra) - 2 (trn) ] |
---|
87 | !! (trn) = (tra) ; (tra) = (0,0) |
---|
88 | !! |
---|
89 | !! |
---|
90 | !! ** Action : - update trb, trn |
---|
91 | !!---------------------------------------------------------------------- |
---|
92 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
93 | ! |
---|
94 | INTEGER :: jk, jn ! dummy loop indices |
---|
95 | REAL(wp) :: zfact ! temporary scalar |
---|
96 | CHARACTER (len=22) :: charout |
---|
97 | REAL(wp), POINTER, DIMENSION(:,:,:,:) :: ztrdt |
---|
98 | #if defined key_tracer_budget |
---|
99 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) :: ztrdt_m1 ! slwa |
---|
100 | #endif |
---|
101 | !!---------------------------------------------------------------------- |
---|
102 | ! |
---|
103 | IF( nn_timing == 1 ) CALL timing_start('trc_nxt') |
---|
104 | ! |
---|
105 | IF( kt == nittrc000 .AND. lwp ) THEN |
---|
106 | WRITE(numout,*) |
---|
107 | WRITE(numout,*) 'trc_nxt : time stepping on passive tracers' |
---|
108 | ENDIF |
---|
109 | #if defined key_tracer_budget |
---|
110 | IF( kt == nittrc000 .AND. l_trdtrc ) THEN |
---|
111 | ALLOCATE( ztrdt_m1(jpi,jpj,jpk,jptra) ) ! slwa |
---|
112 | IF( ln_rsttr .AND. & ! Restart: read in restart file |
---|
113 | iom_varid( numrtr, 'atf_trend_'//TRIM(ctrcnm(1)), ldstop = .FALSE. ) > 0 ) THEN |
---|
114 | IF(lwp) WRITE(numout,*) ' nittrc000-nn_dttrc ATF tracer trend read in the restart file' |
---|
115 | DO jn = 1, jptra |
---|
116 | CALL iom_get( numrtr, jpdom_autoglo, 'atf_trend_'//TRIM(ctrcnm(jn)), ztrdt_m1(:,:,:,jn) ) ! before tracer trend for atf |
---|
117 | END DO |
---|
118 | ELSE |
---|
119 | ztrdt_m1=0.0 |
---|
120 | ENDIF |
---|
121 | ENDIF |
---|
122 | #endif |
---|
123 | |
---|
124 | |
---|
125 | #if defined key_agrif |
---|
126 | CALL Agrif_trc ! AGRIF zoom boundaries |
---|
127 | #endif |
---|
128 | ! Update after tracer on domain lateral boundaries |
---|
129 | DO jn = 1, jptra |
---|
130 | CALL lbc_lnk( tra(:,:,:,jn), 'T', 1. ) |
---|
131 | END DO |
---|
132 | |
---|
133 | |
---|
134 | IF( lk_bdy ) CALL trc_bdy( kt ) ! BDY open boundaries |
---|
135 | |
---|
136 | |
---|
137 | ! set time step size (Euler/Leapfrog) |
---|
138 | IF( neuler == 0 .AND. kt == nittrc000 ) THEN ; r2dt(:) = rdttrc(:) ! at nittrc000 (Euler) |
---|
139 | ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN ; r2dt(:) = 2.* rdttrc(:) ! at nit000 or nit000+1 (Leapfrog) |
---|
140 | ENDIF |
---|
141 | |
---|
142 | ! trends computation initialisation |
---|
143 | IF( l_trdtrc ) THEN |
---|
144 | CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrdt ) !* store now fields before applying the Asselin filter |
---|
145 | ztrdt(:,:,:,:) = trn(:,:,:,:) |
---|
146 | ENDIF |
---|
147 | ! Leap-Frog + Asselin filter time stepping |
---|
148 | IF( neuler == 0 .AND. kt == nittrc000 ) THEN ! Euler time-stepping at first time-step |
---|
149 | ! ! (only swap) |
---|
150 | DO jn = 1, jptra |
---|
151 | DO jk = 1, jpkm1 |
---|
152 | trn(:,:,jk,jn) = tra(:,:,jk,jn) |
---|
153 | END DO |
---|
154 | END DO |
---|
155 | ! |
---|
156 | ELSE |
---|
157 | ! Leap-Frog + Asselin filter time stepping |
---|
158 | IF( lk_vvl ) THEN ; CALL tra_nxt_vvl( kt, nittrc000, rdttrc, 'TRC', trb, trn, tra, & |
---|
159 | & sbc_trc, sbc_trc_b, jptra ) ! variable volume level (vvl) |
---|
160 | ELSE ; CALL tra_nxt_fix( kt, nittrc000, 'TRC', trb, trn, tra, jptra ) ! fixed volume level |
---|
161 | ENDIF |
---|
162 | ENDIF |
---|
163 | |
---|
164 | ! trends computation |
---|
165 | IF( l_trdtrc ) THEN ! trends |
---|
166 | DO jn = 1, jptra |
---|
167 | DO jk = 1, jpkm1 |
---|
168 | zfact = 1.e0 / r2dt(jk) |
---|
169 | ztrdt(:,:,jk,jn) = ( trb(:,:,jk,jn) - ztrdt(:,:,jk,jn) ) * zfact |
---|
170 | !slwa CALL trd_tra( kt, 'TRC', jn, jptra_atf, ztrdt ) |
---|
171 | #if defined key_tracer_budget |
---|
172 | ztrdt(:,:,jk,jn) = ztrdt(:,:,jk,jn) * e1t(:,:) * e2t(:,:) * e3t_n(:,:,jk) ! slwa vvl |
---|
173 | !ztrdt(:,:,jk,jn) = ztrdt(:,:,jk,jn) * e1t(:,:) * e2t(:,:) * e3t_0(:,:,jk) ! slwa CHANGE for vvl |
---|
174 | #endif |
---|
175 | END DO |
---|
176 | #if defined key_tracer_budget |
---|
177 | ! slwa budget code |
---|
178 | CALL trd_tra( kt, 'TRC', jn, jptra_atf, ztrdt_m1(:,:,:,jn) ) |
---|
179 | #else |
---|
180 | CALL trd_tra( kt, 'TRC', jn, jptra_atf, ztrdt(:,:,:,jn) ) |
---|
181 | #endif |
---|
182 | END DO |
---|
183 | #if defined key_tracer_budget |
---|
184 | ztrdt_m1(:,:,:,:) = ztrdt(:,:,:,:) ! need previous time step for budget slwa |
---|
185 | #endif |
---|
186 | CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrdt ) |
---|
187 | END IF |
---|
188 | |
---|
189 | #if defined key_tracer_budget |
---|
190 | ! Write in the tracer restart file |
---|
191 | ! ******************************* |
---|
192 | IF( lrst_trc ) THEN |
---|
193 | IF(lwp) WRITE(numout,*) |
---|
194 | IF(lwp) WRITE(numout,*) 'trc : ATF trend at last time step for tracer budget written in tracer restart file ', & |
---|
195 | & 'at it= ', kt,' date= ', ndastp |
---|
196 | IF(lwp) WRITE(numout,*) '~~~~' |
---|
197 | DO jn = 1, jptra |
---|
198 | CALL iom_rstput( kt, nitrst, numrtw, 'atf_trend_'//TRIM(ctrcnm(jn)), ztrdt_m1(:,:,:,jn) ) |
---|
199 | END DO |
---|
200 | ENDIF |
---|
201 | #endif |
---|
202 | |
---|
203 | ! |
---|
204 | IF(ln_ctl) THEN ! print mean trends (used for debugging) |
---|
205 | WRITE(charout, FMT="('nxt')") |
---|
206 | CALL prt_ctl_trc_info(charout) |
---|
207 | CALL prt_ctl_trc(tab4d=trn, mask=tmask, clinfo=ctrcnm) |
---|
208 | ENDIF |
---|
209 | ! |
---|
210 | IF( nn_timing == 1 ) CALL timing_stop('trc_nxt') |
---|
211 | ! |
---|
212 | END SUBROUTINE trc_nxt |
---|
213 | |
---|
214 | #else |
---|
215 | !!---------------------------------------------------------------------- |
---|
216 | !! Default option Empty module |
---|
217 | !!---------------------------------------------------------------------- |
---|
218 | CONTAINS |
---|
219 | SUBROUTINE trc_nxt( kt ) |
---|
220 | INTEGER, INTENT(in) :: kt |
---|
221 | WRITE(*,*) 'trc_nxt: You should not have seen this print! error?', kt |
---|
222 | END SUBROUTINE trc_nxt |
---|
223 | #endif |
---|
224 | !!====================================================================== |
---|
225 | END MODULE trcnxt |
---|