source: palm/trunk/SOURCE/timestep.f90 @ 318

Last change on this file since 318 was 318, checked in by letzel, 12 years ago
  • Modified timestep criterion in case of simulations with plant canopy (timestep; modules rolled back to revision 305)
  • Property svn:keywords set to Id
File size: 14.8 KB
Line 
1 SUBROUTINE timestep
2
3!------------------------------------------------------------------------------!
4! Current revisions:
5! -----------------
6! Additional timestep criterion in case of simulations with plant canopy
7!
8! Output of messages replaced by message handling routine.
9!
10!
11! Former revisions:
12! -----------------
13! $Id: timestep.f90 318 2009-05-15 16:25:33Z letzel $
14!
15! 222 2009-01-12 16:04:16Z letzel
16! Implementation of a MPI-1 Coupling: replaced myid with target_id
17! Bugfix for nonparallel execution
18!
19! 108 2007-08-24 15:10:38Z letzel
20! modifications to terminate coupled runs
21!
22! RCS Log replace by Id keyword, revision history cleaned up
23!
24! Revision 1.21  2006/02/23 12:59:44  raasch
25! nt_anz renamed current_timestep_number
26!
27! Revision 1.1  1997/08/11 06:26:19  raasch
28! Initial revision
29!
30!
31! Description:
32! ------------
33! Compute the time step under consideration of the FCL and diffusion criterion.
34!------------------------------------------------------------------------------!
35
36    USE arrays_3d
37    USE control_parameters
38    USE cpulog
39    USE grid_variables
40    USE indices
41    USE interfaces
42    USE pegrid
43    USE statistics
44
45    IMPLICIT NONE
46
47    INTEGER ::  i, j, k
48
49    REAL ::  div, dt_diff, dt_diff_l, dt_plant_canopy,                 &
50             dt_plant_canopy_l,                                        &
51             dt_plant_canopy_u, dt_plant_canopy_v, dt_plant_canopy_w,  & 
52             dt_u, dt_v, dt_w, lad_max, percent_change,                &
53             u_gtrans_l, vabs_max, value, v_gtrans_l
54
55    REAL, DIMENSION(2)         ::  uv_gtrans, uv_gtrans_l
56    REAL, DIMENSION(nzb+1:nzt) ::  dxyz2_min
57
58
59    CALL cpu_log( log_point(12), 'calculate_timestep', 'start' )
60
61!
62!-- Determine the maxima of the velocity components.
63    CALL global_min_max( nzb, nzt+1, nys-1, nyn+1, nxl-1, nxr+1, u, 'abs', &
64                         u_max, u_max_ijk )
65    CALL global_min_max( nzb, nzt+1, nys-1, nyn+1, nxl-1, nxr+1, v, 'abs', &
66                         v_max, v_max_ijk )
67    CALL global_min_max( nzb, nzt+1, nys-1, nyn+1, nxl-1, nxr+1, w, 'abs', &
68                         w_max, w_max_ijk )
69
70!
71!-- In case maxima of the horizontal velocity components have been found at the
72!-- bottom boundary (k=nzb), the corresponding maximum at level k=1 is chosen
73!-- if the Dirichlet-boundary condition ('mirror') has been set. This is
74!-- necessary, because otherwise in case of Galilei-transform a far too large
75!-- velocity (having the respective opposite sign) would be used for the time
76!-- step determination (almost double the mean flow velocity).
77    IF ( ibc_uv_b == 0 )  THEN
78       IF ( u_max_ijk(1) == nzb )  THEN
79          u_max        = -u_max
80          u_max_ijk(1) = nzb + 1
81       ENDIF
82       IF ( v_max_ijk(1) == nzb )  THEN
83          v_max        = -v_max
84          v_max_ijk(1) = nzb + 1
85       ENDIF
86    ENDIF
87
88!
89!-- In case of Galilei-transform not using the geostrophic wind as translation
90!-- velocity, compute the volume-averaged horizontal velocity components, which
91!-- will then be subtracted from the horizontal wind for the time step and
92!-- horizontal advection routines.
93    IF ( galilei_transformation  .AND. .NOT.  use_ug_for_galilei_tr )  THEN
94       IF ( flow_statistics_called )  THEN
95!
96!--       Horizontal averages already existent, just need to average them
97!--       vertically.
98          u_gtrans = 0.0
99          v_gtrans = 0.0
100          DO  k = nzb+1, nzt
101             u_gtrans = u_gtrans + hom(k,1,1,0)
102             v_gtrans = v_gtrans + hom(k,1,2,0)
103          ENDDO
104          u_gtrans = u_gtrans / REAL( nzt - nzb )
105          v_gtrans = v_gtrans / REAL( nzt - nzb )
106       ELSE
107!
108!--       Averaging over the entire model domain.
109          uv_gtrans_l = 0.0
110          DO  i = nxl, nxr
111             DO  j = nys, nyn
112                DO  k = nzb+1, nzt
113                   uv_gtrans_l(1) = uv_gtrans_l(1) + u(k,j,i)
114                   uv_gtrans_l(2) = uv_gtrans_l(2) + v(k,j,i)
115                ENDDO
116             ENDDO
117          ENDDO
118          uv_gtrans_l = uv_gtrans_l / REAL( (nxr-nxl+1)*(nyn-nys+1)*(nzt-nzb) )
119#if defined( __parallel )
120          CALL MPI_ALLREDUCE( uv_gtrans_l, uv_gtrans, 2, MPI_REAL, MPI_SUM, &
121                              comm2d, ierr )
122          u_gtrans = uv_gtrans(1) / REAL( numprocs )
123          v_gtrans = uv_gtrans(2) / REAL( numprocs )
124#else
125          u_gtrans = uv_gtrans_l(1)
126          v_gtrans = uv_gtrans_l(2)
127#endif
128       ENDIF
129    ENDIF
130
131    IF ( .NOT. dt_fixed )  THEN
132!
133!--    Variable time step:
134!
135!--    For each component, compute the maximum time step according to the
136!--    FCL-criterion.
137       dt_u = dx / ( ABS( u_max - u_gtrans ) + 1.0E-10 )
138       dt_v = dy / ( ABS( v_max - v_gtrans ) + 1.0E-10 )
139       dt_w = dzu(MAX( 1, w_max_ijk(1) )) / ( ABS( w_max ) + 1.0E-10 )
140
141!
142!--    Compute time step according to the diffusion criterion.
143!--    First calculate minimum grid spacing which only depends on index k
144!--    Note: also at k=nzb+1 a full grid length is being assumed, although
145!--          in the Prandtl-layer friction term only dz/2 is used.
146!--          Experience from the old model seems to justify this.
147       dt_diff_l = 999999.0
148
149       DO  k = nzb+1, nzt
150           dxyz2_min(k) = MIN( dx2, dy2, dzu(k)*dzu(k) ) * 0.125
151       ENDDO
152
153!$OMP PARALLEL private(i,j,k,value) reduction(MIN: dt_diff_l)
154!$OMP DO
155       DO  i = nxl, nxr
156          DO  j = nys, nyn
157             DO  k = nzb+1, nzt
158                value = dxyz2_min(k) / ( MAX( kh(k,j,i), km(k,j,i) ) + 1E-20 )
159
160                dt_diff_l = MIN( value, dt_diff_l )
161             ENDDO
162          ENDDO
163       ENDDO
164!$OMP END PARALLEL
165#if defined( __parallel )
166       CALL MPI_ALLREDUCE( dt_diff_l, dt_diff, 1, MPI_REAL, MPI_MIN, comm2d, &
167                           ierr )
168#else
169       dt_diff = dt_diff_l
170#endif
171
172!
173!--    In case of non-cyclic lateral boundaries, the diffusion time step
174!--    may be further restricted by the lateral damping layer (damping only
175!--    along x and y)
176       IF ( bc_lr /= 'cyclic' )  THEN
177          dt_diff = MIN( dt_diff, 0.125 * dx2 / ( km_damp_max + 1E-20 ) )
178       ELSEIF ( bc_ns /= 'cyclic' )  THEN
179          dt_diff = MIN( dt_diff, 0.125 * dy2 / ( km_damp_max + 1E-20 ) )
180       ENDIF
181
182!
183!--    Additional timestep criterion with plant canopies:
184!--    it is not allowed to extract more than the available momentum
185       IF ( plant_canopy ) THEN
186
187          dt_plant_canopy_l = 0.0
188          DO  i = nxl, nxr
189             DO  j = nys, nyn
190                DO k = nzb+1, nzt
191                   dt_plant_canopy_u = cdc(k,j,i) * lad_u(k,j,i) *  &
192                                       SQRT(     u(k,j,i)**2     +  &
193                                             ( ( v(k,j,i-1)      +  &
194                                                 v(k,j,i)        +  &
195                                                 v(k,j+1,i)      +  &
196                                                 v(k,j+1,i-1) )     &
197                                               / 4.0 )**2        +  &
198                                             ( ( w(k-1,j,i-1)    +  &
199                                                 w(k-1,j,i)      +  &
200                                                 w(k,j,i-1)      +  &
201                                                 w(k,j,i) )         &
202                                                 / 4.0 )**2 ) 
203                   IF ( dt_plant_canopy_u > dt_plant_canopy_l ) THEN
204                      dt_plant_canopy_l = dt_plant_canopy_u 
205                   ENDIF
206                   dt_plant_canopy_v = cdc(k,j,i) * lad_v(k,j,i) *  &
207                                       SQRT( ( ( u(k,j-1,i)      +  &
208                                                 u(k,j-1,i+1)    +  &
209                                                 u(k,j,i)        +  &
210                                                 u(k,j,i+1) )       &
211                                               / 4.0 )**2        +  &
212                                                 v(k,j,i)**2     +  &
213                                             ( ( w(k-1,j-1,i)    +  &
214                                                 w(k-1,j,i)      +  &
215                                                 w(k,j-1,i)      +  &
216                                                 w(k,j,i) )         &
217                                                 / 4.0 )**2 ) 
218                   IF ( dt_plant_canopy_v > dt_plant_canopy_l ) THEN
219                      dt_plant_canopy_l = dt_plant_canopy_v
220                   ENDIF                   
221                   dt_plant_canopy_w = cdc(k,j,i) * lad_w(k,j,i) *  &
222                                       SQRT( ( ( u(k,j,i)        +  &
223                                                 u(k,j,i+1)      +  &
224                                                 u(k+1,j,i)      +  &
225                                                 u(k+1,j,i+1) )     &
226                                               / 4.0 )**2        +  &
227                                             ( ( v(k,j,i)        +  &
228                                                 v(k,j+1,i)      +  &
229                                                 v(k+1,j,i)      +  &
230                                                 v(k+1,j+1,i) )     &
231                                               / 4.0 )**2        +  &
232                                                 w(k,j,i)**2 )     
233                   IF ( dt_plant_canopy_w > dt_plant_canopy_l ) THEN
234                      dt_plant_canopy_l = dt_plant_canopy_w
235                   ENDIF
236                ENDDO
237             ENDDO
238          ENDDO
239
240          IF ( dt_plant_canopy_l > 0.0 ) THEN
241             dt_plant_canopy_l = 0.1 / dt_plant_canopy_l
242          ENDIF
243!
244!--       Determine the global minumum
245#if defined( __parallel )
246          CALL MPI_ALLREDUCE( dt_plant_canopy_l, dt_plant_canopy, 1, MPI_REAL,  &
247                              MPI_MIN, comm2d, ierr )
248#else
249          dt_plant_canopy = dt_plant_canopy_l
250#endif
251
252       ELSE
253!
254!--       Use dt_diff as dummy value to avoid extra IF branches further below
255          dt_plant_canopy = dt_diff
256
257       ENDIF
258
259!
260!--    The time step is the minimum of the 3-4 components and the diffusion time
261!--    step minus a reduction to be on the safe side. Factor 0.5 is necessary
262!--    since the leap-frog scheme always progresses by 2 * delta t.
263!--    The user has to set the cfl_factor small enough to ensure that the
264!--    divergences do not become too large.
265!--    The time step must not exceed the maximum allowed value.
266       IF ( timestep_scheme(1:5) == 'runge' )  THEN
267          dt_3d = cfl_factor * MIN( dt_diff, dt_plant_canopy, dt_u, dt_v, dt_w )
268       ELSE
269          dt_3d = cfl_factor * 0.5 *  &
270                  MIN( dt_diff, dt_plant_canopy, dt_u, dt_v, dt_w )
271       ENDIF
272       dt_3d = MIN( dt_3d, dt_max )
273
274!
275!--    Remember the restricting time step criterion for later output.
276       IF ( MIN( dt_u, dt_v, dt_w ) < MIN( dt_diff, dt_plant_canopy ) )  THEN
277          timestep_reason = 'A'
278       ELSEIF ( dt_plant_canopy < dt_diff )  THEN
279          timestep_reason = 'C'
280       ELSE
281          timestep_reason = 'D'
282       ENDIF
283
284!
285!--    Set flag if the time step becomes too small.
286       IF ( dt_3d < ( 0.00001 * dt_max ) )  THEN
287          stop_dt = .TRUE.
288
289          WRITE( message_string, * ) 'Time step has reached minimum limit.',   &
290                        '&dt      = ', dt_3d, ' s  Simulation is terminated.', &
291                        '&old_dt  = ', old_dt, ' s',                           &
292                        '&dt_u    = ', dt_u, ' s',                             &
293                        '&dt_v    = ', dt_v, ' s',                             &
294                        '&dt_w    = ', dt_w, ' s',                             &
295                        '&dt_diff = ', dt_diff, ' s',                          &
296                        '&u_max   = ', u_max, ' m/s   k=', u_max_ijk(1),       &
297                        '  j=', u_max_ijk(2), '  i=', u_max_ijk(3),            &
298                        '&v_max   = ', v_max, ' m/s   k=', v_max_ijk(1),       &
299                        '  j=', v_max_ijk(2), '  i=', v_max_ijk(3),            &
300                        '&w_max   = ', w_max, ' m/s   k=', w_max_ijk(1),       &
301                        '  j=', w_max_ijk(2), '  i=', w_max_ijk(3)
302          CALL message( 'timestep', 'PA0312', 0, 1, 0, 6, 0 )
303!
304!--       In case of coupled runs inform the remote model of the termination
305!--       and its reason, provided the remote model has not already been
306!--       informed of another termination reason (terminate_coupled > 0) before.
307#if defined( __parallel )
308          IF ( coupling_mode /= 'uncoupled' .AND. terminate_coupled == 0 )  THEN
309             terminate_coupled = 2
310             CALL MPI_SENDRECV( &
311                  terminate_coupled,        1, MPI_INTEGER, target_id,  0, &
312                  terminate_coupled_remote, 1, MPI_INTEGER, target_id,  0, &
313                  comm_inter, status, ierr )
314          ENDIF
315#endif
316       ENDIF
317
318!
319!--    Ensure a smooth value (two significant digits) of the timestep. For
320!--    other schemes than Runge-Kutta, the following restrictions appear:
321!--    The current timestep is only then changed, if the change relative to
322!--    its previous value exceeds +5 % or -2 %. In case of a timestep
323!--    reduction, at least 30 iterations have to be performed before a timestep
324!--    enlargement is permitted again.
325       percent_change = dt_3d / old_dt - 1.0
326       IF ( percent_change > 0.05  .OR.  percent_change < -0.02  .OR. &
327            timestep_scheme(1:5) == 'runge' )  THEN
328
329!
330!--       Time step enlargement by no more than 2 %.
331          IF ( percent_change > 0.0  .AND.  simulated_time /= 0.0  .AND. &
332               timestep_scheme(1:5) /= 'runge' )  THEN
333             dt_3d = 1.02 * old_dt
334          ENDIF
335
336!
337!--       A relatively smooth value of the time step is ensured by taking
338!--       only the first two significant digits.
339          div = 1000.0
340          DO  WHILE ( dt_3d < div )
341             div = div / 10.0
342          ENDDO
343          dt_3d = NINT( dt_3d * 100.0 / div ) * div / 100.0
344
345!
346!--       Now the time step can be adjusted.
347          IF ( percent_change < 0.0  .OR.  timestep_scheme(1:5) == 'runge' ) &
348          THEN
349!
350!--          Time step reduction.
351             old_dt = dt_3d
352             dt_changed = .TRUE.
353          ELSE
354!
355!--          For other timestep schemes , the time step is only enlarged
356!--          after at least 30 iterations since the previous time step
357!--          change or, of course, after model initialization.
358             IF ( current_timestep_number >= last_dt_change + 30  .OR. &
359                  simulated_time == 0.0 )  THEN
360                old_dt = dt_3d
361                dt_changed = .TRUE.
362             ELSE
363                dt_3d = old_dt
364                dt_changed = .FALSE.
365             ENDIF
366
367          ENDIF
368       ELSE
369!
370!--       No time step change since the difference is too small.
371          dt_3d = old_dt
372          dt_changed = .FALSE.
373       ENDIF
374
375       IF ( dt_changed )  last_dt_change = current_timestep_number
376
377    ENDIF
378
379    CALL cpu_log( log_point(12), 'calculate_timestep', 'stop' )
380
381
382 END SUBROUTINE timestep
Note: See TracBrowser for help on using the repository browser.