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

Last change on this file since 3421 was 3421, checked in by gronemeier, 3 years ago

new surface-data output; renamed output variables (pt to theta, rho_air to rho, rho_ocean to rho_sea_water)

  • Property svn:keywords set to Id
File size: 59.5 KB
Line 
1!> @file time_integration.f90
2!------------------------------------------------------------------------------!
3! This file is part of the PALM model system.
4!
5! PALM is free software: you can redistribute it and/or modify it under the
6! terms of the GNU General Public License as published by the Free Software
7! Foundation, either version 3 of the License, or (at your option) any later
8! version.
9!
10! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
11! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13!
14! You should have received a copy of the GNU General Public License along with
15! PALM. If not, see <http://www.gnu.org/licenses/>.
16!
17! Copyright 1997-2018 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: time_integration.f90 3421 2018-10-24 18:39:32Z gronemeier $
27! Surface data output
28!
29! 3418 2018-10-24 16:07:39Z kanani
30! call to material_heat_model now with check if spinup runs (rvtils)
31!
32! 3378 2018-10-19 12:34:59Z kanani
33! merge from radiation branch (r3362) into trunk
34! (moh.hefny):
35! Bugfix in the if statement to call radiation_interaction
36!
37! 3347 2018-10-15 14:21:08Z suehring
38! - offline nesting separated from large-scale forcing module
39! - changes for synthetic turbulence generator
40!
41! 3343 2018-10-15 10:38:52Z suehring
42! - Formatting, clean-up, comments (kanani)
43! - Added CALL to chem_emissions_setup (Russo)
44! - Code added for decycling chemistry (basit)
45!
46! 3294 2018-10-01 02:37:10Z raasch
47! changes concerning modularization of ocean option
48!
49! 3274 2018-09-24 15:42:55Z knoop
50! Modularization of all bulk cloud physics code components
51!
52! 3241 2018-09-12 15:02:00Z raasch
53! unused variables removed
54!
55! 3198 2018-08-15 09:23:10Z sward
56! Added multi_agent_system_end; defined start time for MAS relative to
57! time_since_reference_point
58!
59! 3183 2018-07-27 14:25:55Z suehring
60! Replace simulated_time by time_since_reference_point in COSMO nesting mode.
61! Rename subroutines and variables in COSMO nesting mode
62!
63! 3182 2018-07-27 13:36:03Z suehring
64! Added multi agent system
65!
66! 3042 2018-05-25 10:44:37Z schwenkel
67! Changed the name specific humidity to mixing ratio
68!
69! 3040 2018-05-25 10:22:08Z schwenkel
70! Fixed bug in IF statement
71! Ensure that the time when calling the radiation to be the time step of the
72! pre-calculated time when first calculate the positions of the sun
73!
74! 3004 2018-04-27 12:33:25Z Giersch
75! First call of flow_statistics has been removed. It is already called in
76! run_control itself
77!
78! 2984 2018-04-18 11:51:30Z hellstea
79! CALL pmci_ensure_nest_mass_conservation is removed (so far only commented out)
80! as seemingly unnecessary.
81!
82! 2941 2018-04-03 11:54:58Z kanani
83! Deduct spinup_time from RUN_CONTROL output of main 3d run
84! (use time_since_reference_point instead of simulated_time)
85!
86! 2938 2018-03-27 15:52:42Z suehring
87! Nesting of dissipation rate in case of RANS mode and TKE-e closure is applied
88!
89! 2936 2018-03-27 14:49:27Z suehring
90! Little formatting adjustment.
91!
92! 2817 2018-02-19 16:32:21Z knoop
93! Preliminary gust module interface implemented
94!
95! 2801 2018-02-14 16:01:55Z thiele
96! Changed lpm from subroutine to module.
97! Introduce particle transfer in nested models.
98!
99! 2776 2018-01-31 10:44:42Z Giersch
100! Variable use_synthetic_turbulence_generator has been abbreviated
101!
102! 2773 2018-01-30 14:12:54Z suehring
103! - Nesting for chemical species
104!
105! 2766 2018-01-22 17:17:47Z kanani
106! Removed preprocessor directive __chem
107!
108! 2718 2018-01-02 08:49:38Z maronga
109! Corrected "Former revisions" section
110!
111! 2696 2017-12-14 17:12:51Z kanani
112! - Change in file header (GPL part)
113! - Implementation of uv exposure model (FK)
114! - Moved vnest_boundary_conds_khkm from tcm_diffusivities to here (TG)
115! - renamed diffusivities to tcm_diffusivities (TG)
116! - implement prognostic equation for diss (TG)
117! - Moved/commented CALL to chem_emissions (FK)
118! - Added CALL to chem_emissions (FK)
119! - Implementation of chemistry module (FK)
120! - Calls for setting boundary conditions in USM and LSM (MS)
121! - Large-scale forcing with larger-scale models implemented (MS)
122! - Rename usm_radiation into radiation_interactions; merge with branch
123!   radiation (MS)
124! - added call for usm_green_heat_model for green building surfaces (RvT)
125! - added call for usm_temperature_near_surface for use in indoor model (RvT)
126!
127! 2617 2017-11-16 12:47:24Z suehring
128! Bugfix, assure that the reference state does not become zero.
129!
130! 2563 2017-10-19 15:36:10Z Giersch
131! Variable wind_turbine moved to module control_parameters
132!
133! 2365 2017-08-21 14:59:59Z kanani
134! Vertical grid nesting implemented (SadiqHuq)
135!
136! 2320 2017-07-21 12:47:43Z suehring
137! Set bottom boundary conditions after nesting interpolation and anterpolation
138!
139! 2299 2017-06-29 10:14:38Z maronga
140! Call of soil model adjusted
141!
142! 2292 2017-06-20 09:51:42Z schwenkel
143! Implementation of new microphysic scheme: cloud_scheme = 'morrison'
144! includes two more prognostic equations for cloud drop concentration (nc) 
145! and cloud water content (qc).
146!
147! 2271 2017-06-09 12:34:55Z sward
148! Start timestep message changed
149!
150! 2259 2017-06-08 09:09:11Z gronemeier
151! Implemented synthetic turbulence generator
152!
153! 2233 2017-05-30 18:08:54Z suehring
154!
155! 2232 2017-05-30 17:47:52Z suehring
156! Adjustments to new topography and surface concept
157! Modify passed parameters for disturb_field
158!
159! 2178 2017-03-17 11:07:39Z hellstea
160! Setting perturbations at all times near inflow boundary is removed
161! in case of nested boundaries
162!
163! 2174 2017-03-13 08:18:57Z maronga
164! Added support for nesting with cloud microphysics
165!
166! 2118 2017-01-17 16:38:49Z raasch
167! OpenACC directives and related code removed
168!
169! 2050 2016-11-08 15:00:55Z gronemeier
170! Implement turbulent outflow condition
171!
172! 2031 2016-10-21 15:11:58Z knoop
173! renamed variable rho to rho_ocean
174!
175! 2011 2016-09-19 17:29:57Z kanani
176! Flag urban_surface is now defined in module control_parameters,
177! removed commented CALLs of global_min_max.
178!
179! 2007 2016-08-24 15:47:17Z kanani
180! Added CALLs for new urban surface model
181!
182! 2000 2016-08-20 18:09:15Z knoop
183! Forced header and separation lines into 80 columns
184!
185! 1976 2016-07-27 13:28:04Z maronga
186! Simplified calls to radiation model
187!
188! 1960 2016-07-12 16:34:24Z suehring
189! Separate humidity and passive scalar
190!
191! 1957 2016-07-07 10:43:48Z suehring
192! flight module added
193!
194! 1919 2016-05-27 14:51:23Z raasch
195! Initial version of purely vertical nesting introduced.
196!
197! 1918 2016-05-27 14:35:57Z raasch
198! determination of time step moved to the end of the time step loop,
199! the first time step is now always calculated before the time step loop (i.e.
200! also in case of restart runs)
201!
202! 1914 2016-05-26 14:44:07Z witha
203! Added call for wind turbine model
204!
205! 1878 2016-04-19 12:30:36Z hellstea
206! Synchronization for nested runs rewritten
207!
208! 1853 2016-04-11 09:00:35Z maronga
209! Adjusted for use with radiation_scheme = constant
210!
211! 1849 2016-04-08 11:33:18Z hoffmann
212! Adapted for modularization of microphysics
213!
214! 1833 2016-04-07 14:23:03Z raasch
215! spectrum renamed spectra_mod, spectra related variables moved to spectra_mod
216!
217! 1831 2016-04-07 13:15:51Z hoffmann
218! turbulence renamed collision_turbulence
219!
220! 1822 2016-04-07 07:49:42Z hoffmann
221! icloud_scheme replaced by microphysics_*
222!
223! 1808 2016-04-05 19:44:00Z raasch
224! output message in case unscheduled radiation calls removed
225!
226! 1797 2016-03-21 16:50:28Z raasch
227! introduction of different datatransfer modes
228!
229! 1791 2016-03-11 10:41:25Z raasch
230! call of pmci_update_new removed
231!
232! 1786 2016-03-08 05:49:27Z raasch
233! +module spectrum
234!
235! 1783 2016-03-06 18:36:17Z raasch
236! switch back of netcdf data format for mask output moved to the mask output
237! routine
238!
239! 1781 2016-03-03 15:12:23Z raasch
240! some pmc calls removed at the beginning (before timeloop),
241! pmc initialization moved to the main program
242!
243! 1764 2016-02-28 12:45:19Z raasch
244! PMC_ACTIVE flags removed,
245! bugfix: nest synchronization after first call of timestep
246!
247! 1762 2016-02-25 12:31:13Z hellstea
248! Introduction of nested domain feature
249!
250! 1736 2015-12-04 08:56:33Z raasch
251! no perturbations added to total domain if energy limit has been set zero
252!
253! 1691 2015-10-26 16:17:44Z maronga
254! Added option for spin-ups without land surface and radiation models. Moved calls
255! for radiation and lan surface schemes.
256!
257! 1682 2015-10-07 23:56:08Z knoop
258! Code annotations made doxygen readable
259!
260! 1671 2015-09-25 03:29:37Z raasch
261! bugfix: ghostpoint exchange for array diss in case that sgs velocities are used
262! for particles
263!
264! 1585 2015-04-30 07:05:52Z maronga
265! Moved call of radiation scheme. Added support for RRTM
266!
267! 1551 2015-03-03 14:18:16Z maronga
268! Added interface for different radiation schemes.
269!
270! 1496 2014-12-02 17:25:50Z maronga
271! Added calls for the land surface model and radiation scheme
272!
273! 1402 2014-05-09 14:25:13Z raasch
274! location messages modified
275!
276! 1384 2014-05-02 14:31:06Z raasch
277! location messages added
278!
279! 1380 2014-04-28 12:40:45Z heinze
280! CALL of nudge_ref added
281! bc_pt_t_val and bc_q_t_val are updated in case nudging is used
282!
283! 1365 2014-04-22 15:03:56Z boeske
284! Reset sums_ls_l to zero at each timestep
285! +sums_ls_l
286! Calculation of reference state (previously in subroutine calc_mean_profile)
287
288! 1342 2014-03-26 17:04:47Z kanani
289! REAL constants defined as wp-kind
290!
291! 1320 2014-03-20 08:40:49Z raasch
292! ONLY-attribute added to USE-statements,
293! kind-parameters added to all INTEGER and REAL declaration statements,
294! kinds are defined in new module kinds,
295! old module precision_kind is removed,
296! revision history before 2012 removed,
297! comment fields (!:) to be used for variable explanations added to
298! all variable declaration statements
299! 1318 2014-03-17 13:35:16Z raasch
300! module interfaces removed
301!
302! 1308 2014-03-13 14:58:42Z fricke
303! +netcdf_data_format_save
304! For masked data, parallel netcdf output is not tested so far, hence
305! netcdf_data_format is switched back to non-paralell output.
306!
307! 1276 2014-01-15 13:40:41Z heinze
308! Use LSF_DATA also in case of Dirichlet bottom boundary condition for scalars
309!
310! 1257 2013-11-08 15:18:40Z raasch
311! acc-update-host directive for timestep removed
312!
313! 1241 2013-10-30 11:36:58Z heinze
314! Generalize calc_mean_profile for wider use
315! Determine shf and qsws in dependence on data from LSF_DATA
316! Determine ug and vg in dependence on data from LSF_DATA
317! 1221 2013-09-10 08:59:13Z raasch
318! host update of arrays before timestep is called
319!
320! 1179 2013-06-14 05:57:58Z raasch
321! mean profiles for reference state are only calculated if required,
322! small bugfix for background communication
323!
324! 1171 2013-05-30 11:27:45Z raasch
325! split of prognostic_equations deactivated (comment lines), for the time being
326!
327! 1128 2013-04-12 06:19:32Z raasch
328! asynchronous transfer of ghost point data realized for acc-optimized version:
329! prognostic_equations are first called two times for those points required for
330! the left-right and north-south exchange, respectively, and then for the
331! remaining points,
332! those parts requiring global communication moved from prognostic_equations to
333! here
334!
335! 1115 2013-03-26 18:16:16Z hoffmann
336! calculation of qr and nr is restricted to precipitation
337!
338! 1113 2013-03-10 02:48:14Z raasch
339! GPU-porting of boundary conditions,
340! openACC directives updated
341! formal parameter removed from routine boundary_conds
342!
343! 1111 2013-03-08 23:54:10Z raasch
344! +internal timestep counter for cpu statistics added,
345! openACC directives updated
346!
347! 1092 2013-02-02 11:24:22Z raasch
348! unused variables removed
349!
350! 1065 2012-11-22 17:42:36Z hoffmann
351! exchange of diss (dissipation rate) in case of turbulence = .TRUE. added
352!
353! 1053 2012-11-13 17:11:03Z hoffmann
354! exchange of ghost points for nr, qr added
355!
356! 1036 2012-10-22 13:43:42Z raasch
357! code put under GPL (PALM 3.9)
358!
359! 1019 2012-09-28 06:46:45Z raasch
360! non-optimized version of prognostic_equations removed
361!
362! 1015 2012-09-27 09:23:24Z raasch
363! +call of prognostic_equations_acc
364!
365! 1001 2012-09-13 14:08:46Z raasch
366! all actions concerning leapfrog- and upstream-spline-scheme removed
367!
368! 849 2012-03-15 10:35:09Z raasch
369! advec_particles renamed lpm, first_call_advec_particles renamed first_call_lpm
370!
371! 825 2012-02-19 03:03:44Z raasch
372! wang_collision_kernel renamed wang_kernel
373!
374! Revision 1.1  1997/08/11 06:19:04  raasch
375! Initial revision
376!
377!
378! Description:
379! ------------
380!> Integration in time of the model equations, statistical analysis and graphic
381!> output
382!------------------------------------------------------------------------------!
383 SUBROUTINE time_integration
384 
385
386    USE advec_ws,                                                              &
387        ONLY:  ws_statistics
388
389    USE arrays_3d,                                                             &
390        ONLY:  diss, diss_p, dzu, e, e_p, nc, nc_p, nr, nr_p, prho, pt, pt_p, pt_init, &
391               q_init, q, qc, qc_p, ql, ql_c, ql_v, ql_vp, qr, qr_p, q_p,      &
392               ref_state, rho_ocean, s, s_p, sa_p, tend, u, u_p, v, vpt,       &
393               v_p, w, w_p
394
395    USE bulk_cloud_model_mod,                                                  &
396        ONLY: bulk_cloud_model, calc_liquid_water_content,                     &
397              collision_turbulence, microphysics_morrison, microphysics_seifert
398
399    USE calc_mean_profile_mod,                                                 &
400        ONLY:  calc_mean_profile
401
402    USE chem_emissions_mod,                                                    &
403        ONLY:  chem_emissions_setup
404
405    USE chem_modules,                                                          &
406        ONLY:  bc_cs_t_val, call_chem_at_all_substeps, cs_name,                &
407               constant_csflux, do_emis, nspec, nspec_out
408
409    USE chemistry_model_mod,                                                   &
410        ONLY:  chem_boundary_conds, chem_species
411
412    USE control_parameters,                                                    &
413        ONLY:  advected_distance_x, advected_distance_y, air_chemistry,        &
414               average_count_3d, averaging_interval, averaging_interval_pr,    &
415               bc_lr_cyc, bc_ns_cyc, bc_pt_t_val, bc_q_t_val,                  &
416               call_psolver_at_all_substeps,  child_domain, cloud_droplets,    &
417               constant_flux_layer, constant_heatflux,                         &
418               create_disturbances, dopr_n, constant_diffusion, coupling_mode, &
419               coupling_start_time, current_timestep_number,                   &
420               disturbance_created, disturbance_energy_limit, dist_range,      &
421               do_sum, dt_3d, dt_averaging_input, dt_averaging_input_pr,       &
422               dt_coupling, dt_data_output_av, dt_disturb, dt_do2d_xy,         &
423               dt_do2d_xz, dt_do2d_yz, dt_do3d, dt_domask,dt_dopts, dt_dopr,   &
424               dt_dopr_listing, dt_dots, dt_dvrp, dt_run_control, end_time,    &
425               first_call_lpm, first_call_mas, galilei_transformation,         &
426               humidity, intermediate_timestep_count,                          &
427               intermediate_timestep_count_max,                                &
428               land_surface, large_scale_forcing,                              &
429               loop_optimization, lsf_surf, lsf_vert, masks, mid,              &
430               multi_agent_system_end, multi_agent_system_start,               &
431               nesting_offline, neutral, nr_timesteps_this_run, nudging,       &
432               ocean_mode, passive_scalar, pt_reference,                       &
433               pt_slope_offset, random_heatflux, rans_mode,                    &
434               rans_tke_e, run_coupled, simulated_time, simulated_time_chr,    &
435               skip_time_do2d_xy, skip_time_do2d_xz, skip_time_do2d_yz,        &
436               skip_time_do3d, skip_time_domask, skip_time_dopr,               &
437               skip_time_data_output_av, sloping_surface, stop_dt,             &
438               surface_data_output, terminate_coupled, terminate_run,          &
439               timestep_scheme,                                                &
440               time_coupling, time_do2d_xy, time_do2d_xz, time_do2d_yz,        &
441               time_do3d, time_domask, time_dopr, time_dopr_av,                &
442               time_dopr_listing, time_dopts, time_dosp, time_dosp_av,         &
443               time_dots, time_do_av, time_do_sla, time_disturb, time_dvrp,    &
444               time_run_control, time_since_reference_point,                   &
445               turbulent_inflow, turbulent_outflow, urban_surface,             &
446               use_initial_profile_as_reference,                               &
447               use_single_reference_value, uv_exposure, u_gtrans, v_gtrans,    &
448               virtual_flight, wind_turbine, ws_scheme_mom, ws_scheme_sca
449
450    USE cpulog,                                                                &
451        ONLY:  cpu_log, log_point, log_point_s
452
453    USE date_and_time_mod,                                                     &
454        ONLY:  calc_date_and_time, hour_call_emis, hour_of_year
455
456    USE flight_mod,                                                            &
457        ONLY:  flight_measurement
458
459    USE gust_mod,                                                              &
460        ONLY:  gust_actions, gust_module_enabled
461
462    USE indices,                                                               &
463        ONLY:  nbgp, nx, nxl, nxlg, nxr, nxrg, nzb, nzt
464
465    USE interaction_droplets_ptq_mod,                                          &
466        ONLY:  interaction_droplets_ptq
467
468    USE interfaces
469
470    USE kinds
471
472    USE land_surface_model_mod,                                                &
473        ONLY:  lsm_boundary_condition, lsm_energy_balance, lsm_soil_model,     &
474               skip_time_do_lsm
475
476    USE lsf_nudging_mod,                                                       &
477        ONLY:  calc_tnudge, ls_forcing_surf, ls_forcing_vert, nudge_ref
478
479    USE multi_agent_system_mod,                                                &
480        ONLY:  agents_active, multi_agent_system
481       
482    USE nesting_offl_mod,                                                      &
483        ONLY:  nesting_offl_bc, nesting_offl_mass_conservation
484       
485    USE netcdf_data_input_mod,                                                 &
486        ONLY:  chem_emis, chem_emis_att, nest_offl,                            &
487               netcdf_data_input_offline_nesting
488
489    USE ocean_mod,                                                             &
490        ONLY:  prho_reference
491
492    USE particle_attributes,                                                   &
493        ONLY:  particle_advection, particle_advection_start,                   &
494               use_sgs_for_particles, wang_kernel
495
496    USE pegrid
497
498    USE pmc_interface,                                                         &
499        ONLY:  nested_run, nesting_mode, pmci_boundary_conds, pmci_datatrans,  &
500               pmci_ensure_nest_mass_conservation, pmci_synchronize
501
502    USE progress_bar,                                                          &
503        ONLY:  finish_progress_bar, output_progress_bar
504
505    USE prognostic_equations_mod,                                              &
506        ONLY:  prognostic_equations_cache, prognostic_equations_vector
507
508    USE radiation_model_mod,                                                   &
509        ONLY: dt_radiation, force_radiation_call, radiation, radiation_control,&
510              radiation_interaction, radiation_interactions,                   &
511              skip_time_do_radiation, time_radiation
512
513    USE spectra_mod,                                                           &
514        ONLY: average_count_sp, averaging_interval_sp, calc_spectra, dt_dosp,  &
515              skip_time_dosp
516
517    USE statistics,                                                            &
518        ONLY:  flow_statistics_called, hom, pr_palm, sums_ls_l
519
520    USE surface_layer_fluxes_mod,                                              &
521        ONLY:  surface_layer_fluxes
522
523    USE surface_mod,                                                           &
524        ONLY:  surf_def_h, surf_lsm_h, surf_usm_h
525       
526    USE surface_output_mod,                                                    &
527        ONLY:  average_count_surf, averaging_interval_surf, dt_dosurf,         &
528               dt_dosurf_av, surface_output, surface_output_averaging,         &
529               skip_time_dosurf, skip_time_dosurf_av, time_dosurf,             &
530               time_dosurf_av
531
532    USE turbulence_closure_mod,                                                &
533        ONLY:  tcm_diffusivities, production_e_init
534
535    USE urban_surface_mod,                                                     &
536        ONLY:  usm_boundary_condition, usm_material_heat_model,                &
537               usm_material_model,                                             &
538               usm_surface_energy_balance, usm_green_heat_model,               &
539               usm_temperature_near_surface
540
541    USE synthetic_turbulence_generator_mod,                                    &
542        ONLY:  dt_stg_call, dt_stg_adjust, parametrize_inflow_turbulence,      &
543               stg_adjust, stg_main, time_stg_adjust, time_stg_call,           &
544               use_syn_turb_gen
545
546    USE user_actions_mod,                                                      &
547        ONLY:  user_actions
548
549    USE uv_exposure_model_mod,                                                 &
550        ONLY:  uvem_calc_exposure
551
552    USE wind_turbine_model_mod,                                                &
553        ONLY:  wtm_forces
554
555    USE lpm_mod,                                                               &
556        ONLY:  lpm
557
558    USE vertical_nesting_mod,                                                  &
559        ONLY:  vnested, vnest_anterpolate, vnest_anterpolate_e,                &
560               vnest_boundary_conds, vnest_boundary_conds_khkm,                & 
561               vnest_deallocate, vnest_init, vnest_init_fine,                  &
562               vnest_start_time
563
564    IMPLICIT NONE
565
566    CHARACTER (LEN=9) ::  time_to_string   !<
567
568    INTEGER(iwp)      ::  lsp       !<
569    INTEGER(iwp)      ::  lsp_usr   !<
570    INTEGER(iwp)      ::  n         !< loop counter for chemistry species
571
572    REAL(wp) ::  dt_3d_old  !< temporary storage of timestep to be used for
573                            !< steering of run control output interval
574    REAL(wp) ::  time_since_reference_point_save  !< original value of
575                                                  !< time_since_reference_point
576
577!
578!-- At beginning determine the first time step
579    CALL timestep
580!
581!-- Synchronize the timestep in case of nested run.
582    IF ( nested_run )  THEN
583!
584!--    Synchronization by unifying the time step.
585!--    Global minimum of all time-steps is used for all.
586       CALL pmci_synchronize
587    ENDIF
588
589!
590!-- Determine and print out the run control quantities before the first time
591!-- step of this run. For the initial run, some statistics (e.g. divergence)
592!-- need to be determined first --> CALL flow_statistics at the beginning of
593!-- run_control
594    CALL run_control
595!
596!-- Data exchange between coupled models in case that a call has been omitted
597!-- at the end of the previous run of a job chain.
598    IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled .AND. .NOT. vnested)  THEN
599!
600!--    In case of model termination initiated by the local model the coupler
601!--    must not be called because this would again cause an MPI hang.
602       DO WHILE ( time_coupling >= dt_coupling  .AND.  terminate_coupled == 0 )
603          CALL surface_coupler
604          time_coupling = time_coupling - dt_coupling
605       ENDDO
606       IF (time_coupling == 0.0_wp  .AND.                                      &
607           time_since_reference_point < dt_coupling )                          &
608       THEN
609          time_coupling = time_since_reference_point
610       ENDIF
611    ENDIF
612
613#if defined( __dvrp_graphics )
614!
615!-- Time measurement with dvrp software 
616    CALL DVRP_LOG_EVENT( 2, current_timestep_number )
617#endif
618
619    CALL location_message( 'starting timestep-sequence', .TRUE. )
620!
621!-- Start of the time loop
622    DO  WHILE ( simulated_time < end_time  .AND.  .NOT. stop_dt  .AND. &
623                .NOT. terminate_run )
624
625       CALL cpu_log( log_point_s(10), 'timesteps', 'start' )
626!
627!--    Vertical nesting: initialize fine grid
628       IF ( vnested ) THEN
629          IF ( .NOT. vnest_init  .AND.  simulated_time >= vnest_start_time )  THEN
630             CALL cpu_log( log_point(80), 'vnest_init', 'start' )
631             CALL vnest_init_fine
632             vnest_init = .TRUE.
633             CALL cpu_log( log_point(80), 'vnest_init', 'stop' )
634          ENDIF
635       ENDIF
636!
637!--    Determine ug, vg and w_subs in dependence on data from external file
638!--    LSF_DATA
639       IF ( large_scale_forcing .AND. lsf_vert )  THEN
640           CALL ls_forcing_vert ( simulated_time )
641           sums_ls_l = 0.0_wp
642       ENDIF
643
644!
645!--    Set pt_init and q_init to the current profiles taken from
646!--    NUDGING_DATA
647       IF ( nudging )  THEN
648           CALL nudge_ref ( simulated_time )
649!
650!--        Store temperature gradient at the top boundary for possible Neumann
651!--        boundary condition
652           bc_pt_t_val = ( pt_init(nzt+1) - pt_init(nzt) ) / dzu(nzt+1)
653           bc_q_t_val  = ( q_init(nzt+1) - q_init(nzt) ) / dzu(nzt+1)
654           IF ( air_chemistry )  THEN
655              DO  lsp = 1, nspec
656                 bc_cs_t_val = (  chem_species(lsp)%conc_pr_init(nzt+1)       &
657                                - chem_species(lsp)%conc_pr_init(nzt) )       &
658                               / dzu(nzt+1)
659              ENDDO
660           ENDIF
661       ENDIF
662!
663!--    If forcing by larger-scale models is applied, check if new data
664!--    at domain boundaries need to be read.
665       IF ( nesting_offline )  THEN
666          IF ( nest_offl%time(nest_offl%tind_p) <= time_since_reference_point )&
667             CALL netcdf_data_input_offline_nesting
668       ENDIF
669
670!
671!--    Execute the gust module actions
672       IF ( gust_module_enabled )  THEN
673          CALL gust_actions( 'before_timestep' )
674       ENDIF
675
676!
677!--    Execute the user-defined actions
678       CALL user_actions( 'before_timestep' )
679
680!
681!--    Calculate forces by wind turbines
682       IF ( wind_turbine )  THEN
683
684          CALL cpu_log( log_point(55), 'wind_turbine', 'start' )
685
686          CALL wtm_forces
687
688          CALL cpu_log( log_point(55), 'wind_turbine', 'stop' )
689
690       ENDIF       
691       
692!
693!--    Start of intermediate step loop
694       intermediate_timestep_count = 0
695       DO  WHILE ( intermediate_timestep_count < &
696                   intermediate_timestep_count_max )
697
698          intermediate_timestep_count = intermediate_timestep_count + 1
699
700!
701!--       Set the steering factors for the prognostic equations which depend
702!--       on the timestep scheme
703          CALL timestep_scheme_steering
704
705!
706!--       Calculate those variables needed in the tendency terms which need
707!--       global communication
708          IF ( .NOT. use_single_reference_value  .AND. &
709               .NOT. use_initial_profile_as_reference )  THEN
710!
711!--          Horizontally averaged profiles to be used as reference state in
712!--          buoyancy terms (WARNING: only the respective last call of
713!--          calc_mean_profile defines the reference state!)
714             IF ( .NOT. neutral )  THEN
715                CALL calc_mean_profile( pt, 4 )
716                ref_state(:)  = hom(:,1,4,0) ! this is used in the buoyancy term
717             ENDIF
718             IF ( ocean_mode )  THEN
719                CALL calc_mean_profile( rho_ocean, 64 )
720                ref_state(:)  = hom(:,1,64,0)
721             ENDIF
722             IF ( humidity )  THEN
723                CALL calc_mean_profile( vpt, 44 )
724                ref_state(:)  = hom(:,1,44,0)
725             ENDIF
726!
727!--          Assure that ref_state does not become zero at any level
728!--          ( might be the case if a vertical level is completely occupied
729!--            with topography ).
730             ref_state = MERGE( MAXVAL(ref_state), ref_state,                  &
731                                ref_state == 0.0_wp )
732          ENDIF
733
734          IF ( .NOT. constant_diffusion )  CALL production_e_init
735          IF ( ( ws_scheme_mom .OR. ws_scheme_sca )  .AND.  &
736               intermediate_timestep_count == 1 )  CALL ws_statistics
737!
738!--       In case of nudging calculate current nudging time scale and horizontal
739!--       means of u, v, pt and q
740          IF ( nudging )  THEN
741             CALL calc_tnudge( simulated_time )
742             CALL calc_mean_profile( u, 1 )
743             CALL calc_mean_profile( v, 2 )
744             CALL calc_mean_profile( pt, 4 )
745             CALL calc_mean_profile( q, 41 )
746          ENDIF
747
748!
749!--       Solve the prognostic equations. A fast cache optimized version with
750!--       only one single loop is used in case of Piascek-Williams advection
751!--       scheme. NEC vector machines use a different version, because
752!--       in the other versions a good vectorization is prohibited due to
753!--       inlining problems.
754          IF ( loop_optimization == 'cache' )  THEN
755             CALL prognostic_equations_cache
756          ELSEIF ( loop_optimization == 'vector' )  THEN
757             CALL prognostic_equations_vector
758          ENDIF
759
760!
761!--       Particle transport/physics with the Lagrangian particle model
762!--       (only once during intermediate steps, because it uses an Euler-step)
763!--       ### particle model should be moved before prognostic_equations, in order
764!--       to regard droplet interactions directly
765          IF ( particle_advection  .AND.                         &
766               simulated_time >= particle_advection_start  .AND. &
767               intermediate_timestep_count == 1 )  THEN
768             CALL lpm
769             first_call_lpm = .FALSE.
770          ENDIF
771
772!
773!--       Interaction of droplets with temperature and mixing ratio.
774!--       Droplet condensation and evaporation is calculated within
775!--       advec_particles.
776          IF ( cloud_droplets  .AND.  &
777               intermediate_timestep_count == intermediate_timestep_count_max )&
778          THEN
779             CALL interaction_droplets_ptq
780          ENDIF
781
782!
783!--       Movement of agents in multi agent system
784          IF ( agents_active  .AND.                                            &
785               time_since_reference_point >= multi_agent_system_start  .AND.   &
786               time_since_reference_point <= multi_agent_system_end    .AND.   &
787               intermediate_timestep_count == 1 )  THEN
788             CALL multi_agent_system
789             first_call_mas = .FALSE.
790          ENDIF
791
792!
793!--       Exchange of ghost points (lateral boundary conditions)
794          CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'start' )
795
796          CALL exchange_horiz( u_p, nbgp )
797          CALL exchange_horiz( v_p, nbgp )
798          CALL exchange_horiz( w_p, nbgp )
799          CALL exchange_horiz( pt_p, nbgp )
800          IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e_p, nbgp )
801          IF ( rans_tke_e  .OR.  wang_kernel  .OR.  collision_turbulence       &
802               .OR.  use_sgs_for_particles )  THEN
803             IF ( rans_tke_e )  THEN
804                CALL exchange_horiz( diss_p, nbgp )
805             ELSE
806                CALL exchange_horiz( diss, nbgp )
807             ENDIF
808          ENDIF
809          IF ( ocean_mode )  THEN
810             CALL exchange_horiz( sa_p, nbgp )
811             CALL exchange_horiz( rho_ocean, nbgp )
812             CALL exchange_horiz( prho, nbgp )
813          ENDIF
814          IF ( humidity )  THEN
815             CALL exchange_horiz( q_p, nbgp )
816             IF ( bulk_cloud_model .AND. microphysics_morrison )  THEN
817                CALL exchange_horiz( qc_p, nbgp )
818                CALL exchange_horiz( nc_p, nbgp )
819             ENDIF
820             IF ( bulk_cloud_model .AND. microphysics_seifert )  THEN
821                CALL exchange_horiz( qr_p, nbgp )
822                CALL exchange_horiz( nr_p, nbgp )
823             ENDIF
824          ENDIF
825          IF ( cloud_droplets )  THEN
826             CALL exchange_horiz( ql, nbgp )
827             CALL exchange_horiz( ql_c, nbgp )
828             CALL exchange_horiz( ql_v, nbgp )
829             CALL exchange_horiz( ql_vp, nbgp )
830          ENDIF
831          IF ( passive_scalar )  CALL exchange_horiz( s_p, nbgp )
832          IF ( air_chemistry )  THEN
833             DO  lsp = 1, nspec
834                CALL exchange_horiz( chem_species(lsp)%conc_p, nbgp )
835!
836!--             kanani: Push chem_boundary_conds after CALL boundary_conds
837                lsp_usr = 1
838                DO WHILE ( TRIM( cs_name( lsp_usr ) ) /= 'novalue' )
839                   IF ( TRIM(chem_species(lsp)%name) == TRIM(cs_name(lsp_usr)) )  THEN
840                      CALL chem_boundary_conds( chem_species(lsp)%conc_p,              &
841                                                chem_species(lsp)%conc_pr_init )
842                   ENDIF
843                   lsp_usr = lsp_usr + 1
844                ENDDO
845             ENDDO
846          ENDIF
847
848          CALL cpu_log( log_point(26), 'exchange-horiz-progn', 'stop' )
849
850!
851!--       Boundary conditions for the prognostic quantities (except of the
852!--       velocities at the outflow in case of a non-cyclic lateral wall)
853          CALL boundary_conds
854!
855!--       Swap the time levels in preparation for the next time step.
856          CALL swap_timelevel
857
858!
859!--       Vertical nesting: Interpolate fine grid data to the coarse grid
860          IF ( vnest_init ) THEN
861             CALL cpu_log( log_point(81), 'vnest_anterpolate', 'start' )
862             CALL vnest_anterpolate
863             CALL cpu_log( log_point(81), 'vnest_anterpolate', 'stop' )
864          ENDIF
865
866          IF ( nested_run )  THEN
867
868             CALL cpu_log( log_point(60), 'nesting', 'start' )
869!
870!--          Domain nesting. The data transfer subroutines pmci_parent_datatrans
871!--          and pmci_child_datatrans are called inside the wrapper
872!--          subroutine pmci_datatrans according to the control parameters
873!--          nesting_mode and nesting_datatransfer_mode.
874!--          TO_DO: why is nesting_mode given as a parameter here?
875             CALL pmci_datatrans( nesting_mode )
876
877             IF ( TRIM( nesting_mode ) == 'two-way' .OR.                       &
878                  nesting_mode == 'vertical' )  THEN
879!
880!--             Exchange_horiz is needed for all parent-domains after the
881!--             anterpolation
882                CALL exchange_horiz( u, nbgp )
883                CALL exchange_horiz( v, nbgp )
884                CALL exchange_horiz( w, nbgp )
885                IF ( .NOT. neutral )  CALL exchange_horiz( pt, nbgp )
886
887                IF ( humidity )  THEN
888
889                   CALL exchange_horiz( q, nbgp )
890
891                   IF ( bulk_cloud_model  .AND.  microphysics_morrison )  THEN
892                       CALL exchange_horiz( qc, nbgp )
893                       CALL exchange_horiz( nc, nbgp )
894                   ENDIF
895                   IF ( bulk_cloud_model  .AND.  microphysics_seifert )  THEN
896                       CALL exchange_horiz( qr, nbgp )
897                       CALL exchange_horiz( nr, nbgp )
898                   ENDIF
899
900                ENDIF
901
902                IF ( passive_scalar )  CALL exchange_horiz( s, nbgp )
903                IF ( .NOT. constant_diffusion )  CALL exchange_horiz( e, nbgp )
904
905                IF ( .NOT. constant_diffusion  .AND.  rans_mode  .AND.         &
906                                                      rans_tke_e )             &
907                   CALL exchange_horiz( diss, nbgp )
908
909                IF ( air_chemistry )  THEN
910                   DO  n = 1, nspec     
911                      CALL exchange_horiz( chem_species(n)%conc, nbgp ) 
912                   ENDDO
913                ENDIF
914
915             ENDIF
916!
917!--          Set boundary conditions again after interpolation and anterpolation.
918             CALL pmci_boundary_conds
919!
920!--          Correct the w top-BC in nest domains to ensure mass conservation.
921!--          This action must never be done for the root domain. Vertical
922!--          nesting implies mass conservation.
923!--          Commented out April 18, 2018 as seemingly unnecessary.
924!--          Will later be completely removed.
925!--             IF ( child_domain )  THEN
926!--                CALL pmci_ensure_nest_mass_conservation
927!--             ENDIF
928
929
930             CALL cpu_log( log_point(60), 'nesting', 'stop' )
931
932          ENDIF
933
934!
935!--       Temperature offset must be imposed at cyclic boundaries in x-direction
936!--       when a sloping surface is used
937          IF ( sloping_surface )  THEN
938             IF ( nxl ==  0 )  pt(:,:,nxlg:nxl-1) = pt(:,:,nxlg:nxl-1) - &
939                                                    pt_slope_offset
940             IF ( nxr == nx )  pt(:,:,nxr+1:nxrg) = pt(:,:,nxr+1:nxrg) + &
941                                                    pt_slope_offset
942          ENDIF
943
944!
945!--       Impose a turbulent inflow using the recycling method
946          IF ( turbulent_inflow )  CALL  inflow_turbulence
947
948!
949!--       Set values at outflow boundary using the special outflow condition
950          IF ( turbulent_outflow )  CALL  outflow_turbulence
951
952!
953!--       Impose a random perturbation on the horizontal velocity field
954          IF ( create_disturbances  .AND.                                      &
955               ( call_psolver_at_all_substeps  .AND.                           &
956               intermediate_timestep_count == intermediate_timestep_count_max )&
957          .OR. ( .NOT. call_psolver_at_all_substeps  .AND.                     &
958               intermediate_timestep_count == 1 ) )                            &
959          THEN
960             time_disturb = time_disturb + dt_3d
961             IF ( time_disturb >= dt_disturb )  THEN
962                IF ( disturbance_energy_limit /= 0.0_wp  .AND.                 &
963                     hom(nzb+5,1,pr_palm,0) < disturbance_energy_limit )  THEN
964                   CALL disturb_field( 'u', tend, u )
965                   CALL disturb_field( 'v', tend, v )
966                ELSEIF ( ( .NOT. bc_lr_cyc  .OR.  .NOT. bc_ns_cyc )            &
967                     .AND. .NOT. child_domain  .AND.  .NOT.  nesting_offline )  &
968                THEN
969!
970!--                Runs with a non-cyclic lateral wall need perturbations
971!--                near the inflow throughout the whole simulation
972                   dist_range = 1
973                   CALL disturb_field( 'u', tend, u )
974                   CALL disturb_field( 'v', tend, v )
975                   dist_range = 0
976                ENDIF
977                time_disturb = time_disturb - dt_disturb
978             ENDIF
979          ENDIF
980
981!
982!--       Map forcing data derived from larger scale model onto domain
983!--       boundaries.
984          IF ( nesting_offline  .AND.  intermediate_timestep_count ==          &
985                                       intermediate_timestep_count_max  )      &
986             CALL nesting_offl_bc
987!
988!--       Impose a turbulent inflow using synthetic generated turbulence,
989!--       only once per time step.
990          IF ( use_syn_turb_gen  .AND.  time_stg_call >= dt_stg_call  .AND.    &
991             intermediate_timestep_count == intermediate_timestep_count_max )  THEN! &
992             CALL stg_main
993          ENDIF
994!
995!--       Ensure mass conservation. This need to be done after imposing
996!--       synthetic turbulence and top boundary condition for pressure is set to
997!--       Neumann conditions.
998!--       Is this also required in case of Dirichlet?
999          IF ( nesting_offline )  CALL nesting_offl_mass_conservation
1000!
1001!--       Reduce the velocity divergence via the equation for perturbation
1002!--       pressure.
1003          IF ( intermediate_timestep_count == 1  .OR. &
1004                call_psolver_at_all_substeps )  THEN
1005
1006             IF (  vnest_init ) THEN
1007!
1008!--             Compute pressure in the CG, interpolate top boundary conditions
1009!--             to the FG and then compute pressure in the FG
1010                IF ( coupling_mode == 'vnested_crse' )  CALL pres
1011
1012                CALL cpu_log( log_point(82), 'vnest_bc', 'start' )
1013                CALL vnest_boundary_conds
1014                CALL cpu_log( log_point(82), 'vnest_bc', 'stop' )
1015 
1016                IF ( coupling_mode == 'vnested_fine' )  CALL pres
1017
1018!--             Anterpolate TKE, satisfy Germano Identity
1019                CALL cpu_log( log_point(83), 'vnest_anter_e', 'start' )
1020                CALL vnest_anterpolate_e
1021                CALL cpu_log( log_point(83), 'vnest_anter_e', 'stop' )
1022
1023             ELSE
1024
1025                CALL pres
1026
1027             ENDIF
1028
1029          ENDIF
1030
1031!
1032!--       If required, compute liquid water content
1033          IF ( bulk_cloud_model )  THEN
1034             CALL calc_liquid_water_content
1035          ENDIF
1036!
1037!--       If required, compute virtual potential temperature
1038          IF ( humidity )  THEN
1039             CALL compute_vpt
1040          ENDIF
1041
1042!
1043!--       Compute the diffusion quantities
1044          IF ( .NOT. constant_diffusion )  THEN
1045
1046!
1047!--          Determine surface fluxes shf and qsws and surface values
1048!--          pt_surface and q_surface in dependence on data from external
1049!--          file LSF_DATA respectively
1050             IF ( ( large_scale_forcing .AND. lsf_surf ) .AND. &
1051                 intermediate_timestep_count == intermediate_timestep_count_max )&
1052             THEN
1053                CALL ls_forcing_surf( simulated_time )
1054             ENDIF
1055
1056!
1057!--          First the vertical (and horizontal) fluxes in the surface
1058!--          (constant flux) layer are computed
1059             IF ( constant_flux_layer )  THEN
1060                CALL cpu_log( log_point(19), 'surface_layer_fluxes', 'start' )
1061                CALL surface_layer_fluxes
1062                CALL cpu_log( log_point(19), 'surface_layer_fluxes', 'stop' )
1063             ENDIF
1064!
1065!--          If required, solve the energy balance for the surface and run soil
1066!--          model. Call for horizontal as well as vertical surfaces
1067             IF ( land_surface .AND. time_since_reference_point >= skip_time_do_lsm)  THEN
1068
1069                CALL cpu_log( log_point(54), 'land_surface', 'start' )
1070!
1071!--             Call for horizontal upward-facing surfaces
1072                CALL lsm_energy_balance( .TRUE., -1 )
1073                CALL lsm_soil_model( .TRUE., -1, .TRUE. )
1074!
1075!--             Call for northward-facing surfaces
1076                CALL lsm_energy_balance( .FALSE., 0 )
1077                CALL lsm_soil_model( .FALSE., 0, .TRUE. )
1078!
1079!--             Call for southward-facing surfaces
1080                CALL lsm_energy_balance( .FALSE., 1 )
1081                CALL lsm_soil_model( .FALSE., 1, .TRUE. )
1082!
1083!--             Call for eastward-facing surfaces
1084                CALL lsm_energy_balance( .FALSE., 2 )
1085                CALL lsm_soil_model( .FALSE., 2, .TRUE. )
1086!
1087!--             Call for westward-facing surfaces
1088                CALL lsm_energy_balance( .FALSE., 3 )
1089                CALL lsm_soil_model( .FALSE., 3, .TRUE. )
1090!
1091!--             At the end, set boundary conditons for potential temperature
1092!--             and humidity after running the land-surface model. This
1093!--             might be important for the nesting, where arrays are transfered.
1094                CALL lsm_boundary_condition
1095
1096                CALL cpu_log( log_point(54), 'land_surface', 'stop' )
1097             ENDIF
1098!
1099!--          If required, solve the energy balance for urban surfaces and run
1100!--          the material heat model
1101             IF (urban_surface) THEN
1102                CALL cpu_log( log_point(74), 'urban_surface', 'start' )
1103               
1104                CALL usm_surface_energy_balance( .FALSE. )
1105                IF ( usm_material_model )  THEN
1106                   CALL usm_green_heat_model
1107                   CALL usm_material_heat_model ( .FALSE. )
1108                ENDIF
1109
1110                CALL usm_temperature_near_surface
1111!
1112!--             At the end, set boundary conditons for potential temperature
1113!--             and humidity after running the urban-surface model. This
1114!--             might be important for the nesting, where arrays are transfered.
1115                CALL usm_boundary_condition
1116
1117                CALL cpu_log( log_point(74), 'urban_surface', 'stop' )
1118             ENDIF
1119!
1120!--          Compute the diffusion coefficients
1121             CALL cpu_log( log_point(17), 'diffusivities', 'start' )
1122             IF ( .NOT. humidity ) THEN
1123                IF ( ocean_mode )  THEN
1124                   CALL tcm_diffusivities( prho, prho_reference )
1125                ELSE
1126                   CALL tcm_diffusivities( pt, pt_reference )
1127                ENDIF
1128             ELSE
1129                CALL tcm_diffusivities( vpt, pt_reference )
1130             ENDIF
1131             CALL cpu_log( log_point(17), 'diffusivities', 'stop' )
1132!
1133!--          Vertical nesting: set fine grid eddy viscosity top boundary condition
1134             IF ( vnest_init )  CALL vnest_boundary_conds_khkm
1135
1136          ENDIF
1137
1138!
1139!--       If required, calculate radiative fluxes and heating rates
1140          IF ( radiation .AND. intermediate_timestep_count                     &
1141               == intermediate_timestep_count_max .AND. time_since_reference_point >    &
1142               skip_time_do_radiation )  THEN
1143
1144               time_radiation = time_radiation + dt_3d
1145
1146             IF ( time_radiation >= dt_radiation .OR. force_radiation_call )   &
1147             THEN
1148
1149                CALL cpu_log( log_point(50), 'radiation', 'start' )
1150
1151                IF ( .NOT. force_radiation_call )  THEN
1152                   time_radiation = time_radiation - dt_radiation
1153                ENDIF
1154
1155!
1156!--             Adjust the current time to the time step of the radiation model.
1157!--             Needed since radiation is pre-calculated and stored only on apparent
1158!--             solar positions
1159                time_since_reference_point_save = time_since_reference_point
1160                time_since_reference_point =                                   &
1161                                    REAL( FLOOR( time_since_reference_point /  &
1162                                                 dt_radiation), wp )           &
1163                                             * dt_radiation
1164
1165                CALL radiation_control
1166
1167                CALL cpu_log( log_point(50), 'radiation', 'stop' )
1168
1169                IF ( ( urban_surface  .OR.  land_surface )  .AND.               &
1170                     radiation_interactions )  THEN
1171                   CALL cpu_log( log_point(75), 'radiation_interaction', 'start' )
1172                   CALL radiation_interaction
1173                   CALL cpu_log( log_point(75), 'radiation_interaction', 'stop' )
1174                ENDIF
1175   
1176!
1177!--             Return the current time to its original value
1178                time_since_reference_point = time_since_reference_point_save
1179
1180             ENDIF
1181          ENDIF
1182
1183       ENDDO   ! Intermediate step loop
1184!
1185!--    If required, consider chemical emissions
1186       IF ( air_chemistry  .AND.  do_emis )  THEN
1187!
1188!--       Update the time --> kanani: revise location of this CALL
1189          CALL calc_date_and_time
1190!
1191!--       Call emission routine only once an hour
1192          IF (hour_of_year  .GT.  hour_call_emis )  THEN
1193             CALL chem_emissions_setup( chem_emis_att, chem_emis, nspec_out )
1194             hour_call_emis = hour_of_year
1195          ENDIF
1196       ENDIF
1197!
1198!--    If required, do UV exposure calculations
1199       IF ( uv_exposure )  THEN
1200          CALL uvem_calc_exposure
1201       ENDIF
1202!
1203!--    Increase simulation time and output times
1204       nr_timesteps_this_run      = nr_timesteps_this_run + 1
1205       current_timestep_number    = current_timestep_number + 1
1206       simulated_time             = simulated_time   + dt_3d
1207       time_since_reference_point = simulated_time - coupling_start_time
1208       simulated_time_chr         = time_to_string( time_since_reference_point )
1209
1210
1211
1212
1213       IF ( simulated_time >= skip_time_data_output_av )  THEN
1214          time_do_av         = time_do_av       + dt_3d
1215       ENDIF
1216       IF ( simulated_time >= skip_time_do2d_xy )  THEN
1217          time_do2d_xy       = time_do2d_xy     + dt_3d
1218       ENDIF
1219       IF ( simulated_time >= skip_time_do2d_xz )  THEN
1220          time_do2d_xz       = time_do2d_xz     + dt_3d
1221       ENDIF
1222       IF ( simulated_time >= skip_time_do2d_yz )  THEN
1223          time_do2d_yz       = time_do2d_yz     + dt_3d
1224       ENDIF
1225       IF ( simulated_time >= skip_time_do3d    )  THEN
1226          time_do3d          = time_do3d        + dt_3d
1227       ENDIF
1228       DO  mid = 1, masks
1229          IF ( simulated_time >= skip_time_domask(mid) )  THEN
1230             time_domask(mid)= time_domask(mid) + dt_3d
1231          ENDIF
1232       ENDDO
1233       time_dvrp          = time_dvrp        + dt_3d
1234       IF ( simulated_time >= skip_time_dosp )  THEN
1235          time_dosp       = time_dosp        + dt_3d
1236       ENDIF
1237       time_dots          = time_dots        + dt_3d
1238       IF ( .NOT. first_call_lpm )  THEN
1239          time_dopts      = time_dopts       + dt_3d
1240       ENDIF
1241       IF ( simulated_time >= skip_time_dopr )  THEN
1242          time_dopr       = time_dopr        + dt_3d
1243       ENDIF
1244       time_dopr_listing          = time_dopr_listing        + dt_3d
1245       time_run_control   = time_run_control + dt_3d
1246!
1247!--    Increment time-counter for surface output
1248       IF ( surface_data_output )  THEN
1249          IF ( simulated_time >= skip_time_dosurf )  THEN
1250             time_dosurf    = time_dosurf + dt_3d
1251          ENDIF
1252          IF ( simulated_time >= skip_time_dosurf_av )  THEN
1253             time_dosurf_av = time_dosurf_av + dt_3d
1254          ENDIF
1255       ENDIF
1256!
1257!--    In case of synthetic turbulence generation and parametrized turbulence
1258!--    information, update the time counter and if required, adjust the
1259!--    STG to new atmospheric conditions.
1260       IF ( use_syn_turb_gen  )  THEN
1261          IF ( parametrize_inflow_turbulence )  THEN
1262             time_stg_adjust = time_stg_adjust + dt_3d
1263             IF ( time_stg_adjust >= dt_stg_adjust )  CALL stg_adjust
1264          ENDIF
1265          time_stg_call = time_stg_call + dt_3d
1266       ENDIF
1267
1268!
1269!--    Data exchange between coupled models
1270       IF ( coupling_mode /= 'uncoupled'  .AND.  run_coupled                   &
1271                                          .AND. .NOT. vnested )  THEN
1272          time_coupling = time_coupling + dt_3d
1273
1274!
1275!--       In case of model termination initiated by the local model
1276!--       (terminate_coupled > 0), the coupler must be skipped because it would
1277!--       cause an MPI intercomminucation hang.
1278!--       If necessary, the coupler will be called at the beginning of the
1279!--       next restart run.
1280          DO WHILE ( time_coupling >= dt_coupling .AND. terminate_coupled == 0 )
1281             CALL surface_coupler
1282             time_coupling = time_coupling - dt_coupling
1283          ENDDO
1284       ENDIF
1285
1286!
1287!--    Execute the gust module actions
1288       IF ( gust_module_enabled )  THEN
1289          CALL gust_actions( 'after_integration' )
1290       ENDIF
1291
1292!
1293!--    Execute user-defined actions
1294       CALL user_actions( 'after_integration' )
1295
1296!
1297!--    If Galilei transformation is used, determine the distance that the
1298!--    model has moved so far
1299       IF ( galilei_transformation )  THEN
1300          advected_distance_x = advected_distance_x + u_gtrans * dt_3d
1301          advected_distance_y = advected_distance_y + v_gtrans * dt_3d
1302       ENDIF
1303
1304!
1305!--    Check, if restart is necessary (because cpu-time is expiring or
1306!--    because it is forced by user) and set stop flag
1307!--    This call is skipped if the remote model has already initiated a restart.
1308       IF ( .NOT. terminate_run )  CALL check_for_restart
1309
1310!
1311!--    Carry out statistical analysis and output at the requested output times.
1312!--    The MOD function is used for calculating the output time counters (like
1313!--    time_dopr) in order to regard a possible decrease of the output time
1314!--    interval in case of restart runs
1315
1316!
1317!--    Set a flag indicating that so far no statistics have been created
1318!--    for this time step
1319       flow_statistics_called = .FALSE.
1320
1321!
1322!--    If required, call flow_statistics for averaging in time
1323       IF ( averaging_interval_pr /= 0.0_wp  .AND.  &
1324            ( dt_dopr - time_dopr ) <= averaging_interval_pr  .AND.  &
1325            simulated_time >= skip_time_dopr )  THEN
1326          time_dopr_av = time_dopr_av + dt_3d
1327          IF ( time_dopr_av >= dt_averaging_input_pr )  THEN
1328             do_sum = .TRUE.
1329             time_dopr_av = MOD( time_dopr_av, &
1330                                    MAX( dt_averaging_input_pr, dt_3d ) )
1331          ENDIF
1332       ENDIF
1333       IF ( do_sum )  CALL flow_statistics
1334
1335!
1336!--    Sum-up 3d-arrays for later output of time-averaged 2d/3d/masked data
1337       IF ( averaging_interval /= 0.0_wp  .AND.                                &
1338            ( dt_data_output_av - time_do_av ) <= averaging_interval  .AND. &
1339            simulated_time >= skip_time_data_output_av )                    &
1340       THEN
1341          time_do_sla = time_do_sla + dt_3d
1342          IF ( time_do_sla >= dt_averaging_input )  THEN
1343             CALL sum_up_3d_data
1344             average_count_3d = average_count_3d + 1
1345             time_do_sla = MOD( time_do_sla, MAX( dt_averaging_input, dt_3d ) )
1346          ENDIF
1347       ENDIF
1348!
1349!--    Average surface data
1350       IF ( surface_data_output )  THEN
1351          IF ( averaging_interval_surf /= 0.0_wp  .AND.                        & 
1352               ( dt_dosurf_av - time_dosurf_av ) <= averaging_interval_surf    &
1353          .AND.  simulated_time >= skip_time_dosurf_av )  THEN
1354             IF ( time_dosurf_av >= dt_averaging_input )  THEN       
1355                CALL surface_output_averaging
1356                average_count_surf = average_count_surf + 1
1357             ENDIF
1358          ENDIF
1359       ENDIF
1360
1361!
1362!--    Calculate spectra for time averaging
1363       IF ( averaging_interval_sp /= 0.0_wp  .AND.  &
1364            ( dt_dosp - time_dosp ) <= averaging_interval_sp  .AND.  &
1365            simulated_time >= skip_time_dosp )  THEN
1366          time_dosp_av = time_dosp_av + dt_3d
1367          IF ( time_dosp_av >= dt_averaging_input_pr )  THEN
1368             CALL calc_spectra
1369             time_dosp_av = MOD( time_dosp_av, &
1370                                 MAX( dt_averaging_input_pr, dt_3d ) )
1371          ENDIF
1372       ENDIF
1373
1374!
1375!--    Call flight module and output data
1376       IF ( virtual_flight )  THEN
1377          CALL flight_measurement
1378          CALL data_output_flight
1379       ENDIF
1380
1381!
1382!--    Profile output (ASCII) on file
1383       IF ( time_dopr_listing >= dt_dopr_listing )  THEN
1384          CALL print_1d
1385          time_dopr_listing = MOD( time_dopr_listing, MAX( dt_dopr_listing, &
1386                                                           dt_3d ) )
1387       ENDIF
1388
1389!
1390!--    Graphic output for PROFIL
1391       IF ( time_dopr >= dt_dopr )  THEN
1392          IF ( dopr_n /= 0 )  CALL data_output_profiles
1393          time_dopr = MOD( time_dopr, MAX( dt_dopr, dt_3d ) )
1394          time_dopr_av = 0.0_wp    ! due to averaging (see above)
1395       ENDIF
1396
1397!
1398!--    Graphic output for time series
1399       IF ( time_dots >= dt_dots )  THEN
1400          CALL data_output_tseries
1401          time_dots = MOD( time_dots, MAX( dt_dots, dt_3d ) )
1402       ENDIF
1403
1404!
1405!--    Output of spectra (formatted for use with PROFIL), in case of no
1406!--    time averaging, spectra has to be calculated before
1407       IF ( time_dosp >= dt_dosp )  THEN
1408          IF ( average_count_sp == 0 )  CALL calc_spectra
1409          CALL data_output_spectra
1410          time_dosp = MOD( time_dosp, MAX( dt_dosp, dt_3d ) )
1411       ENDIF
1412
1413!
1414!--    2d-data output (cross-sections)
1415       IF ( time_do2d_xy >= dt_do2d_xy )  THEN
1416          CALL data_output_2d( 'xy', 0 )
1417          time_do2d_xy = MOD( time_do2d_xy, MAX( dt_do2d_xy, dt_3d ) )
1418       ENDIF
1419       IF ( time_do2d_xz >= dt_do2d_xz )  THEN
1420          CALL data_output_2d( 'xz', 0 )
1421          time_do2d_xz = MOD( time_do2d_xz, MAX( dt_do2d_xz, dt_3d ) )
1422       ENDIF
1423       IF ( time_do2d_yz >= dt_do2d_yz )  THEN
1424          CALL data_output_2d( 'yz', 0 )
1425          time_do2d_yz = MOD( time_do2d_yz, MAX( dt_do2d_yz, dt_3d ) )
1426       ENDIF
1427
1428!
1429!--    3d-data output (volume data)
1430       IF ( time_do3d >= dt_do3d )  THEN
1431          CALL data_output_3d( 0 )
1432          time_do3d = MOD( time_do3d, MAX( dt_do3d, dt_3d ) )
1433       ENDIF
1434
1435!
1436!--    Masked data output
1437       DO  mid = 1, masks
1438          IF ( time_domask(mid) >= dt_domask(mid) )  THEN
1439             CALL data_output_mask( 0 )
1440             time_domask(mid) = MOD( time_domask(mid),  &
1441                                     MAX( dt_domask(mid), dt_3d ) )
1442          ENDIF
1443       ENDDO
1444
1445!
1446!--    Output of time-averaged 2d/3d/masked data
1447       IF ( time_do_av >= dt_data_output_av )  THEN
1448          CALL average_3d_data
1449          CALL data_output_2d( 'xy', 1 )
1450          CALL data_output_2d( 'xz', 1 )
1451          CALL data_output_2d( 'yz', 1 )
1452          CALL data_output_3d( 1 )
1453          DO  mid = 1, masks
1454             CALL data_output_mask( 1 )
1455          ENDDO
1456          time_do_av = MOD( time_do_av, MAX( dt_data_output_av, dt_3d ) )
1457       ENDIF
1458!
1459!--    Output of surface data, instantaneous and averaged data
1460       IF ( surface_data_output )  THEN
1461          IF ( time_dosurf >= dt_dosurf )  THEN
1462             CALL surface_output( 0 )
1463             time_dosurf = MOD( time_dosurf, MAX( dt_dosurf, dt_3d ) )
1464          ENDIF
1465          IF ( time_dosurf_av >= dt_dosurf_av )  THEN
1466             CALL surface_output( 1 )
1467             time_dosurf_av = MOD( time_dosurf_av, MAX( dt_dosurf_av, dt_3d ) )
1468          ENDIF
1469       ENDIF
1470
1471!
1472!--    Output of particle time series
1473       IF ( particle_advection )  THEN
1474          IF ( time_dopts >= dt_dopts  .OR. &
1475               ( simulated_time >= particle_advection_start  .AND. &
1476                 first_call_lpm ) )  THEN
1477             CALL data_output_ptseries
1478             time_dopts = MOD( time_dopts, MAX( dt_dopts, dt_3d ) )
1479          ENDIF
1480       ENDIF
1481
1482!
1483!--    Output of dvrp-graphics (isosurface, particles, slicer)
1484#if defined( __dvrp_graphics )
1485       CALL DVRP_LOG_EVENT( -2, current_timestep_number-1 )
1486#endif
1487       IF ( time_dvrp >= dt_dvrp )  THEN
1488          CALL data_output_dvrp
1489          time_dvrp = MOD( time_dvrp, MAX( dt_dvrp, dt_3d ) )
1490       ENDIF
1491#if defined( __dvrp_graphics )
1492       CALL DVRP_LOG_EVENT( 2, current_timestep_number )
1493#endif
1494
1495!
1496!--    If required, set the heat flux for the next time step at a random value
1497       IF ( constant_heatflux  .AND.  random_heatflux )  THEN
1498          IF ( surf_def_h(0)%ns >= 1 )  CALL disturb_heatflux( surf_def_h(0) )
1499          IF ( surf_lsm_h%ns    >= 1 )  CALL disturb_heatflux( surf_lsm_h    )
1500          IF ( surf_usm_h%ns    >= 1 )  CALL disturb_heatflux( surf_usm_h    )
1501       ENDIF
1502
1503!
1504!--    Execute the gust module actions
1505       IF ( gust_module_enabled )  THEN
1506          CALL gust_actions( 'after_timestep' )
1507       ENDIF
1508
1509!
1510!--    Execute user-defined actions
1511       CALL user_actions( 'after_timestep' )
1512
1513!
1514!--    Determine size of next time step. Save timestep dt_3d because it is
1515!--    newly calculated in routine timestep, but required further below for
1516!--    steering the run control output interval
1517       dt_3d_old = dt_3d
1518       CALL timestep
1519
1520!
1521!--    Synchronize the timestep in case of nested run.
1522       IF ( nested_run )  THEN
1523!
1524!--       Synchronize by unifying the time step.
1525!--       Global minimum of all time-steps is used for all.
1526          CALL pmci_synchronize
1527       ENDIF
1528
1529!
1530!--    Computation and output of run control parameters.
1531!--    This is also done whenever perturbations have been imposed
1532       IF ( time_run_control >= dt_run_control  .OR.                     &
1533            timestep_scheme(1:5) /= 'runge'  .OR.  disturbance_created ) &
1534       THEN
1535          CALL run_control
1536          IF ( time_run_control >= dt_run_control )  THEN
1537             time_run_control = MOD( time_run_control, &
1538                                     MAX( dt_run_control, dt_3d_old ) )
1539          ENDIF
1540       ENDIF
1541
1542!
1543!--    Output elapsed simulated time in form of a progress bar on stdout
1544       IF ( myid == 0 )  CALL output_progress_bar
1545
1546       CALL cpu_log( log_point_s(10), 'timesteps', 'stop' )
1547
1548
1549    ENDDO   ! time loop
1550   
1551!
1552!-- Vertical nesting: Deallocate variables initialized for vertical nesting   
1553    IF ( vnest_init )  CALL vnest_deallocate
1554
1555    IF ( myid == 0 )  CALL finish_progress_bar
1556
1557#if defined( __dvrp_graphics )
1558    CALL DVRP_LOG_EVENT( -2, current_timestep_number )
1559#endif
1560
1561    CALL location_message( 'finished time-stepping', .TRUE. )
1562
1563 END SUBROUTINE time_integration
Note: See TracBrowser for help on using the repository browser.