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

Last change on this file since 3448 was 3448, checked in by kanani, 3 years ago

Implementation of human thermal indices (from branch biomet_p2 at r3444)

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