source: palm/trunk/SOURCE/time_integration.f90 @ 1002

Last change on this file since 1002 was 1002, checked in by raasch, 9 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 20.4 KB
Line 
1 SUBROUTINE time_integration
2
3!------------------------------------------------------------------------------!
4! Current revisions:
5! -----------------
6!
7!
8! Former revisions:
9! -----------------
10! $Id: time_integration.f90 1002 2012-09-13 15:12:24Z raasch $
11!
12! 1001 2012-09-13 14:08:46Z raasch
13! all actions concerning leapfrog- and upstream-spline-scheme removed
14!
15! 849 2012-03-15 10:35:09Z raasch
16! advec_particles renamed lpm, first_call_advec_particles renamed first_call_lpm
17!
18! 825 2012-02-19 03:03:44Z raasch
19! wang_collision_kernel renamed wang_kernel
20!
21! 790 2011-11-29 03:11:20Z raasch
22! exchange of ghostpoints for array diss
23!
24! 707 2011-03-29 11:39:40Z raasch
25! bc_lr/ns replaced by bc_lr/ns_cyc, calls of exchange_horiz are modified,
26! adaption to sloping surface
27!
28! 667  2010-12-23 12:06:00Z suehring/gryschka
29! Calls of exchange_horiz are modified.
30! Adaption to slooping surface.
31!
32! 449 2010-02-02 11:23:59Z raasch
33! Bugfix: exchange of ghost points for prho included
34!
35! 410 2009-12-04 17:05:40Z letzel
36! masked data output
37!
38! 388 2009-09-23 09:40:33Z raasch
39! Using prho instead of rho in diffusvities.
40! Coupling with independent precursor runs.
41! Bugfix: output of particle time series only if particle advection is switched
42!         on
43!
44! 151 2008-03-07 13:42:18Z raasch
45! inflow turbulence is imposed by calling new routine inflow_turbulence
46!
47! 108 2007-08-24 15:10:38Z letzel
48! Call of new routine surface_coupler,
49! presure solver is called after the first Runge-Kutta substep instead of the
50! last in case that call_psolver_at_all_substeps = .F.; for this case, the
51! random perturbation has to be added to the velocity fields also after the
52! first substep
53!
54! 97 2007-06-21 08:23:15Z raasch
55! diffusivities is called with argument rho in case of ocean runs,
56! new argument pt_/prho_reference in calls of diffusivities,
57! ghostpoint exchange for salinity and density
58!
59! 87 2007-05-22 15:46:47Z raasch
60! var_hom renamed pr_palm
61!
62! 75 2007-03-22 09:54:05Z raasch
63! Move call of user_actions( 'after_integration' ) below increment of times
64! and counters,
65! calls of prognostic_equations_.. changed to .._noopt, .._cache, and
66! .._vector, these calls are now controlled by switch loop_optimization,
67! uxrp, vynp eliminated, 2nd+3rd argument removed from exchange horiz,
68! moisture renamed humidity
69!
70! RCS Log replace by Id keyword, revision history cleaned up
71!
72! Revision 1.8  2006/08/22 14:16:05  raasch
73! Disturbances are imposed only for the last Runge-Kutta-substep
74!
75! Revision 1.2  2004/04/30 13:03:40  raasch
76! decalpha-specific warning removed, routine name changed to time_integration,
77! particle advection is carried out only once during the intermediate steps,
78! impulse_advec renamed momentum_advec
79!
80! Revision 1.1  1997/08/11 06:19:04  raasch
81! Initial revision
82!
83!
84! Description:
85! ------------
86! Integration in time of the model equations, statistical analysis and graphic
87! output
88!------------------------------------------------------------------------------!
89
90    USE arrays_3d
91    USE averaging
92    USE control_parameters
93    USE cpulog
94#if defined( __dvrp_graphics )
95    USE DVRP
96#endif
97    USE grid_variables
98    USE indices
99    USE interaction_droplets_ptq_mod
100    USE interfaces
101    USE particle_attributes
102    USE pegrid
103    USE prognostic_equations_mod
104    USE statistics
105    USE user_actions_mod
106
107    IMPLICIT NONE
108
109    CHARACTER (LEN=9) ::  time_to_string
110    INTEGER ::  i, j, k
111
112!
113!-- At the beginning of a simulation determine the time step as well as
114!-- determine and print out the run control parameters
115    IF ( simulated_time == 0.0 )  CALL timestep
116
117    CALL run_control
118
119
120!
121!-- Data exchange between coupled models in case that a call has been omitted
122!-- at the end of the previous run of a job chain.
123    IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled )  THEN
124!
125!--    In case of model termination initiated by the local model the coupler
126!--    must not be called because this would again cause an MPI hang.
127       DO WHILE ( time_coupling >= dt_coupling .AND. terminate_coupled == 0 )
128          CALL surface_coupler
129          time_coupling = time_coupling - dt_coupling
130       ENDDO
131       IF (time_coupling == 0.0 .AND. time_since_reference_point < dt_coupling)&
132       THEN
133          time_coupling = time_since_reference_point
134       ENDIF
135    ENDIF
136
137
138#if defined( __dvrp_graphics )
139!
140!-- Time measurement with dvrp software 
141    CALL DVRP_LOG_EVENT( 2, current_timestep_number )
142#endif
143
144!
145!-- Start of the time loop
146    DO  WHILE ( simulated_time < end_time  .AND.  .NOT. stop_dt  .AND. &
147                .NOT. terminate_run )
148
149       CALL cpu_log( log_point_s(10), 'timesteps', 'start' )
150!
151!--    Determine size of next time step
152       IF ( simulated_time /= 0.0 )  CALL timestep
153!
154!--    Execute the user-defined actions
155       CALL user_actions( 'before_timestep' )
156
157!
158!--    Start of intermediate step loop
159       intermediate_timestep_count = 0
160       DO  WHILE ( intermediate_timestep_count < &
161                   intermediate_timestep_count_max )
162
163          intermediate_timestep_count = intermediate_timestep_count + 1
164
165!
166!--       Set the steering factors for the prognostic equations which depend
167!--       on the timestep scheme
168          CALL timestep_scheme_steering
169
170!
171!--       Solve the prognostic equations. A fast cache optimized version with
172!--       only one single loop is used in case of Piascek-Williams advection
173!--       scheme. NEC vector machines use a different version, because
174!--       in the other versions a good vectorization is prohibited due to
175!--       inlining problems.
176          IF ( loop_optimization == 'vector' )  THEN
177             CALL prognostic_equations_vector
178          ELSE
179             IF ( scalar_advec == 'bc-scheme' )  THEN
180                CALL prognostic_equations_noopt
181             ELSE
182                CALL prognostic_equations_cache
183             ENDIF
184          ENDIF
185
186!
187!--       Particle transport/physics with the Lagrangian particle model
188!--       (only once during intermediate steps, because it uses an Euler-step)
189          IF ( particle_advection  .AND.                         &
190               simulated_time >= particle_advection_start  .AND. &
191               intermediate_timestep_count == 1 )  THEN
192             CALL lpm
193             first_call_lpm = .FALSE.
194          ENDIF
195
196!
197!--       Interaction of droplets with temperature and specific humidity.
198!--       Droplet condensation and evaporation is calculated within
199!--       advec_particles.
200          IF ( cloud_droplets  .AND.  &
201               intermediate_timestep_count == intermediate_timestep_count_max )&
202          THEN
203             CALL interaction_droplets_ptq
204          ENDIF
205
206!
207!--       Exchange of ghost points (lateral boundary conditions)
208          CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'start' )
209          CALL exchange_horiz( u_p, nbgp )
210          CALL exchange_horiz( v_p, nbgp )
211          CALL exchange_horiz( w_p, nbgp )
212          CALL exchange_horiz( pt_p, nbgp )
213          IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e_p, nbgp )
214          IF ( ocean )  THEN
215             CALL exchange_horiz( sa_p, nbgp )
216             CALL exchange_horiz( rho, nbgp )
217             CALL exchange_horiz( prho, nbgp )
218          ENDIF
219          IF (humidity  .OR.  passive_scalar)  CALL exchange_horiz( q_p, nbgp )
220          IF ( cloud_droplets )  THEN
221             CALL exchange_horiz( ql, nbgp )
222             CALL exchange_horiz( ql_c, nbgp )
223             CALL exchange_horiz( ql_v, nbgp )
224             CALL exchange_horiz( ql_vp, nbgp )
225          ENDIF
226          IF ( wang_kernel )  CALL exchange_horiz( diss, nbgp )
227
228          CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'stop' )
229
230!
231!--       Boundary conditions for the prognostic quantities (except of the
232!--       velocities at the outflow in case of a non-cyclic lateral wall)
233          CALL boundary_conds( 'main' )
234
235!
236!--       Swap the time levels in preparation for the next time step.
237          CALL swap_timelevel
238
239!
240!--       Temperature offset must be imposed at cyclic boundaries in x-direction
241!--       when a sloping surface is used
242          IF ( sloping_surface )  THEN
243             IF ( nxl ==  0 )  pt(:,:,nxlg:nxl-1) = pt(:,:,nxlg:nxl-1) - &
244                                                    pt_slope_offset
245             IF ( nxr == nx )  pt(:,:,nxr+1:nxrg) = pt(:,:,nxr+1:nxrg) + &
246                                                    pt_slope_offset
247          ENDIF
248
249!
250!--       Impose a turbulent inflow using the recycling method
251          IF ( turbulent_inflow )  CALL  inflow_turbulence
252
253!
254!--       Impose a random perturbation on the horizontal velocity field
255          IF ( create_disturbances  .AND.                                      &
256               ( call_psolver_at_all_substeps  .AND.                           &
257               intermediate_timestep_count == intermediate_timestep_count_max )&
258          .OR. ( .NOT. call_psolver_at_all_substeps  .AND.                     &
259               intermediate_timestep_count == 1 ) )                            &
260          THEN
261             time_disturb = time_disturb + dt_3d
262             IF ( time_disturb >= dt_disturb )  THEN
263                IF ( hom(nzb+5,1,pr_palm,0) < disturbance_energy_limit )  THEN
264                   CALL disturb_field( nzb_u_inner, tend, u )
265                   CALL disturb_field( nzb_v_inner, tend, v )
266                ELSEIF ( .NOT. bc_lr_cyc  .OR.  .NOT. bc_ns_cyc )  THEN
267!
268!--                Runs with a non-cyclic lateral wall need perturbations
269!--                near the inflow throughout the whole simulation
270                   dist_range = 1
271                   CALL disturb_field( nzb_u_inner, tend, u )
272                   CALL disturb_field( nzb_v_inner, tend, v )
273                   dist_range = 0
274                ENDIF
275                time_disturb = time_disturb - dt_disturb
276             ENDIF
277          ENDIF
278
279!
280!--       Reduce the velocity divergence via the equation for perturbation
281!--       pressure.
282          IF ( intermediate_timestep_count == 1  .OR. &
283                call_psolver_at_all_substeps )  THEN
284             CALL pres
285          ENDIF
286
287!
288!--       If required, compute virtuell potential temperature
289          IF ( humidity ) CALL compute_vpt
290
291!
292!--       If required, compute liquid water content
293          IF ( cloud_physics ) CALL calc_liquid_water_content
294
295!
296!--       Compute the diffusion quantities
297          IF ( .NOT. constant_diffusion )  THEN
298
299!
300!--          First the vertical fluxes in the Prandtl layer are being computed
301             IF ( prandtl_layer )  THEN
302                CALL cpu_log( log_point(19), 'prandtl_fluxes', 'start' )
303                CALL prandtl_fluxes
304                CALL cpu_log( log_point(19), 'prandtl_fluxes', 'stop' )
305             ENDIF
306
307!
308!--          Compute the diffusion coefficients
309             CALL cpu_log( log_point(17), 'diffusivities', 'start' )
310             IF ( .NOT. humidity ) THEN
311                IF ( ocean )  THEN
312                   CALL diffusivities( prho, prho_reference )
313                ELSE
314                   CALL diffusivities( pt, pt_reference )
315                ENDIF
316             ELSE
317                CALL diffusivities( vpt, pt_reference )
318             ENDIF
319             CALL cpu_log( log_point(17), 'diffusivities', 'stop' )
320
321          ENDIF
322
323       ENDDO   ! Intermediate step loop
324
325!
326!--    Increase simulation time and output times
327       current_timestep_number    = current_timestep_number + 1
328       simulated_time             = simulated_time   + dt_3d
329       simulated_time_chr         = time_to_string( simulated_time )
330       time_since_reference_point = simulated_time - coupling_start_time
331
332       IF ( simulated_time >= skip_time_data_output_av )  THEN
333          time_do_av         = time_do_av       + dt_3d
334       ENDIF
335       IF ( simulated_time >= skip_time_do2d_xy )  THEN
336          time_do2d_xy       = time_do2d_xy     + dt_3d
337       ENDIF
338       IF ( simulated_time >= skip_time_do2d_xz )  THEN
339          time_do2d_xz       = time_do2d_xz     + dt_3d
340       ENDIF
341       IF ( simulated_time >= skip_time_do2d_yz )  THEN
342          time_do2d_yz       = time_do2d_yz     + dt_3d
343       ENDIF
344       IF ( simulated_time >= skip_time_do3d    )  THEN
345          time_do3d          = time_do3d        + dt_3d
346       ENDIF
347       DO  mid = 1, masks
348          IF ( simulated_time >= skip_time_domask(mid) )  THEN
349             time_domask(mid)= time_domask(mid) + dt_3d
350          ENDIF
351       ENDDO
352       time_dvrp          = time_dvrp        + dt_3d
353       IF ( simulated_time >= skip_time_dosp )  THEN
354          time_dosp       = time_dosp        + dt_3d
355       ENDIF
356       time_dots          = time_dots        + dt_3d
357       IF ( .NOT. first_call_lpm )  THEN
358          time_dopts      = time_dopts       + dt_3d
359       ENDIF
360       IF ( simulated_time >= skip_time_dopr )  THEN
361          time_dopr       = time_dopr        + dt_3d
362       ENDIF
363       time_dopr_listing          = time_dopr_listing        + dt_3d
364       time_run_control   = time_run_control + dt_3d
365
366!
367!--    Data exchange between coupled models
368       IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled )  THEN
369          time_coupling = time_coupling + dt_3d
370
371!
372!--       In case of model termination initiated by the local model
373!--       (terminate_coupled > 0), the coupler must be skipped because it would
374!--       cause an MPI intercomminucation hang.
375!--       If necessary, the coupler will be called at the beginning of the
376!--       next restart run.
377          DO WHILE ( time_coupling >= dt_coupling .AND. terminate_coupled == 0 )
378             CALL surface_coupler
379             time_coupling = time_coupling - dt_coupling
380          ENDDO
381       ENDIF
382
383!
384!--    Execute user-defined actions
385       CALL user_actions( 'after_integration' )
386
387!
388!--    If Galilei transformation is used, determine the distance that the
389!--    model has moved so far
390       IF ( galilei_transformation )  THEN
391          advected_distance_x = advected_distance_x + u_gtrans * dt_3d
392          advected_distance_y = advected_distance_y + v_gtrans * dt_3d
393       ENDIF
394
395!
396!--    Check, if restart is necessary (because cpu-time is expiring or
397!--    because it is forced by user) and set stop flag
398!--    This call is skipped if the remote model has already initiated a restart.
399       IF ( .NOT. terminate_run )  CALL check_for_restart
400
401!
402!--    Carry out statistical analysis and output at the requested output times.
403!--    The MOD function is used for calculating the output time counters (like
404!--    time_dopr) in order to regard a possible decrease of the output time
405!--    interval in case of restart runs
406
407!
408!--    Set a flag indicating that so far no statistics have been created
409!--    for this time step
410       flow_statistics_called = .FALSE.
411
412!
413!--    If required, call flow_statistics for averaging in time
414       IF ( averaging_interval_pr /= 0.0  .AND.  &
415            ( dt_dopr - time_dopr ) <= averaging_interval_pr  .AND.  &
416            simulated_time >= skip_time_dopr )  THEN
417          time_dopr_av = time_dopr_av + dt_3d
418          IF ( time_dopr_av >= dt_averaging_input_pr )  THEN
419             do_sum = .TRUE.
420             time_dopr_av = MOD( time_dopr_av, &
421                                    MAX( dt_averaging_input_pr, dt_3d ) )
422          ENDIF
423       ENDIF
424       IF ( do_sum )  CALL flow_statistics
425
426!
427!--    Sum-up 3d-arrays for later output of time-averaged 2d/3d/masked data
428       IF ( averaging_interval /= 0.0  .AND.                                &
429            ( dt_data_output_av - time_do_av ) <= averaging_interval  .AND. &
430            simulated_time >= skip_time_data_output_av )                    &
431       THEN
432          time_do_sla = time_do_sla + dt_3d
433          IF ( time_do_sla >= dt_averaging_input )  THEN
434             CALL sum_up_3d_data
435             average_count_3d = average_count_3d + 1
436             time_do_sla = MOD( time_do_sla, MAX( dt_averaging_input, dt_3d ) )
437          ENDIF
438       ENDIF
439
440!
441!--    Calculate spectra for time averaging
442       IF ( averaging_interval_sp /= 0.0  .AND.  &
443            ( dt_dosp - time_dosp ) <= averaging_interval_sp  .AND.  &
444            simulated_time >= skip_time_dosp )  THEN
445          time_dosp_av = time_dosp_av + dt_3d
446          IF ( time_dosp_av >= dt_averaging_input_pr )  THEN
447             CALL calc_spectra
448             time_dosp_av = MOD( time_dosp_av, &
449                                 MAX( dt_averaging_input_pr, dt_3d ) )
450          ENDIF
451       ENDIF
452
453!
454!--    Computation and output of run control parameters.
455!--    This is also done whenever perturbations have been imposed
456       IF ( time_run_control >= dt_run_control  .OR.                     &
457            timestep_scheme(1:5) /= 'runge'  .OR.  disturbance_created ) &
458       THEN
459          CALL run_control
460          IF ( time_run_control >= dt_run_control )  THEN
461             time_run_control = MOD( time_run_control, &
462                                     MAX( dt_run_control, dt_3d ) )
463          ENDIF
464       ENDIF
465
466!
467!--    Profile output (ASCII) on file
468       IF ( time_dopr_listing >= dt_dopr_listing )  THEN
469          CALL print_1d
470          time_dopr_listing = MOD( time_dopr_listing, MAX( dt_dopr_listing, &
471                                                           dt_3d ) )
472       ENDIF
473
474!
475!--    Graphic output for PROFIL
476       IF ( time_dopr >= dt_dopr )  THEN
477          IF ( dopr_n /= 0 )  CALL data_output_profiles
478          time_dopr = MOD( time_dopr, MAX( dt_dopr, dt_3d ) )
479          time_dopr_av = 0.0    ! due to averaging (see above)
480       ENDIF
481
482!
483!--    Graphic output for time series
484       IF ( time_dots >= dt_dots )  THEN
485          CALL data_output_tseries
486          time_dots = MOD( time_dots, MAX( dt_dots, dt_3d ) )
487       ENDIF
488
489!
490!--    Output of spectra (formatted for use with PROFIL), in case of no
491!--    time averaging, spectra has to be calculated before
492       IF ( time_dosp >= dt_dosp )  THEN
493          IF ( average_count_sp == 0 )  CALL calc_spectra
494          CALL data_output_spectra
495          time_dosp = MOD( time_dosp, MAX( dt_dosp, dt_3d ) )
496       ENDIF
497
498!
499!--    2d-data output (cross-sections)
500       IF ( time_do2d_xy >= dt_do2d_xy )  THEN
501          CALL data_output_2d( 'xy', 0 )
502          time_do2d_xy = MOD( time_do2d_xy, MAX( dt_do2d_xy, dt_3d ) )
503       ENDIF
504       IF ( time_do2d_xz >= dt_do2d_xz )  THEN
505          CALL data_output_2d( 'xz', 0 )
506          time_do2d_xz = MOD( time_do2d_xz, MAX( dt_do2d_xz, dt_3d ) )
507       ENDIF
508       IF ( time_do2d_yz >= dt_do2d_yz )  THEN
509          CALL data_output_2d( 'yz', 0 )
510          time_do2d_yz = MOD( time_do2d_yz, MAX( dt_do2d_yz, dt_3d ) )
511       ENDIF
512
513!
514!--    3d-data output (volume data)
515       IF ( time_do3d >= dt_do3d )  THEN
516          CALL data_output_3d( 0 )
517          time_do3d = MOD( time_do3d, MAX( dt_do3d, dt_3d ) )
518       ENDIF
519
520!
521!--    masked data output
522       DO  mid = 1, masks
523          IF ( time_domask(mid) >= dt_domask(mid) )  THEN
524             CALL data_output_mask( 0 )
525             time_domask(mid) = MOD( time_domask(mid),  &
526                                     MAX( dt_domask(mid), dt_3d ) )
527          ENDIF
528       ENDDO
529
530!
531!--    Output of time-averaged 2d/3d/masked data
532       IF ( time_do_av >= dt_data_output_av )  THEN
533          CALL average_3d_data
534          CALL data_output_2d( 'xy', 1 )
535          CALL data_output_2d( 'xz', 1 )
536          CALL data_output_2d( 'yz', 1 )
537          CALL data_output_3d( 1 )
538          DO  mid = 1, masks
539             CALL data_output_mask( 1 )
540          ENDDO
541          time_do_av = MOD( time_do_av, MAX( dt_data_output_av, dt_3d ) )
542       ENDIF
543
544!
545!--    Output of particle time series
546       IF ( particle_advection )  THEN
547          IF ( time_dopts >= dt_dopts  .OR. &
548               ( simulated_time >= particle_advection_start  .AND. &
549                 first_call_lpm ) )  THEN
550             CALL data_output_ptseries
551             time_dopts = MOD( time_dopts, MAX( dt_dopts, dt_3d ) )
552          ENDIF
553       ENDIF
554
555!
556!--    Output of dvrp-graphics (isosurface, particles, slicer)
557#if defined( __dvrp_graphics )
558       CALL DVRP_LOG_EVENT( -2, current_timestep_number-1 )
559#endif
560       IF ( time_dvrp >= dt_dvrp )  THEN
561          CALL data_output_dvrp
562          time_dvrp = MOD( time_dvrp, MAX( dt_dvrp, dt_3d ) )
563       ENDIF
564#if defined( __dvrp_graphics )
565       CALL DVRP_LOG_EVENT( 2, current_timestep_number )
566#endif
567
568!
569!--    If required, set the heat flux for the next time step at a random value
570       IF ( constant_heatflux  .AND.  random_heatflux )  CALL disturb_heatflux
571
572!
573!--    Execute user-defined actions
574       CALL user_actions( 'after_timestep' )
575
576       CALL cpu_log( log_point_s(10), 'timesteps', 'stop' )
577
578
579    ENDDO   ! time loop
580
581#if defined( __dvrp_graphics )
582    CALL DVRP_LOG_EVENT( -2, current_timestep_number )
583#endif
584
585 END SUBROUTINE time_integration
Note: See TracBrowser for help on using the repository browser.