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

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

last commit documented

  • Property svn:keywords set to Id
File size: 44.1 KB
Line 
1!> @file time_integration.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2015 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! ------------------
21!
22!
23! Former revisions:
24! -----------------
25! $Id: time_integration.f90 1782 2016-03-03 15:39:25Z raasch $
26!
27! 1781 2016-03-03 15:12:23Z raasch
28! some pmc calls removed at the beginning (before timeloop),
29! pmc initialization moved to the main program
30!
31! 1764 2016-02-28 12:45:19Z raasch
32! PMC_ACTIVE flags removed,
33! bugfix: nest synchronization after first call of timestep
34!
35! 1762 2016-02-25 12:31:13Z hellstea
36! Introduction of nested domain feature
37!
38! 1736 2015-12-04 08:56:33Z raasch
39! no perturbations added to total domain if energy limit has been set zero
40!
41! 1691 2015-10-26 16:17:44Z maronga
42! Added option for spin-ups without land surface and radiation models. Moved calls
43! for radiation and lan surface schemes.
44!
45! 1682 2015-10-07 23:56:08Z knoop
46! Code annotations made doxygen readable
47!
48! 1671 2015-09-25 03:29:37Z raasch
49! bugfix: ghostpoint exchange for array diss in case that sgs velocities are used
50! for particles
51!
52! 1585 2015-04-30 07:05:52Z maronga
53! Moved call of radiation scheme. Added support for RRTM
54!
55! 1551 2015-03-03 14:18:16Z maronga
56! Added interface for different radiation schemes.
57!
58! 1496 2014-12-02 17:25:50Z maronga
59! Added calls for the land surface model and radiation scheme
60!
61! 1402 2014-05-09 14:25:13Z raasch
62! location messages modified
63!
64! 1384 2014-05-02 14:31:06Z raasch
65! location messages added
66!
67! 1380 2014-04-28 12:40:45Z heinze
68! CALL of nudge_ref added
69! bc_pt_t_val and bc_q_t_val are updated in case nudging is used
70!
71! 1365 2014-04-22 15:03:56Z boeske
72! Reset sums_ls_l to zero at each timestep
73! +sums_ls_l
74! Calculation of reference state (previously in subroutine calc_mean_profile)
75
76! 1342 2014-03-26 17:04:47Z kanani
77! REAL constants defined as wp-kind
78!
79! 1320 2014-03-20 08:40:49Z raasch
80! ONLY-attribute added to USE-statements,
81! kind-parameters added to all INTEGER and REAL declaration statements,
82! kinds are defined in new module kinds,
83! old module precision_kind is removed,
84! revision history before 2012 removed,
85! comment fields (!:) to be used for variable explanations added to
86! all variable declaration statements
87! 1318 2014-03-17 13:35:16Z raasch
88! module interfaces removed
89!
90! 1308 2014-03-13 14:58:42Z fricke
91! +netcdf_data_format_save
92! For masked data, parallel netcdf output is not tested so far, hence
93! netcdf_data_format is switched back to non-paralell output.
94!
95! 1276 2014-01-15 13:40:41Z heinze
96! Use LSF_DATA also in case of Dirichlet bottom boundary condition for scalars
97!
98! 1257 2013-11-08 15:18:40Z raasch
99! acc-update-host directive for timestep removed
100!
101! 1241 2013-10-30 11:36:58Z heinze
102! Generalize calc_mean_profile for wider use
103! Determine shf and qsws in dependence on data from LSF_DATA
104! Determine ug and vg in dependence on data from LSF_DATA
105! 1221 2013-09-10 08:59:13Z raasch
106! host update of arrays before timestep is called
107!
108! 1179 2013-06-14 05:57:58Z raasch
109! mean profiles for reference state are only calculated if required,
110! small bugfix for background communication
111!
112! 1171 2013-05-30 11:27:45Z raasch
113! split of prognostic_equations deactivated (comment lines), for the time being
114!
115! 1128 2013-04-12 06:19:32Z raasch
116! asynchronous transfer of ghost point data realized for acc-optimized version:
117! prognostic_equations are first called two times for those points required for
118! the left-right and north-south exchange, respectively, and then for the
119! remaining points,
120! those parts requiring global communication moved from prognostic_equations to
121! here
122!
123! 1115 2013-03-26 18:16:16Z hoffmann
124! calculation of qr and nr is restricted to precipitation
125!
126! 1113 2013-03-10 02:48:14Z raasch
127! GPU-porting of boundary conditions,
128! openACC directives updated
129! formal parameter removed from routine boundary_conds
130!
131! 1111 2013-03-08 23:54:10Z raasch
132! +internal timestep counter for cpu statistics added,
133! openACC directives updated
134!
135! 1092 2013-02-02 11:24:22Z raasch
136! unused variables removed
137!
138! 1065 2012-11-22 17:42:36Z hoffmann
139! exchange of diss (dissipation rate) in case of turbulence = .TRUE. added
140!
141! 1053 2012-11-13 17:11:03Z hoffmann
142! exchange of ghost points for nr, qr added
143!
144! 1036 2012-10-22 13:43:42Z raasch
145! code put under GPL (PALM 3.9)
146!
147! 1019 2012-09-28 06:46:45Z raasch
148! non-optimized version of prognostic_equations removed
149!
150! 1015 2012-09-27 09:23:24Z raasch
151! +call of prognostic_equations_acc
152!
153! 1001 2012-09-13 14:08:46Z raasch
154! all actions concerning leapfrog- and upstream-spline-scheme removed
155!
156! 849 2012-03-15 10:35:09Z raasch
157! advec_particles renamed lpm, first_call_advec_particles renamed first_call_lpm
158!
159! 825 2012-02-19 03:03:44Z raasch
160! wang_collision_kernel renamed wang_kernel
161!
162! Revision 1.1  1997/08/11 06:19:04  raasch
163! Initial revision
164!
165!
166! Description:
167! ------------
168!> Integration in time of the model equations, statistical analysis and graphic
169!> output
170!------------------------------------------------------------------------------!
171 SUBROUTINE time_integration
172 
173
174    USE advec_ws,                                                              &
175        ONLY:  ws_statistics
176
177    USE arrays_3d,                                                             &
178        ONLY:  diss, dzu, e, e_p, nr_p, prho, pt, pt_p, pt_init, q_init, q,    &
179               ql, ql_c, ql_v, ql_vp, qr_p, q_p, ref_state, rho, sa_p, tend,   &
180               u, u_p, v, vpt, v_p, w, w_p
181
182    USE calc_mean_profile_mod,                                                 &
183        ONLY:  calc_mean_profile
184
185    USE control_parameters,                                                    &
186        ONLY:  advected_distance_x, advected_distance_y, average_count_3d,     &
187               average_count_sp, averaging_interval, averaging_interval_pr,    &
188               averaging_interval_sp, bc_lr_cyc, bc_ns_cyc, bc_pt_t_val,       &
189               bc_q_t_val, call_psolver_at_all_substeps, cloud_droplets,       &
190               cloud_physics, constant_flux_layer, constant_heatflux,          &
191               create_disturbances, dopr_n, constant_diffusion, coupling_mode, &
192               coupling_start_time, current_timestep_number,                   &
193               disturbance_created, disturbance_energy_limit, dist_range,      &
194               do_sum, dt_3d, dt_averaging_input, dt_averaging_input_pr,       &
195               dt_coupling, dt_data_output_av, dt_disturb, dt_do2d_xy,         &
196               dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_domask,dt_dopts, dt_dopr,   &
197               dt_dopr_listing, dt_dosp, dt_dots, dt_dvrp, dt_run_control,     &
198               end_time, first_call_lpm, galilei_transformation, humidity,     &
199               icloud_scheme, intermediate_timestep_count,                     &
200               intermediate_timestep_count_max, large_scale_forcing,           &
201               loop_optimization, lsf_surf, lsf_vert, masks, mid, nest_domain, &
202               netcdf_data_format, neutral, nr_timesteps_this_run, nudging,    &
203               ocean, on_device, passive_scalar, precipitation,                &
204               prho_reference, pt_reference, pt_slope_offset, random_heatflux, &
205               run_coupled, simulated_time, simulated_time_chr,                &
206               skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,        &
207               skip_time_do3d, skip_time_domask, skip_time_dopr,               &
208               skip_time_dosp, skip_time_data_output_av, sloping_surface,      &
209               stop_dt, terminate_coupled, terminate_run, timestep_scheme,     &
210               time_coupling, time_do2d_xy, time_do2d_xz, time_do2d_yz,        &
211               time_do3d, time_domask, time_dopr, time_dopr_av,                &
212               time_dopr_listing, time_dopts, time_dosp, time_dosp_av,         &
213               time_dots, time_do_av, time_do_sla, time_disturb, time_dvrp,    &
214               time_run_control, time_since_reference_point,                   &
215               turbulence,                                                     &
216               turbulent_inflow, use_initial_profile_as_reference,             &
217               use_single_reference_value, u_gtrans, v_gtrans, ws_scheme_mom,  &
218               ws_scheme_sca
219
220    USE cpulog,                                                                &
221        ONLY:  cpu_log, log_point, log_point_s
222
223    USE indices,                                                               &
224        ONLY:  i_left, i_right, j_north, j_south, nbgp, nx, nxl, nxlg, nxr,    &
225               nxrg, nyn, nys, nzb, nzt, nzb_u_inner, nzb_v_inner 
226
227    USE interaction_droplets_ptq_mod,                                          &
228        ONLY:  interaction_droplets_ptq
229
230    USE kinds
231
232    USE land_surface_model_mod,                                                &
233        ONLY:  land_surface, lsm_energy_balance, lsm_soil_model,               &
234               skip_time_do_lsm
235
236    USE ls_forcing_mod,                                                        &
237        ONLY:  ls_forcing_surf, ls_forcing_vert
238
239    USE nudge_mod,                                                             &
240        ONLY:  calc_tnudge, nudge_ref
241
242    USE particle_attributes,                                                   &
243        ONLY:  particle_advection, particle_advection_start,                   &
244               use_sgs_for_particles, wang_kernel
245
246    USE pegrid
247
248    USE pmc_interface,                                                         &
249        ONLY:  client_to_server, nested_run, nesting_mode,                     &
250               pmci_ensure_nest_mass_conservation, pmci_client_datatrans,      &
251               pmci_client_synchronize, pmci_server_datatrans,                 &
252               pmci_server_synchronize, pmci_update_new, server_to_client
253
254    USE production_e_mod,                                                      &
255        ONLY:  production_e_init
256
257    USE progress_bar,                                                          &
258        ONLY:  finish_progress_bar, output_progress_bar
259
260    USE prognostic_equations_mod,                                              &
261        ONLY:  prognostic_equations_acc, prognostic_equations_cache,           &
262               prognostic_equations_vector
263
264    USE radiation_model_mod,                                                   &
265        ONLY: dt_radiation, force_radiation_call, radiation,                   &
266              radiation_clearsky, radiation_rrtmg, radiation_scheme,           &
267              skip_time_do_radiation, time_radiation
268
269    USE statistics,                                                            &
270        ONLY:  flow_statistics_called, hom, pr_palm, sums_ls_l
271
272    USE surface_layer_fluxes_mod,                                              &
273        ONLY:  surface_layer_fluxes
274
275    USE user_actions_mod,                                                      &
276        ONLY:  user_actions
277
278    IMPLICIT NONE
279
280    CHARACTER (LEN=9) ::  time_to_string          !<
281
282    INTEGER(iwp)      ::  netcdf_data_format_save !<
283
284!
285!-- At the beginning of a simulation determine the time step as well as
286!-- determine and print out the run control parameters
287    IF ( simulated_time == 0.0_wp )  CALL timestep
288
289!
290!-- Synchronize the timestep in case of nested run.
291!-- The server side must be called first
292    IF ( nested_run )  THEN
293       CALL pmci_server_synchronize
294       CALL pmci_client_synchronize
295    ENDIF
296
297    CALL run_control
298
299!
300!-- Data exchange between coupled models in case that a call has been omitted
301!-- at the end of the previous run of a job chain.
302    IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled )  THEN
303!
304!--    In case of model termination initiated by the local model the coupler
305!--    must not be called because this would again cause an MPI hang.
306       DO WHILE ( time_coupling >= dt_coupling .AND. terminate_coupled == 0 )
307          CALL surface_coupler
308          time_coupling = time_coupling - dt_coupling
309       ENDDO
310       IF (time_coupling == 0.0_wp .AND. time_since_reference_point < dt_coupling)&
311       THEN
312          time_coupling = time_since_reference_point
313       ENDIF
314    ENDIF
315
316#if defined( __dvrp_graphics )
317!
318!-- Time measurement with dvrp software 
319    CALL DVRP_LOG_EVENT( 2, current_timestep_number )
320#endif
321
322    CALL location_message( 'start with time-stepping', .TRUE. )
323!
324!-- Start of the time loop
325    DO  WHILE ( simulated_time < end_time  .AND.  .NOT. stop_dt  .AND. &
326                .NOT. terminate_run )
327
328       CALL cpu_log( log_point_s(10), 'timesteps', 'start' )
329
330!
331!--    Determine size of next time step
332       IF ( simulated_time /= 0.0_wp )  THEN
333          CALL timestep
334
335          IF ( nested_run )  THEN
336!
337!--          TO_DO: try to give more detailed and meaningful comments here
338!--          Server side must be called first
339             CALL pmci_server_synchronize
340             CALL pmci_client_synchronize
341          ENDIF
342       ENDIF
343
344
345!
346!--    Determine ug, vg and w_subs in dependence on data from external file
347!--    LSF_DATA
348       IF ( large_scale_forcing .AND. lsf_vert )  THEN
349           CALL ls_forcing_vert ( simulated_time )
350           sums_ls_l = 0.0_wp
351       ENDIF
352
353!
354!--    Set pt_init and q_init to the current profiles taken from
355!--    NUDGING_DATA
356       IF ( nudging )  THEN
357           CALL nudge_ref ( simulated_time )
358!
359!--        Store temperature gradient at the top boundary for possible Neumann
360!--        boundary condition
361           bc_pt_t_val = ( pt_init(nzt+1) - pt_init(nzt) ) / dzu(nzt+1)
362           bc_q_t_val  = ( q_init(nzt+1) - q_init(nzt) ) / dzu(nzt+1)
363       ENDIF
364
365!
366!--    Execute the user-defined actions
367       CALL user_actions( 'before_timestep' )
368
369!
370!--    Start of intermediate step loop
371       intermediate_timestep_count = 0
372       DO  WHILE ( intermediate_timestep_count < &
373                   intermediate_timestep_count_max )
374
375          intermediate_timestep_count = intermediate_timestep_count + 1
376
377!
378!--       Set the steering factors for the prognostic equations which depend
379!--       on the timestep scheme
380          CALL timestep_scheme_steering
381
382!
383!--       Calculate those variables needed in the tendency terms which need
384!--       global communication
385          IF ( .NOT. use_single_reference_value  .AND. &
386               .NOT. use_initial_profile_as_reference )  THEN
387!
388!--          Horizontally averaged profiles to be used as reference state in
389!--          buoyancy terms (WARNING: only the respective last call of
390!--          calc_mean_profile defines the reference state!)
391             IF ( .NOT. neutral )  THEN
392                CALL calc_mean_profile( pt, 4 )
393                ref_state(:)  = hom(:,1,4,0) ! this is used in the buoyancy term
394             ENDIF
395             IF ( ocean )  THEN
396                CALL calc_mean_profile( rho, 64 )
397                ref_state(:)  = hom(:,1,64,0)
398             ENDIF
399             IF ( humidity )  THEN
400                CALL calc_mean_profile( vpt, 44 )
401                ref_state(:)  = hom(:,1,44,0)
402             ENDIF
403
404          ENDIF
405
406          IF ( .NOT. constant_diffusion )  CALL production_e_init
407          IF ( ( ws_scheme_mom .OR. ws_scheme_sca )  .AND.  &
408               intermediate_timestep_count == 1 )  CALL ws_statistics
409!
410!--       In case of nudging calculate current nudging time scale and horizontal
411!--       means of u, v, pt and q
412          IF ( nudging )  THEN
413             CALL calc_tnudge( simulated_time )
414             CALL calc_mean_profile( u, 1 )
415             CALL calc_mean_profile( v, 2 )
416             CALL calc_mean_profile( pt, 4 )
417             CALL calc_mean_profile( q, 41 )
418          ENDIF
419
420!
421!--       Solve the prognostic equations. A fast cache optimized version with
422!--       only one single loop is used in case of Piascek-Williams advection
423!--       scheme. NEC vector machines use a different version, because
424!--       in the other versions a good vectorization is prohibited due to
425!--       inlining problems.
426          IF ( loop_optimization == 'cache' )  THEN
427             CALL prognostic_equations_cache
428          ELSEIF ( loop_optimization == 'vector' )  THEN
429             CALL prognostic_equations_vector
430          ELSEIF ( loop_optimization == 'acc' )  THEN
431             i_left  = nxl;         i_right = nxr
432             j_south = nys;         j_north = nyn
433             CALL prognostic_equations_acc
434
435!             i_left  = nxl;         i_right = nxl+nbgp-1
436!             j_south = nys;         j_north = nyn
437!             CALL prognostic_equations_acc
438!             i_left  = nxr-nbgp+1;  i_right = nxr
439!             j_south = nys;         j_north = nyn
440!             CALL prognostic_equations_acc
441
442!
443!--          Exchange of ghost points (lateral boundary conditions)
444             IF ( background_communication )  THEN
445
446                CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'start' )
447               
448                send_receive = 'lr'
449                sendrecv_in_background = .TRUE.
450                req          = 0
451                req_count    = 0
452
453                IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
454                   on_device = .TRUE.         ! to be removed after complete porting
455                ELSE                          ! of ghost point exchange
456                   !$acc update host( e_p, pt_p, u_p, v_p, w_p )
457                ENDIF
458
459                CALL exchange_horiz( u_p, nbgp )
460                CALL exchange_horiz( v_p, nbgp )
461                CALL exchange_horiz( w_p, nbgp )
462                CALL exchange_horiz( pt_p, nbgp )
463                IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e_p, nbgp )
464                IF ( ocean )  THEN
465                   CALL exchange_horiz( sa_p, nbgp )
466                   CALL exchange_horiz( rho, nbgp )
467                  CALL exchange_horiz( prho, nbgp )
468                ENDIF
469                IF (humidity  .OR.  passive_scalar)  THEN
470                   CALL exchange_horiz( q_p, nbgp )
471                   IF ( cloud_physics .AND. icloud_scheme == 0 )  THEN
472                      CALL exchange_horiz( qr_p, nbgp )
473                      CALL exchange_horiz( nr_p, nbgp )
474                   ENDIF
475                ENDIF
476                IF ( cloud_droplets )  THEN
477                   CALL exchange_horiz( ql, nbgp )
478                   CALL exchange_horiz( ql_c, nbgp )
479                   CALL exchange_horiz( ql_v, nbgp )
480                   CALL exchange_horiz( ql_vp, nbgp )
481                ENDIF
482                IF ( wang_kernel  .OR.  turbulence  .OR.  use_sgs_for_particles ) &
483                THEN
484                   CALL exchange_horiz( diss, nbgp )
485                ENDIF
486
487                IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
488                   on_device = .FALSE.        ! to be removed after complete porting
489                ELSE                          ! of ghost point exchange
490                   !$acc update device( e_p, pt_p, u_p, v_p, w_p )
491                ENDIF
492
493                sendrecv_in_background = .FALSE.
494
495                CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'pause' )
496
497             ENDIF
498
499!             i_left  = nxl+nbgp;    i_right = nxr-nbgp
500!             j_south = nys;         j_north = nys+nbgp-1
501!             CALL prognostic_equations_acc
502!             i_left  = nxl+nbgp;    i_right = nxr-nbgp
503!             j_south = nyn-nbgp+1;  j_north = nyn
504!             CALL prognostic_equations_acc
505
506             IF ( background_communication )  THEN
507                CALL cpu_log( log_point(41), 'exchange-horiz-wait', 'start' )
508#if defined( __parallel )
509                CALL MPI_WAITALL( req_count, req, wait_stat, ierr )
510#endif
511                CALL cpu_log( log_point(41), 'exchange-horiz-wait', 'pause' )
512
513                CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'continue' )
514
515                send_receive = 'ns'
516                sendrecv_in_background = .TRUE.
517                req          = 0
518                req_count    = 0
519
520                IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
521                   on_device = .TRUE.         ! to be removed after complete porting
522                ELSE                          ! of ghost point exchange
523                   !$acc update host( e_p, pt_p, u_p, v_p, w_p )
524                ENDIF
525
526                CALL exchange_horiz( u_p, nbgp )
527                CALL exchange_horiz( v_p, nbgp )
528                CALL exchange_horiz( w_p, nbgp )
529                CALL exchange_horiz( pt_p, nbgp )
530                IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e_p, nbgp )
531                IF ( ocean )  THEN
532                   CALL exchange_horiz( sa_p, nbgp )
533                   CALL exchange_horiz( rho, nbgp )
534                  CALL exchange_horiz( prho, nbgp )
535                ENDIF
536                IF (humidity  .OR.  passive_scalar)  THEN
537                   CALL exchange_horiz( q_p, nbgp )
538                   IF ( cloud_physics .AND. icloud_scheme == 0 )  THEN
539                      CALL exchange_horiz( qr_p, nbgp )
540                      CALL exchange_horiz( nr_p, nbgp )
541                   ENDIF
542                ENDIF
543                IF ( cloud_droplets )  THEN
544                   CALL exchange_horiz( ql, nbgp )
545                   CALL exchange_horiz( ql_c, nbgp )
546                   CALL exchange_horiz( ql_v, nbgp )
547                   CALL exchange_horiz( ql_vp, nbgp )
548                ENDIF
549                IF ( wang_kernel  .OR.  turbulence  .OR.  use_sgs_for_particles ) &
550                THEN
551                   CALL exchange_horiz( diss, nbgp )
552                ENDIF
553
554                IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
555                   on_device = .FALSE.        ! to be removed after complete porting
556                ELSE                          ! of ghost point exchange
557                   !$acc update device( e_p, pt_p, u_p, v_p, w_p )
558                ENDIF
559
560                sendrecv_in_background = .FALSE.
561
562                CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'stop' )
563
564             ENDIF
565
566!             i_left  = nxl+nbgp;    i_right = nxr-nbgp
567!             j_south = nys+nbgp;    j_north = nyn-nbgp
568!             CALL prognostic_equations_acc
569
570             IF ( background_communication )  THEN
571                CALL cpu_log( log_point(41), 'exchange-horiz-wait', 'continue' )
572#if defined( __parallel )
573                CALL MPI_WAITALL( req_count, req, wait_stat, ierr )
574#endif
575                send_receive = 'al'
576                CALL cpu_log( log_point(41), 'exchange-horiz-wait', 'stop' )
577             ENDIF
578
579          ENDIF
580
581!
582!--       Particle transport/physics with the Lagrangian particle model
583!--       (only once during intermediate steps, because it uses an Euler-step)
584!--       ### particle model should be moved before prognostic_equations, in order
585!--       to regard droplet interactions directly
586          IF ( particle_advection  .AND.                         &
587               simulated_time >= particle_advection_start  .AND. &
588               intermediate_timestep_count == 1 )  THEN
589             CALL lpm
590             first_call_lpm = .FALSE.
591          ENDIF
592
593!
594!--       Interaction of droplets with temperature and specific humidity.
595!--       Droplet condensation and evaporation is calculated within
596!--       advec_particles.
597          IF ( cloud_droplets  .AND.  &
598               intermediate_timestep_count == intermediate_timestep_count_max )&
599          THEN
600             CALL interaction_droplets_ptq
601          ENDIF
602
603!
604!--       Exchange of ghost points (lateral boundary conditions)
605          IF ( .NOT. background_communication )  THEN
606
607             CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'start' )
608
609             IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
610                on_device = .TRUE.         ! to be removed after complete porting
611             ELSE                          ! of ghost point exchange
612                !$acc update host( e_p, pt_p, u_p, v_p, w_p )
613             ENDIF
614
615             CALL exchange_horiz( u_p, nbgp )
616             CALL exchange_horiz( v_p, nbgp )
617             CALL exchange_horiz( w_p, nbgp )
618             CALL exchange_horiz( pt_p, nbgp )
619             IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e_p, nbgp )
620             IF ( ocean )  THEN
621                CALL exchange_horiz( sa_p, nbgp )
622                CALL exchange_horiz( rho, nbgp )
623                CALL exchange_horiz( prho, nbgp )
624             ENDIF
625             IF (humidity  .OR.  passive_scalar)  THEN
626                CALL exchange_horiz( q_p, nbgp )
627                IF ( cloud_physics .AND. icloud_scheme == 0  .AND.  &
628                     precipitation )  THEN
629                   CALL exchange_horiz( qr_p, nbgp )
630                   CALL exchange_horiz( nr_p, nbgp )
631                ENDIF
632             ENDIF
633             IF ( cloud_droplets )  THEN
634                CALL exchange_horiz( ql, nbgp )
635                CALL exchange_horiz( ql_c, nbgp )
636                CALL exchange_horiz( ql_v, nbgp )
637                CALL exchange_horiz( ql_vp, nbgp )
638             ENDIF
639             IF ( wang_kernel  .OR.  turbulence  .OR.  use_sgs_for_particles ) &
640             THEN
641                CALL exchange_horiz( diss, nbgp )
642             ENDIF
643
644             IF ( numprocs == 1 )  THEN    ! workaround for single-core GPU runs
645                on_device = .FALSE.        ! to be removed after complete porting
646             ELSE                          ! of ghost point exchange
647                !$acc update device( e_p, pt_p, u_p, v_p, w_p )
648             ENDIF
649
650             CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'stop' )
651
652          ENDIF
653
654!
655!--       Boundary conditions for the prognostic quantities (except of the
656!--       velocities at the outflow in case of a non-cyclic lateral wall)
657          CALL boundary_conds
658
659!
660!--       Swap the time levels in preparation for the next time step.
661          CALL swap_timelevel
662
663          IF ( nested_run )  THEN
664!
665!--          TO_DO: try to give more meaningful comments here
666!--          Domain nesting
667!--          Note that the nesting operations are omitted intentionally on the
668!--          first two RK-substeps.
669             CALL cpu_log( log_point(60), 'nesting', 'start' )
670!
671!--          From server to client commmunication ( direction=SERVER_TO_CLIENT )
672             CALL pmci_server_datatrans( server_to_client )
673             CALL pmci_client_datatrans( server_to_client )
674
675             IF ( nesting_mode == 'two-way' )  THEN
676!
677!--             From client to server commmunication ( direction=CLIENT_TO_SERVER )
678                CALL pmci_server_datatrans( client_to_server )
679                CALL pmci_client_datatrans( client_to_server )
680!
681!--             Exchange_horiz is needed for all server-domains after the
682!--             anterpolation
683                CALL exchange_horiz( u, nbgp )
684                CALL exchange_horiz( v, nbgp )
685                CALL exchange_horiz( w, nbgp )
686                CALL exchange_horiz( pt, nbgp )
687                IF ( humidity  .OR.  passive_scalar )  THEN
688                   CALL exchange_horiz( q, nbgp )
689                ENDIF
690                IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e, nbgp )
691             ENDIF
692!
693!--          Correct the w top-BC in nest domains to ensure mass conservation.
694!--          This action must never be done for the root domain.
695             IF ( nest_domain )  THEN
696                CALL pmci_ensure_nest_mass_conservation
697!
698!--             pmc_update_new is not necessary if nesting is made at each
699!--             substep
700                CALL pmci_update_new
701             ENDIF
702
703             CALL cpu_log( log_point(60), 'nesting', 'stop' )
704
705          ENDIF
706
707!
708!--       Temperature offset must be imposed at cyclic boundaries in x-direction
709!--       when a sloping surface is used
710          IF ( sloping_surface )  THEN
711             IF ( nxl ==  0 )  pt(:,:,nxlg:nxl-1) = pt(:,:,nxlg:nxl-1) - &
712                                                    pt_slope_offset
713             IF ( nxr == nx )  pt(:,:,nxr+1:nxrg) = pt(:,:,nxr+1:nxrg) + &
714                                                    pt_slope_offset
715          ENDIF
716
717!
718!--       Impose a turbulent inflow using the recycling method
719          IF ( turbulent_inflow )  CALL  inflow_turbulence
720
721!
722!--       Impose a random perturbation on the horizontal velocity field
723          IF ( create_disturbances  .AND.                                      &
724               ( call_psolver_at_all_substeps  .AND.                           &
725               intermediate_timestep_count == intermediate_timestep_count_max )&
726          .OR. ( .NOT. call_psolver_at_all_substeps  .AND.                     &
727               intermediate_timestep_count == 1 ) )                            &
728          THEN
729             time_disturb = time_disturb + dt_3d
730             IF ( time_disturb >= dt_disturb )  THEN
731                !$acc update host( u, v )
732                IF ( numprocs == 1 )  on_device = .FALSE.  ! workaround, remove later
733                IF ( disturbance_energy_limit /= 0.0_wp  .AND.                 &
734                     hom(nzb+5,1,pr_palm,0) < disturbance_energy_limit )  THEN
735                   CALL disturb_field( nzb_u_inner, tend, u )
736                   CALL disturb_field( nzb_v_inner, tend, v )
737                ELSEIF ( .NOT. bc_lr_cyc  .OR.  .NOT. bc_ns_cyc )  THEN
738!
739!--                Runs with a non-cyclic lateral wall need perturbations
740!--                near the inflow throughout the whole simulation
741                   dist_range = 1
742                   CALL disturb_field( nzb_u_inner, tend, u )
743                   CALL disturb_field( nzb_v_inner, tend, v )
744                   dist_range = 0
745                ENDIF
746                IF ( numprocs == 1 )  on_device = .TRUE.  ! workaround, remove later
747                !$acc update device( u, v )
748                time_disturb = time_disturb - dt_disturb
749             ENDIF
750          ENDIF
751
752!
753!--       Reduce the velocity divergence via the equation for perturbation
754!--       pressure.
755          IF ( intermediate_timestep_count == 1  .OR. &
756                call_psolver_at_all_substeps )  THEN
757             CALL pres
758          ENDIF
759
760!
761!--       If required, compute liquid water content
762          IF ( cloud_physics )  THEN
763             CALL calc_liquid_water_content
764             !$acc update device( ql )
765          ENDIF
766!
767!--       If required, compute virtual potential temperature
768          IF ( humidity )  THEN
769             CALL compute_vpt 
770             !$acc update device( vpt )
771          ENDIF 
772
773!
774!--       Compute the diffusion quantities
775          IF ( .NOT. constant_diffusion )  THEN
776
777!
778!--          Determine surface fluxes shf and qsws and surface values
779!--          pt_surface and q_surface in dependence on data from external
780!--          file LSF_DATA respectively
781             IF ( ( large_scale_forcing .AND. lsf_surf ) .AND. &
782                 intermediate_timestep_count == intermediate_timestep_count_max )&
783             THEN
784                CALL ls_forcing_surf ( simulated_time )
785             ENDIF
786
787!
788!--          First the vertical fluxes in the surface (constant flux) layer are computed
789             IF ( constant_flux_layer )  THEN
790                CALL cpu_log( log_point(19), 'surface_layer_fluxes', 'start' )
791                CALL surface_layer_fluxes
792                CALL cpu_log( log_point(19), 'surface_layer_fluxes', 'stop' )
793             ENDIF
794
795!
796!--          If required, solve the energy balance for the surface and run soil
797!--          model
798             IF ( land_surface .AND. simulated_time > skip_time_do_lsm)  THEN
799
800                CALL cpu_log( log_point(54), 'land_surface', 'start' )
801                CALL lsm_energy_balance
802                CALL lsm_soil_model
803                CALL cpu_log( log_point(54), 'land_surface', 'stop' )
804             ENDIF
805!
806!--          Compute the diffusion coefficients
807             CALL cpu_log( log_point(17), 'diffusivities', 'start' )
808             IF ( .NOT. humidity ) THEN
809                IF ( ocean )  THEN
810                   CALL diffusivities( prho, prho_reference )
811                ELSE
812                   CALL diffusivities( pt, pt_reference )
813                ENDIF
814             ELSE
815                CALL diffusivities( vpt, pt_reference )
816             ENDIF
817             CALL cpu_log( log_point(17), 'diffusivities', 'stop' )
818
819          ENDIF
820
821!
822!--       If required, calculate radiative fluxes and heating rates
823          IF ( radiation .AND. intermediate_timestep_count                     &
824               == intermediate_timestep_count_max .AND. simulated_time >    &
825               skip_time_do_radiation )  THEN
826
827               time_radiation = time_radiation + dt_3d
828
829             IF ( time_radiation >= dt_radiation .OR. force_radiation_call )   &
830             THEN
831
832                CALL cpu_log( log_point(50), 'radiation', 'start' )
833
834                IF ( .NOT. force_radiation_call )  THEN
835                   time_radiation = time_radiation - dt_radiation
836                ELSE
837                   WRITE(9,*) "Unscheduled radiation call at ", simulated_time
838                   CALL LOCAL_FLUSH ( 9 )
839                ENDIF
840
841                IF ( radiation_scheme == 'clear-sky' )  THEN
842                   CALL radiation_clearsky
843                ELSEIF ( radiation_scheme == 'rrtmg' )  THEN
844                   CALL radiation_rrtmg
845                ENDIF
846
847                CALL cpu_log( log_point(50), 'radiation', 'stop' )
848             ENDIF
849          ENDIF
850
851       ENDDO   ! Intermediate step loop
852
853!
854!--    Increase simulation time and output times
855       nr_timesteps_this_run      = nr_timesteps_this_run + 1
856       current_timestep_number    = current_timestep_number + 1
857       simulated_time             = simulated_time   + dt_3d
858       simulated_time_chr         = time_to_string( simulated_time )
859       time_since_reference_point = simulated_time - coupling_start_time
860
861       IF ( simulated_time >= skip_time_data_output_av )  THEN
862          time_do_av         = time_do_av       + dt_3d
863       ENDIF
864       IF ( simulated_time >= skip_time_do2d_xy )  THEN
865          time_do2d_xy       = time_do2d_xy     + dt_3d
866       ENDIF
867       IF ( simulated_time >= skip_time_do2d_xz )  THEN
868          time_do2d_xz       = time_do2d_xz     + dt_3d
869       ENDIF
870       IF ( simulated_time >= skip_time_do2d_yz )  THEN
871          time_do2d_yz       = time_do2d_yz     + dt_3d
872       ENDIF
873       IF ( simulated_time >= skip_time_do3d    )  THEN
874          time_do3d          = time_do3d        + dt_3d
875       ENDIF
876       DO  mid = 1, masks
877          IF ( simulated_time >= skip_time_domask(mid) )  THEN
878             time_domask(mid)= time_domask(mid) + dt_3d
879          ENDIF
880       ENDDO
881       time_dvrp          = time_dvrp        + dt_3d
882       IF ( simulated_time >= skip_time_dosp )  THEN
883          time_dosp       = time_dosp        + dt_3d
884       ENDIF
885       time_dots          = time_dots        + dt_3d
886       IF ( .NOT. first_call_lpm )  THEN
887          time_dopts      = time_dopts       + dt_3d
888       ENDIF
889       IF ( simulated_time >= skip_time_dopr )  THEN
890          time_dopr       = time_dopr        + dt_3d
891       ENDIF
892       time_dopr_listing          = time_dopr_listing        + dt_3d
893       time_run_control   = time_run_control + dt_3d
894
895!
896!--    Data exchange between coupled models
897       IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled )  THEN
898          time_coupling = time_coupling + dt_3d
899
900!
901!--       In case of model termination initiated by the local model
902!--       (terminate_coupled > 0), the coupler must be skipped because it would
903!--       cause an MPI intercomminucation hang.
904!--       If necessary, the coupler will be called at the beginning of the
905!--       next restart run.
906          DO WHILE ( time_coupling >= dt_coupling .AND. terminate_coupled == 0 )
907             CALL surface_coupler
908             time_coupling = time_coupling - dt_coupling
909          ENDDO
910       ENDIF
911
912!
913!--    Execute user-defined actions
914       CALL user_actions( 'after_integration' )
915
916!
917!--    If Galilei transformation is used, determine the distance that the
918!--    model has moved so far
919       IF ( galilei_transformation )  THEN
920          advected_distance_x = advected_distance_x + u_gtrans * dt_3d
921          advected_distance_y = advected_distance_y + v_gtrans * dt_3d
922       ENDIF
923
924!
925!--    Check, if restart is necessary (because cpu-time is expiring or
926!--    because it is forced by user) and set stop flag
927!--    This call is skipped if the remote model has already initiated a restart.
928       IF ( .NOT. terminate_run )  CALL check_for_restart
929
930!
931!--    Carry out statistical analysis and output at the requested output times.
932!--    The MOD function is used for calculating the output time counters (like
933!--    time_dopr) in order to regard a possible decrease of the output time
934!--    interval in case of restart runs
935
936!
937!--    Set a flag indicating that so far no statistics have been created
938!--    for this time step
939       flow_statistics_called = .FALSE.
940
941!
942!--    If required, call flow_statistics for averaging in time
943       IF ( averaging_interval_pr /= 0.0_wp  .AND.  &
944            ( dt_dopr - time_dopr ) <= averaging_interval_pr  .AND.  &
945            simulated_time >= skip_time_dopr )  THEN
946          time_dopr_av = time_dopr_av + dt_3d
947          IF ( time_dopr_av >= dt_averaging_input_pr )  THEN
948             do_sum = .TRUE.
949             time_dopr_av = MOD( time_dopr_av, &
950                                    MAX( dt_averaging_input_pr, dt_3d ) )
951          ENDIF
952       ENDIF
953       IF ( do_sum )  CALL flow_statistics
954
955!
956!--    Sum-up 3d-arrays for later output of time-averaged 2d/3d/masked data
957       IF ( averaging_interval /= 0.0_wp  .AND.                                &
958            ( dt_data_output_av - time_do_av ) <= averaging_interval  .AND. &
959            simulated_time >= skip_time_data_output_av )                    &
960       THEN
961          time_do_sla = time_do_sla + dt_3d
962          IF ( time_do_sla >= dt_averaging_input )  THEN
963             CALL sum_up_3d_data
964             average_count_3d = average_count_3d + 1
965             time_do_sla = MOD( time_do_sla, MAX( dt_averaging_input, dt_3d ) )
966          ENDIF
967       ENDIF
968
969!
970!--    Calculate spectra for time averaging
971       IF ( averaging_interval_sp /= 0.0_wp  .AND.  &
972            ( dt_dosp - time_dosp ) <= averaging_interval_sp  .AND.  &
973            simulated_time >= skip_time_dosp )  THEN
974          time_dosp_av = time_dosp_av + dt_3d
975          IF ( time_dosp_av >= dt_averaging_input_pr )  THEN
976             CALL calc_spectra
977             time_dosp_av = MOD( time_dosp_av, &
978                                 MAX( dt_averaging_input_pr, dt_3d ) )
979          ENDIF
980       ENDIF
981
982!
983!--    Computation and output of run control parameters.
984!--    This is also done whenever perturbations have been imposed
985       IF ( time_run_control >= dt_run_control  .OR.                     &
986            timestep_scheme(1:5) /= 'runge'  .OR.  disturbance_created ) &
987       THEN
988          CALL run_control
989          IF ( time_run_control >= dt_run_control )  THEN
990             time_run_control = MOD( time_run_control, &
991                                     MAX( dt_run_control, dt_3d ) )
992          ENDIF
993       ENDIF
994
995!
996!--    Profile output (ASCII) on file
997       IF ( time_dopr_listing >= dt_dopr_listing )  THEN
998          CALL print_1d
999          time_dopr_listing = MOD( time_dopr_listing, MAX( dt_dopr_listing, &
1000                                                           dt_3d ) )
1001       ENDIF
1002
1003!
1004!--    Graphic output for PROFIL
1005       IF ( time_dopr >= dt_dopr )  THEN
1006          IF ( dopr_n /= 0 )  CALL data_output_profiles
1007          time_dopr = MOD( time_dopr, MAX( dt_dopr, dt_3d ) )
1008          time_dopr_av = 0.0_wp    ! due to averaging (see above)
1009       ENDIF
1010
1011!
1012!--    Graphic output for time series
1013       IF ( time_dots >= dt_dots )  THEN
1014          CALL data_output_tseries
1015          time_dots = MOD( time_dots, MAX( dt_dots, dt_3d ) )
1016       ENDIF
1017
1018!
1019!--    Output of spectra (formatted for use with PROFIL), in case of no
1020!--    time averaging, spectra has to be calculated before
1021       IF ( time_dosp >= dt_dosp )  THEN
1022          IF ( average_count_sp == 0 )  CALL calc_spectra
1023          CALL data_output_spectra
1024          time_dosp = MOD( time_dosp, MAX( dt_dosp, dt_3d ) )
1025       ENDIF
1026
1027!
1028!--    2d-data output (cross-sections)
1029       IF ( time_do2d_xy >= dt_do2d_xy )  THEN
1030          CALL data_output_2d( 'xy', 0 )
1031          time_do2d_xy = MOD( time_do2d_xy, MAX( dt_do2d_xy, dt_3d ) )
1032       ENDIF
1033       IF ( time_do2d_xz >= dt_do2d_xz )  THEN
1034          CALL data_output_2d( 'xz', 0 )
1035          time_do2d_xz = MOD( time_do2d_xz, MAX( dt_do2d_xz, dt_3d ) )
1036       ENDIF
1037       IF ( time_do2d_yz >= dt_do2d_yz )  THEN
1038          CALL data_output_2d( 'yz', 0 )
1039          time_do2d_yz = MOD( time_do2d_yz, MAX( dt_do2d_yz, dt_3d ) )
1040       ENDIF
1041
1042!
1043!--    3d-data output (volume data)
1044       IF ( time_do3d >= dt_do3d )  THEN
1045          CALL data_output_3d( 0 )
1046          time_do3d = MOD( time_do3d, MAX( dt_do3d, dt_3d ) )
1047       ENDIF
1048
1049!
1050!--    masked data output
1051!--    Parallel netcdf output is not tested so far for masked data, hence
1052!--    netcdf_data_format is switched back to non-paralell output.
1053       netcdf_data_format_save = netcdf_data_format
1054       IF ( netcdf_data_format == 5 ) netcdf_data_format = 3
1055       IF ( netcdf_data_format == 6 ) netcdf_data_format = 4
1056       DO  mid = 1, masks
1057          IF ( time_domask(mid) >= dt_domask(mid) )  THEN
1058             CALL data_output_mask( 0 )
1059             time_domask(mid) = MOD( time_domask(mid),  &
1060                                     MAX( dt_domask(mid), dt_3d ) )
1061          ENDIF
1062       ENDDO
1063       netcdf_data_format = netcdf_data_format_save
1064
1065!
1066!--    Output of time-averaged 2d/3d/masked data
1067       IF ( time_do_av >= dt_data_output_av )  THEN
1068          CALL average_3d_data
1069          CALL data_output_2d( 'xy', 1 )
1070          CALL data_output_2d( 'xz', 1 )
1071          CALL data_output_2d( 'yz', 1 )
1072          CALL data_output_3d( 1 )
1073!--       Parallel netcdf output is not tested so far for masked data, hence
1074!--       netcdf_data_format is switched back to non-paralell output.
1075          netcdf_data_format_save = netcdf_data_format
1076          IF ( netcdf_data_format == 5 ) netcdf_data_format = 3
1077          IF ( netcdf_data_format == 6 ) netcdf_data_format = 4
1078          DO  mid = 1, masks
1079             CALL data_output_mask( 1 )
1080          ENDDO
1081          netcdf_data_format = netcdf_data_format_save
1082          time_do_av = MOD( time_do_av, MAX( dt_data_output_av, dt_3d ) )
1083       ENDIF
1084
1085!
1086!--    Output of particle time series
1087       IF ( particle_advection )  THEN
1088          IF ( time_dopts >= dt_dopts  .OR. &
1089               ( simulated_time >= particle_advection_start  .AND. &
1090                 first_call_lpm ) )  THEN
1091             CALL data_output_ptseries
1092             time_dopts = MOD( time_dopts, MAX( dt_dopts, dt_3d ) )
1093          ENDIF
1094       ENDIF
1095
1096!
1097!--    Output of dvrp-graphics (isosurface, particles, slicer)
1098#if defined( __dvrp_graphics )
1099       CALL DVRP_LOG_EVENT( -2, current_timestep_number-1 )
1100#endif
1101       IF ( time_dvrp >= dt_dvrp )  THEN
1102          CALL data_output_dvrp
1103          time_dvrp = MOD( time_dvrp, MAX( dt_dvrp, dt_3d ) )
1104       ENDIF
1105#if defined( __dvrp_graphics )
1106       CALL DVRP_LOG_EVENT( 2, current_timestep_number )
1107#endif
1108
1109!
1110!--    If required, set the heat flux for the next time step at a random value
1111       IF ( constant_heatflux  .AND.  random_heatflux )  CALL disturb_heatflux
1112
1113!
1114!--    Execute user-defined actions
1115       CALL user_actions( 'after_timestep' )
1116
1117!
1118!--    Output elapsed simulated time in form of a progress bar on stdout
1119       IF ( myid == 0 )  CALL output_progress_bar
1120
1121       CALL cpu_log( log_point_s(10), 'timesteps', 'stop' )
1122
1123
1124    ENDDO   ! time loop
1125
1126    IF ( myid == 0 )  CALL finish_progress_bar
1127
1128#if defined( __dvrp_graphics )
1129    CALL DVRP_LOG_EVENT( -2, current_timestep_number )
1130#endif
1131
1132    CALL location_message( 'finished time-stepping', .TRUE. )
1133
1134 END SUBROUTINE time_integration
Note: See TracBrowser for help on using the repository browser.