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

Last change on this file since 1786 was 1786, checked in by raasch, 6 years ago

pmc-change in server-client get-put, spectra-directives removed, spectra-package modularized

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