source: palm/trunk/SOURCE/lagrangian_particle_model_mod.f90 @ 4044

Last change on this file since 4044 was 4044, checked in by schwenkel, 2 years ago

Bugfix in case of grid strecting: corrected calculation of k-Index

  • Property svn:keywords set to Id
File size: 338.8 KB
Line 
1!> @file lagrangian_particle_model_mod.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-2019 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: lagrangian_particle_model_mod.f90 4044 2019-06-19 12:28:27Z schwenkel $
27! Bugfix in case of grid strecting: corrected calculation of k-Index
28!
29! 4043 2019-06-18 16:59:00Z schwenkel
30! Remove min_nr_particle, Add lpm_droplet_interactions_ptq into module
31!
32! 4028 2019-06-13 12:21:37Z schwenkel
33! Further modularization of particle code components
34!
35! 4020 2019-06-06 14:57:48Z schwenkel
36! Removing submodules
37!
38! 4018 2019-06-06 13:41:50Z eckhard
39! Bugfix for former revision
40!
41! 4017 2019-06-06 12:16:46Z schwenkel
42! Modularization of all lagrangian particle model code components
43!
44! 3655 2019-01-07 16:51:22Z knoop
45! bugfix to guarantee correct particle releases in case that the release
46! interval is smaller than the model timestep
47!
48! 2801 2018-02-14 16:01:55Z thiele
49! Changed lpm from subroutine to module.
50! Introduce particle transfer in nested models.
51!
52! 2718 2018-01-02 08:49:38Z maronga
53! Corrected "Former revisions" section
54!
55! 2701 2017-12-15 15:40:50Z suehring
56! Changes from last commit documented
57!
58! 2698 2017-12-14 18:46:24Z suehring
59! Grid indices passed to lpm_boundary_conds. (responsible Philipp Thiele)
60!
61! 2696 2017-12-14 17:12:51Z kanani
62! Change in file header (GPL part)
63!
64! 2606 2017-11-10 10:36:31Z schwenkel
65! Changed particle box locations: center of particle box now coincides
66! with scalar grid point of same index.
67! Renamed module and subroutines: lpm_pack_arrays_mod -> lpm_pack_and_sort_mod
68! lpm_pack_all_arrays -> lpm_sort_in_subboxes, lpm_pack_arrays -> lpm_pack
69! lpm_sort -> lpm_sort_timeloop_done
70!
71! 2418 2017-09-06 15:24:24Z suehring
72! Major bugfixes in modeling SGS particle speeds (since revision 1359).
73! Particle sorting added to distinguish between already completed and
74! non-completed particles.
75!
76! 2263 2017-06-08 14:59:01Z schwenkel
77! Implemented splitting and merging algorithm
78!
79! 2233 2017-05-30 18:08:54Z suehring
80!
81! 2232 2017-05-30 17:47:52Z suehring
82! Adjustments to new topography concept
83!
84! 2000 2016-08-20 18:09:15Z knoop
85! Forced header and separation lines into 80 columns
86!
87! 1936 2016-06-13 13:37:44Z suehring
88! Call routine for deallocation of unused memory.
89! Formatting adjustments
90!
91! 1929 2016-06-09 16:25:25Z suehring
92! Call wall boundary conditions only if particles are in the vertical range of
93! topography.
94!
95! 1822 2016-04-07 07:49:42Z hoffmann
96! Tails removed.
97!
98! Initialization of sgs model not necessary for the use of cloud_droplets and
99! use_sgs_for_particles.
100!
101! lpm_release_set integrated.
102!
103! Unused variabled removed.
104!
105! 1682 2015-10-07 23:56:08Z knoop
106! Code annotations made doxygen readable
107!
108! 1416 2014-06-04 16:04:03Z suehring
109! user_lpm_advec is called for each gridpoint.
110! Bugfix: in order to prevent an infinite loop, time_loop_done is set .TRUE.
111! at the head of the do-loop. 
112!
113! 1359 2014-04-11 17:15:14Z hoffmann
114! New particle structure integrated.
115! Kind definition added to all floating point numbers.
116!
117! 1320 2014-03-20 08:40:49Z raasch
118! ONLY-attribute added to USE-statements,
119! kind-parameters added to all INTEGER and REAL declaration statements,
120! kinds are defined in new module kinds,
121! revision history before 2012 removed,
122! comment fields (!:) to be used for variable explanations added to
123! all variable declaration statements
124!
125! 1318 2014-03-17 13:35:16Z raasch
126! module interfaces removed
127!
128! 1036 2012-10-22 13:43:42Z raasch
129! code put under GPL (PALM 3.9)
130!
131! 851 2012-03-15 14:32:58Z raasch
132! Bugfix: resetting of particle_mask and tail mask moved from routine
133! lpm_exchange_horiz to here (end of sub-timestep loop)
134!
135! 849 2012-03-15 10:35:09Z raasch
136! original routine advec_particles split into several subroutines and renamed
137! lpm
138!
139! 831 2012-02-22 00:29:39Z raasch
140! thermal_conductivity_l and diff_coeff_l now depend on temperature and
141! pressure
142!
143! 828 2012-02-21 12:00:36Z raasch
144! fast hall/wang kernels with fixed radius/dissipation classes added,
145! particle feature color renamed class, routine colker renamed
146! recalculate_kernel,
147! lower limit for droplet radius changed from 1E-7 to 1E-8
148!
149! Bugfix: transformation factor for dissipation changed from 1E5 to 1E4
150!
151! 825 2012-02-19 03:03:44Z raasch
152! droplet growth by condensation may include curvature and solution effects,
153! initialisation of temporary particle array for resorting removed,
154! particle attributes speed_x|y|z_sgs renamed rvar1|2|3,
155! module wang_kernel_mod renamed lpm_collision_kernels_mod,
156! wang_collision_kernel renamed wang_kernel
157!
158!
159! Revision 1.1  1999/11/25 16:16:06  raasch
160! Initial revision
161!
162!
163! Description:
164! ------------
165!>
166!------------------------------------------------------------------------------!
167 MODULE lagrangian_particle_model_mod
168
169    USE, INTRINSIC ::  ISO_C_BINDING
170
171    USE arrays_3d,                                                             &
172        ONLY:  de_dx, de_dy, de_dz, dzw, zu, zw,  ql_c, ql_v, ql_vp, hyp,      &
173               pt, q, exner, ql, diss, e, u, v, w, km, ql_1, ql_2, pt_p, q_p,  &
174               d_exner
175 
176    USE averaging,                                                             &
177        ONLY:  ql_c_av, pr_av, pc_av, ql_vp_av, ql_v_av
178
179    USE basic_constants_and_equations_mod,                                     &
180        ONLY: molecular_weight_of_solute, molecular_weight_of_water, magnus,   &
181              pi, rd_d_rv, rho_l, r_v, rho_s, vanthoff, l_v, kappa, g, lv_d_cp
182
183    USE control_parameters,                                                    &
184        ONLY:  bc_dirichlet_l, bc_dirichlet_n, bc_dirichlet_r, bc_dirichlet_s, &
185               cloud_droplets, constant_flux_layer, current_timestep_number,   &
186               dt_3d, dt_3d_reached, humidity,                                 &
187               dt_3d_reached_l, dt_dopts, dz, initializing_actions,            &
188               message_string, molecular_viscosity, ocean_mode,                &
189               particle_maximum_age, iran,                                     & 
190               simulated_time, topography, dopts_time_count,                   &
191               time_since_reference_point, rho_surface, u_gtrans, v_gtrans,    &
192               dz_stretch_level, dz_stretch_level_start
193
194    USE cpulog,                                                                &
195        ONLY:  cpu_log, log_point, log_point_s
196
197    USE indices,                                                               &
198        ONLY:  nx, nxl, nxlg, nxrg, nxr, ny, nyn, nys, nyng, nysg, nz, nzb,    &
199               nzb_max, nzt, wall_flags_0,nbgp, ngp_2dh_outer
200
201    USE kinds
202
203    USE pegrid
204
205    USE particle_attributes
206
207    USE pmc_particle_interface,                                                &
208        ONLY: pmcp_c_get_particle_from_parent, pmcp_p_fill_particle_win,       &
209              pmcp_c_send_particle_to_parent, pmcp_p_empty_particle_win,       &
210              pmcp_p_delete_particles_in_fine_grid_area, pmcp_g_init,          &
211              pmcp_g_print_number_of_particles
212
213    USE pmc_interface,                                                         &
214        ONLY: nested_run
215
216    USE grid_variables,                                                        &
217        ONLY:  ddx, dx, ddy, dy
218
219    USE netcdf_interface,                                                      &
220        ONLY:  netcdf_data_format, netcdf_deflate, dopts_num, id_set_pts,      &
221               id_var_dopts, id_var_time_pts, nc_stat,                         &
222               netcdf_handle_error
223
224    USE random_function_mod,                                                   &
225        ONLY:  random_function
226
227    USE statistics,                                                            &
228        ONLY:  hom
229
230    USE surface_mod,                                                           &
231        ONLY:  get_topography_top_index_ji, surf_def_h, surf_lsm_h, surf_usm_h,&
232               bc_h
233
234#if defined( __parallel )  &&  !defined( __mpifh )
235    USE MPI
236#endif
237
238#if defined( __parallel )  &&  defined( __mpifh )
239    INCLUDE "mpif.h"
240#endif     
241
242#if defined( __netcdf )
243    USE NETCDF
244#endif
245
246
247     USE arrays_3d,                                                             &
248        ONLY:
249
250    USE indices,                                                               &
251        ONLY:  nxl, nxr, nyn, nys, nzb, nzt, wall_flags_0
252
253    USE kinds
254
255    USE pegrid
256
257    IMPLICIT NONE
258
259    CHARACTER(LEN=15) ::  aero_species = 'nacl'                    !< aerosol species
260    CHARACTER(LEN=15) ::  aero_type    = 'maritime'                !< aerosol type
261    CHARACTER(LEN=15) ::  bc_par_lr    = 'cyclic'                  !< left/right boundary condition
262    CHARACTER(LEN=15) ::  bc_par_ns    = 'cyclic'                  !< north/south boundary condition
263    CHARACTER(LEN=15) ::  bc_par_b     = 'reflect'                 !< bottom boundary condition
264    CHARACTER(LEN=15) ::  bc_par_t     = 'absorb'                  !< top boundary condition
265    CHARACTER(LEN=15) ::  collision_kernel   = 'none'              !< collision kernel   
266
267    CHARACTER(LEN=5)  ::  splitting_function = 'gamma'             !< function for calculation critical weighting factor
268    CHARACTER(LEN=5)  ::  splitting_mode     = 'const'             !< splitting mode
269
270    INTEGER(iwp) ::  deleted_particles = 0                        !< number of deleted particles per time step   
271    INTEGER(iwp) ::  i_splitting_mode                             !< dummy for splitting mode
272    INTEGER(iwp) ::  iran_part = -1234567                         !< number for random generator   
273    INTEGER(iwp) ::  max_number_particles_per_gridbox = 100       !< namelist parameter (see documentation)
274    INTEGER(iwp) ::  isf                                          !< dummy for splitting function
275    INTEGER(iwp) ::  number_particles_per_gridbox = -1            !< namelist parameter (see documentation)
276    INTEGER(iwp) ::  number_of_sublayers = 20                     !< number of sublayers for particle velocities betwenn surface and first grid level
277    INTEGER(iwp) ::  offset_ocean_nzt = 0                         !< in case of oceans runs, the vertical index calculations need an offset
278    INTEGER(iwp) ::  offset_ocean_nzt_m1 = 0                      !< in case of oceans runs, the vertical index calculations need an offset
279    INTEGER(iwp) ::  particles_per_point = 1                      !< namelist parameter (see documentation)
280    INTEGER(iwp) ::  radius_classes = 20                          !< namelist parameter (see documentation)
281    INTEGER(iwp) ::  splitting_factor = 2                         !< namelist parameter (see documentation)
282    INTEGER(iwp) ::  splitting_factor_max = 5                     !< namelist parameter (see documentation)
283    INTEGER(iwp) ::  step_dealloc = 100                           !< namelist parameter (see documentation)
284    INTEGER(iwp) ::  total_number_of_particles                    !< total number of particles in the whole model domain
285    INTEGER(iwp) ::  trlp_count_sum                               !< parameter for particle exchange of PEs
286    INTEGER(iwp) ::  trlp_count_recv_sum                          !< parameter for particle exchange of PEs
287    INTEGER(iwp) ::  trrp_count_sum                               !< parameter for particle exchange of PEs
288    INTEGER(iwp) ::  trrp_count_recv_sum                          !< parameter for particle exchange of PEs
289    INTEGER(iwp) ::  trsp_count_sum                               !< parameter for particle exchange of PEs
290    INTEGER(iwp) ::  trsp_count_recv_sum                          !< parameter for particle exchange of PEs
291    INTEGER(iwp) ::  trnp_count_sum                               !< parameter for particle exchange of PEs
292    INTEGER(iwp) ::  trnp_count_recv_sum                          !< parameter for particle exchange of PEs
293
294    LOGICAL ::  lagrangian_particle_model = .FALSE.       !< namelist parameter (see documentation)
295    LOGICAL ::  curvature_solution_effects = .FALSE.      !< namelist parameter (see documentation)
296    LOGICAL ::  deallocate_memory = .TRUE.                !< namelist parameter (see documentation)
297    LOGICAL ::  hall_kernel = .FALSE.                     !< flag for collision kernel
298    LOGICAL ::  merging = .FALSE.                         !< namelist parameter (see documentation)
299    LOGICAL ::  random_start_position = .FALSE.           !< namelist parameter (see documentation)
300    LOGICAL ::  read_particles_from_restartfile = .TRUE.  !< namelist parameter (see documentation)
301    LOGICAL ::  seed_follows_topography = .FALSE.         !< namelist parameter (see documentation)
302    LOGICAL ::  splitting = .FALSE.                       !< namelist parameter (see documentation)
303    LOGICAL ::  use_kernel_tables = .FALSE.               !< parameter, which turns on the use of precalculated collision kernels
304    LOGICAL ::  write_particle_statistics = .FALSE.       !< namelist parameter (see documentation)
305
306    LOGICAL, DIMENSION(max_number_of_particle_groups) ::   vertical_particle_advection = .TRUE. !< Switch for vertical particle transport
307
308    REAL(wp) ::  aero_weight = 1.0_wp                      !< namelist parameter (see documentation)
309    REAL(wp) ::  dt_min_part = 0.0002_wp                   !< minimum particle time step when SGS velocities are used (s)
310    REAL(wp) ::  dt_prel = 9999999.9_wp                    !< namelist parameter (see documentation)
311    REAL(wp) ::  dt_write_particle_data = 9999999.9_wp     !< namelist parameter (see documentation)
312    REAL(wp) ::  end_time_prel = 9999999.9_wp              !< namelist parameter (see documentation)
313    REAL(wp) ::  initial_weighting_factor = 1.0_wp         !< namelist parameter (see documentation)
314    REAL(wp) ::  last_particle_release_time = 0.0_wp       !< last time of particle release
315    REAL(wp) ::  log_sigma(3) = 1.0_wp                     !< namelist parameter (see documentation)
316    REAL(wp) ::  na(3) = 0.0_wp                            !< namelist parameter (see documentation)
317    REAL(wp) ::  number_concentration = -1.0_wp            !< namelist parameter (see documentation)
318    REAL(wp) ::  radius_merge = 1.0E-7_wp                  !< namelist parameter (see documentation)
319    REAL(wp) ::  radius_split = 40.0E-6_wp                 !< namelist parameter (see documentation)
320    REAL(wp) ::  rm(3) = 1.0E-6_wp                         !< namelist parameter (see documentation)
321    REAL(wp) ::  sgs_wf_part                               !< parameter for sgs
322    REAL(wp) ::  time_write_particle_data = 0.0_wp         !< write particle data at current time on file
323    REAL(wp) ::  weight_factor_merge = -1.0_wp             !< namelist parameter (see documentation)
324    REAL(wp) ::  weight_factor_split = -1.0_wp             !< namelist parameter (see documentation)
325    REAL(wp) ::  z0_av_global                              !< horizontal mean value of z0
326
327    REAL(wp) ::  rclass_lbound !<
328    REAL(wp) ::  rclass_ubound !<
329
330    REAL(wp), PARAMETER ::  c_0 = 3.0_wp         !< parameter for lagrangian timescale
331
332    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  density_ratio = 9999999.9_wp  !< namelist parameter (see documentation)
333    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdx = 9999999.9_wp            !< namelist parameter (see documentation)
334    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdy = 9999999.9_wp            !< namelist parameter (see documentation)
335    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdz = 9999999.9_wp            !< namelist parameter (see documentation)
336    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psb = 9999999.9_wp            !< namelist parameter (see documentation)
337    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psl = 9999999.9_wp            !< namelist parameter (see documentation)
338    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psn = 9999999.9_wp            !< namelist parameter (see documentation)
339    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psr = 9999999.9_wp            !< namelist parameter (see documentation)
340    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pss = 9999999.9_wp            !< namelist parameter (see documentation)
341    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pst = 9999999.9_wp            !< namelist parameter (see documentation).
342    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  radius = 9999999.9_wp         !< namelist parameter (see documentation)
343
344    REAL(wp), DIMENSION(:), ALLOCATABLE     ::  log_z_z0   !< Precalculate LOG(z/z0) 
345
346    INTEGER(iwp), PARAMETER ::  NR_2_direction_move = 10000 !<
347    INTEGER(iwp)            ::  nr_move_north               !<
348    INTEGER(iwp)            ::  nr_move_south               !<
349
350    TYPE(particle_type), DIMENSION(:), ALLOCATABLE ::  move_also_north
351    TYPE(particle_type), DIMENSION(:), ALLOCATABLE ::  move_also_south
352
353    REAL(wp) ::  epsilon_collision !<
354    REAL(wp) ::  urms              !<
355
356    REAL(wp), DIMENSION(:),   ALLOCATABLE ::  epsclass  !< dissipation rate class
357    REAL(wp), DIMENSION(:),   ALLOCATABLE ::  radclass  !< radius class
358    REAL(wp), DIMENSION(:),   ALLOCATABLE ::  winf      !<
359
360    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ec        !<
361    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  ecf       !<
362    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  gck       !<
363    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  hkernel   !<
364    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  hwratio   !<
365
366    REAL(wp), DIMENSION(:,:,:), ALLOCATABLE ::  ckernel !<
367
368    INTEGER(iwp), PARAMETER         :: PHASE_INIT    = 1  !<
369    INTEGER(iwp), PARAMETER, PUBLIC :: PHASE_RELEASE = 2  !<
370
371    SAVE
372
373    PRIVATE
374
375    PUBLIC lpm_parin,     &
376           lpm_header,    &
377           lpm_init_arrays,&
378           lpm_init,      &
379           lpm_actions,   &
380           lpm_data_output_ptseries, &
381           lpm_interaction_droplets_ptq, &
382           lpm_rrd_local_particles, &
383           lpm_wrd_local, &
384           lpm_rrd_global, &
385           lpm_wrd_global, &
386           lpm_rrd_local, &
387           lpm_check_parameters
388
389    PUBLIC lagrangian_particle_model
390
391    INTERFACE lpm_check_parameters
392       MODULE PROCEDURE lpm_check_parameters
393    END INTERFACE lpm_check_parameters
394
395    INTERFACE lpm_parin
396       MODULE PROCEDURE lpm_parin
397    END INTERFACE lpm_parin
398
399    INTERFACE lpm_header
400       MODULE PROCEDURE lpm_header
401    END INTERFACE lpm_header
402
403    INTERFACE lpm_init_arrays
404       MODULE PROCEDURE lpm_init_arrays
405    END INTERFACE lpm_init_arrays
406 
407    INTERFACE lpm_init
408       MODULE PROCEDURE lpm_init
409    END INTERFACE lpm_init
410
411    INTERFACE lpm_actions
412       MODULE PROCEDURE lpm_actions
413    END INTERFACE lpm_actions
414
415    INTERFACE lpm_data_output_ptseries
416       MODULE PROCEDURE lpm_data_output_ptseries
417    END INTERFACE
418
419    INTERFACE lpm_rrd_local_particles
420       MODULE PROCEDURE lpm_rrd_local_particles
421    END INTERFACE lpm_rrd_local_particles
422
423    INTERFACE lpm_rrd_global
424       MODULE PROCEDURE lpm_rrd_global
425    END INTERFACE lpm_rrd_global
426
427    INTERFACE lpm_rrd_local
428       MODULE PROCEDURE lpm_rrd_local
429    END INTERFACE lpm_rrd_local
430
431    INTERFACE lpm_wrd_local
432       MODULE PROCEDURE lpm_wrd_local
433    END INTERFACE lpm_wrd_local
434
435    INTERFACE lpm_wrd_global
436       MODULE PROCEDURE lpm_wrd_global
437    END INTERFACE lpm_wrd_global
438
439    INTERFACE lpm_advec
440       MODULE PROCEDURE lpm_advec
441    END INTERFACE lpm_advec
442
443    INTERFACE lpm_calc_liquid_water_content
444       MODULE PROCEDURE lpm_calc_liquid_water_content
445    END INTERFACE
446
447    INTERFACE lpm_interaction_droplets_ptq
448       MODULE PROCEDURE lpm_interaction_droplets_ptq
449       MODULE PROCEDURE lpm_interaction_droplets_ptq_ij
450    END INTERFACE lpm_interaction_droplets_ptq
451
452    INTERFACE lpm_boundary_conds
453       MODULE PROCEDURE lpm_boundary_conds
454    END INTERFACE lpm_boundary_conds
455
456    INTERFACE lpm_droplet_condensation
457       MODULE PROCEDURE lpm_droplet_condensation
458    END INTERFACE
459
460    INTERFACE lpm_droplet_collision
461       MODULE PROCEDURE lpm_droplet_collision
462    END INTERFACE lpm_droplet_collision
463
464    INTERFACE lpm_init_kernels
465       MODULE PROCEDURE lpm_init_kernels
466    END INTERFACE lpm_init_kernels
467
468    INTERFACE lpm_splitting
469       MODULE PROCEDURE lpm_splitting
470    END INTERFACE lpm_splitting
471
472    INTERFACE lpm_merging
473       MODULE PROCEDURE lpm_merging
474    END INTERFACE lpm_merging
475
476    INTERFACE lpm_exchange_horiz
477       MODULE PROCEDURE lpm_exchange_horiz
478    END INTERFACE lpm_exchange_horiz
479
480    INTERFACE lpm_move_particle
481       MODULE PROCEDURE lpm_move_particle
482    END INTERFACE lpm_move_particle
483
484    INTERFACE realloc_particles_array
485       MODULE PROCEDURE realloc_particles_array
486    END INTERFACE realloc_particles_array
487
488    INTERFACE dealloc_particles_array
489       MODULE PROCEDURE dealloc_particles_array
490    END INTERFACE dealloc_particles_array
491
492    INTERFACE lpm_sort_in_subboxes
493       MODULE PROCEDURE lpm_sort_in_subboxes
494    END INTERFACE lpm_sort_in_subboxes
495
496    INTERFACE lpm_sort_timeloop_done
497       MODULE PROCEDURE lpm_sort_timeloop_done
498    END INTERFACE lpm_sort_timeloop_done
499
500    INTERFACE lpm_pack
501       MODULE PROCEDURE lpm_pack
502    END INTERFACE lpm_pack
503
504 CONTAINS
505 
506
507!------------------------------------------------------------------------------!
508! Description:
509! ------------
510!> Parin for &particle_parameters for the Lagrangian particle model
511!------------------------------------------------------------------------------!
512 SUBROUTINE lpm_parin
513 
514    CHARACTER (LEN=80) ::  line  !<
515
516    NAMELIST /particles_par/ &
517       aero_species, &
518       aero_type, &
519       aero_weight, &
520       alloc_factor, &
521       bc_par_b, &
522       bc_par_lr, &
523       bc_par_ns, &
524       bc_par_t, &
525       collision_kernel, &
526       curvature_solution_effects, &
527       deallocate_memory, &
528       density_ratio, &
529       dissipation_classes, &
530       dt_dopts, &
531       dt_min_part, &
532       dt_prel, &
533       dt_write_particle_data, &
534       end_time_prel, &
535       initial_weighting_factor, &
536       log_sigma, &
537       max_number_particles_per_gridbox, &
538       merging, &
539       na, &
540       number_concentration, &
541       number_of_particle_groups, &
542       number_particles_per_gridbox, &
543       particles_per_point, &
544       particle_advection_start, &
545       particle_maximum_age, &
546       pdx, &
547       pdy, &
548       pdz, &
549       psb, &
550       psl, &
551       psn, &
552       psr, &
553       pss, &
554       pst, &
555       radius, &
556       radius_classes, &
557       radius_merge, &
558       radius_split, &
559       random_start_position, &
560       read_particles_from_restartfile, &
561       rm, &
562       seed_follows_topography, &
563       splitting, &
564       splitting_factor, &
565       splitting_factor_max, &
566       splitting_function, &
567       splitting_mode, &
568       step_dealloc, &
569       use_sgs_for_particles, &
570       vertical_particle_advection, &
571       weight_factor_merge, &
572       weight_factor_split, &
573       write_particle_statistics
574
575       NAMELIST /particle_parameters/ &
576       aero_species, &
577       aero_type, &
578       aero_weight, &
579       alloc_factor, &
580       bc_par_b, &
581       bc_par_lr, &
582       bc_par_ns, &
583       bc_par_t, &
584       collision_kernel, &
585       curvature_solution_effects, &
586       deallocate_memory, &
587       density_ratio, &
588       dissipation_classes, &
589       dt_dopts, &
590       dt_min_part, &
591       dt_prel, &
592       dt_write_particle_data, &
593       end_time_prel, &
594       initial_weighting_factor, &
595       log_sigma, &
596       max_number_particles_per_gridbox, &
597       merging, &
598       na, &
599       number_concentration, &
600       number_of_particle_groups, &
601       number_particles_per_gridbox, &
602       particles_per_point, &
603       particle_advection_start, &
604       particle_maximum_age, &
605       pdx, &
606       pdy, &
607       pdz, &
608       psb, &
609       psl, &
610       psn, &
611       psr, &
612       pss, &
613       pst, &
614       radius, &
615       radius_classes, &
616       radius_merge, &
617       radius_split, &
618       random_start_position, &
619       read_particles_from_restartfile, &
620       rm, &
621       seed_follows_topography, &
622       splitting, &
623       splitting_factor, &
624       splitting_factor_max, &
625       splitting_function, &
626       splitting_mode, &
627       step_dealloc, &
628       use_sgs_for_particles, &
629       vertical_particle_advection, &
630       weight_factor_merge, &
631       weight_factor_split, &
632       write_particle_statistics
633
634!
635!-- Position the namelist-file at the beginning (it was already opened in
636!-- parin), search for the namelist-group of the package and position the
637!-- file at this line. Do the same for each optionally used package.
638    line = ' '
639   
640!
641!-- Try to find particles package
642    REWIND ( 11 )
643    line = ' '
644    DO   WHILE ( INDEX( line, '&particle_parameters' ) == 0 )
645       READ ( 11, '(A)', END=12 )  line
646    ENDDO
647    BACKSPACE ( 11 )
648!
649!-- Read user-defined namelist
650    READ ( 11, particle_parameters, ERR = 10 )
651!
652!-- Set flag that indicates that particles are switched on
653    particle_advection = .TRUE.
654   
655    GOTO 14
656
65710  BACKSPACE( 11 )
658    READ( 11 , '(A)') line
659    CALL parin_fail_message( 'particle_parameters', line )
660!
661!-- Try to find particles package (old namelist)
66212  REWIND ( 11 )
663    line = ' '
664    DO WHILE ( INDEX( line, '&particles_par' ) == 0 )
665       READ ( 11, '(A)', END=14 )  line
666    ENDDO
667    BACKSPACE ( 11 )
668!
669!-- Read user-defined namelist
670    READ ( 11, particles_par, ERR = 13, END = 14 )
671
672    message_string = 'namelist particles_par is deprecated and will be ' //    &
673                     'removed in near future. Please use namelist ' //         &
674                     'particle_parameters instead'
675    CALL message( 'package_parin', 'PA0487', 0, 1, 0, 6, 0 )
676
677!
678!-- Set flag that indicates that particles are switched on
679    particle_advection = .TRUE.
680
681    GOTO 14
682
68313    BACKSPACE( 11 )
684       READ( 11 , '(A)') line
685       CALL parin_fail_message( 'particles_par', line )
686
68714 CONTINUE
688
689 END SUBROUTINE lpm_parin
690 
691!------------------------------------------------------------------------------!
692! Description:
693! ------------
694!> Writes used particle attributes in header file.
695!------------------------------------------------------------------------------!
696 SUBROUTINE lpm_header ( io )
697
698    CHARACTER (LEN=40) ::  output_format       !< netcdf format
699 
700    INTEGER(iwp) ::  i               !<
701    INTEGER(iwp), INTENT(IN) ::  io  !< Unit of the output file
702
703 
704     IF ( humidity  .AND.  cloud_droplets )  THEN
705       WRITE ( io, 433 )
706       IF ( curvature_solution_effects )  WRITE ( io, 434 )
707       IF ( collision_kernel /= 'none' )  THEN
708          WRITE ( io, 435 )  TRIM( collision_kernel )
709          IF ( collision_kernel(6:9) == 'fast' )  THEN
710             WRITE ( io, 436 )  radius_classes, dissipation_classes
711          ENDIF
712       ELSE
713          WRITE ( io, 437 )
714       ENDIF
715    ENDIF
716 
717    IF ( particle_advection )  THEN
718!
719!--    Particle attributes
720       WRITE ( io, 480 )  particle_advection_start, dt_prel, bc_par_lr, &
721                          bc_par_ns, bc_par_b, bc_par_t, particle_maximum_age, &
722                          end_time_prel
723       IF ( use_sgs_for_particles )  WRITE ( io, 488 )  dt_min_part
724       IF ( random_start_position )  WRITE ( io, 481 )
725       IF ( seed_follows_topography )  WRITE ( io, 496 )
726       IF ( particles_per_point > 1 )  WRITE ( io, 489 )  particles_per_point
727       WRITE ( io, 495 )  total_number_of_particles
728       IF ( dt_write_particle_data /= 9999999.9_wp )  THEN
729          WRITE ( io, 485 )  dt_write_particle_data
730          IF ( netcdf_data_format > 1 )  THEN
731             output_format = 'netcdf (64 bit offset) and binary'
732          ELSE
733             output_format = 'netcdf and binary'
734          ENDIF
735          IF ( netcdf_deflate == 0 )  THEN
736             WRITE ( io, 344 )  output_format
737          ELSE
738             WRITE ( io, 354 )  TRIM( output_format ), netcdf_deflate
739          ENDIF
740       ENDIF
741       IF ( dt_dopts /= 9999999.9_wp )  WRITE ( io, 494 )  dt_dopts
742       IF ( write_particle_statistics )  WRITE ( io, 486 )
743
744       WRITE ( io, 487 )  number_of_particle_groups
745
746       DO  i = 1, number_of_particle_groups
747          IF ( i == 1  .AND.  density_ratio(i) == 9999999.9_wp )  THEN
748             WRITE ( io, 490 )  i, 0.0_wp
749             WRITE ( io, 492 )
750          ELSE
751             WRITE ( io, 490 )  i, radius(i)
752             IF ( density_ratio(i) /= 0.0_wp )  THEN
753                WRITE ( io, 491 )  density_ratio(i)
754             ELSE
755                WRITE ( io, 492 )
756             ENDIF
757          ENDIF
758          WRITE ( io, 493 )  psl(i), psr(i), pss(i), psn(i), psb(i), pst(i), &
759                             pdx(i), pdy(i), pdz(i)
760          IF ( .NOT. vertical_particle_advection(i) )  WRITE ( io, 482 )
761       ENDDO
762
763    ENDIF
764   
765344 FORMAT ('       Output format: ',A/)
766354 FORMAT ('       Output format: ',A, '   compressed with level: ',I1/)
767
768433 FORMAT ('    Cloud droplets treated explicitly using the Lagrangian part', &
769                 'icle model')
770434 FORMAT ('    Curvature and solution effecs are considered for growth of', &
771                 ' droplets < 1.0E-6 m')
772435 FORMAT ('    Droplet collision is handled by ',A,'-kernel')
773436 FORMAT ('       Fast kernel with fixed radius- and dissipation classes ', &
774                    'are used'/ &
775            '          number of radius classes:       ',I3,'    interval ', &
776                       '[1.0E-6,2.0E-4] m'/ &
777            '          number of dissipation classes:   ',I2,'    interval ', &
778                       '[0,1000] cm**2/s**3')
779437 FORMAT ('    Droplet collision is switched off')
780
781480 FORMAT ('    Particles:'/ &
782            '    ---------'// &
783            '       Particle advection is active (switched on at t = ', F7.1, &
784                    ' s)'/ &
785            '       Start of new particle generations every  ',F6.1,' s'/ &
786            '       Boundary conditions: left/right: ', A, ' north/south: ', A/&
787            '                            bottom:     ', A, ' top:         ', A/&
788            '       Maximum particle age:                 ',F9.1,' s'/ &
789            '       Advection stopped at t = ',F9.1,' s'/)
790481 FORMAT ('       Particles have random start positions'/)
791482 FORMAT ('          Particles are advected only horizontally'/)
792485 FORMAT ('       Particle data are written on file every ', F9.1, ' s')
793486 FORMAT ('       Particle statistics are written on file'/)
794487 FORMAT ('       Number of particle groups: ',I2/)
795488 FORMAT ('       SGS velocity components are used for particle advection'/ &
796            '          minimum timestep for advection:', F8.5/)
797489 FORMAT ('       Number of particles simultaneously released at each ', &
798                    'point: ', I5/)
799490 FORMAT ('       Particle group ',I2,':'/ &
800            '          Particle radius: ',E10.3, 'm')
801491 FORMAT ('          Particle inertia is activated'/ &
802            '             density_ratio (rho_fluid/rho_particle) =',F6.3/)
803492 FORMAT ('          Particles are advected only passively (no inertia)'/)
804493 FORMAT ('          Boundaries of particle source: x:',F8.1,' - ',F8.1,' m'/&
805            '                                         y:',F8.1,' - ',F8.1,' m'/&
806            '                                         z:',F8.1,' - ',F8.1,' m'/&
807            '          Particle distances:  dx = ',F8.1,' m  dy = ',F8.1, &
808                       ' m  dz = ',F8.1,' m'/)
809494 FORMAT ('       Output of particle time series in NetCDF format every ', &
810                    F8.2,' s'/)
811495 FORMAT ('       Number of particles in total domain: ',I10/)
812496 FORMAT ('       Initial vertical particle positions are interpreted ', &
813                    'as relative to the given topography')
814   
815 END SUBROUTINE lpm_header
816 
817!------------------------------------------------------------------------------!
818! Description:
819! ------------
820!> Writes used particle attributes in header file.
821!------------------------------------------------------------------------------! 
822 SUBROUTINE lpm_check_parameters
823 
824!
825!-- Collision kernels:
826    SELECT CASE ( TRIM( collision_kernel ) )
827
828       CASE ( 'hall', 'hall_fast' )
829          hall_kernel = .TRUE.
830
831       CASE ( 'wang', 'wang_fast' )
832          wang_kernel = .TRUE.
833
834       CASE ( 'none' )
835
836
837       CASE DEFAULT
838          message_string = 'unknown collision kernel: collision_kernel = "' // &
839                           TRIM( collision_kernel ) // '"'
840          CALL message( 'check_parameters', 'PA0350', 1, 2, 0, 6, 0 )
841
842    END SELECT
843    IF ( collision_kernel(6:9) == 'fast' )  use_kernel_tables = .TRUE.
844
845 END SUBROUTINE
846 
847!------------------------------------------------------------------------------!
848! Description:
849! ------------
850!> Initialize arrays for lpm
851!------------------------------------------------------------------------------!   
852 SUBROUTINE lpm_init_arrays
853 
854    IF ( cloud_droplets )  THEN
855!
856!--    Liquid water content, change in liquid water content
857       ALLOCATE ( ql_1(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                      &
858                  ql_2(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
859!
860!--    Real volume of particles (with weighting), volume of particles
861       ALLOCATE ( ql_v(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                      &
862                     ql_vp(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
863    ENDIF
864   
865!
866!--    Initial assignment of the pointers   
867    IF ( cloud_droplets )  THEN
868       ql   => ql_1
869       ql_c => ql_2
870    ENDIF
871   
872 END SUBROUTINE lpm_init_arrays
873 
874!------------------------------------------------------------------------------!
875! Description:
876! ------------
877!> Initialize Lagrangian particle model
878!------------------------------------------------------------------------------!
879 SUBROUTINE lpm_init
880
881    INTEGER(iwp) ::  i                           !<
882    INTEGER(iwp) ::  j                           !<
883    INTEGER(iwp) ::  k                           !<
884
885    REAL(wp) ::  div                             !<
886    REAL(wp) ::  height_int                      !<
887    REAL(wp) ::  height_p                        !<
888    REAL(wp) ::  z_p                             !<
889    REAL(wp) ::  z0_av_local                     !<
890
891!
892!-- In case of oceans runs, the vertical index calculations need an offset,
893!-- because otherwise the k indices will become negative
894    IF ( ocean_mode )  THEN
895       offset_ocean_nzt    = nzt
896       offset_ocean_nzt_m1 = nzt - 1
897    ENDIF
898
899!
900!-- Define block offsets for dividing a gridcell in 8 sub cells
901!-- See documentation for List of subgrid boxes
902!-- See pack_and_sort in lpm_pack_arrays.f90 for assignment of the subgrid boxes
903    block_offset(0) = block_offset_def ( 0, 0, 0)
904    block_offset(1) = block_offset_def ( 0, 0,-1)
905    block_offset(2) = block_offset_def ( 0,-1, 0)
906    block_offset(3) = block_offset_def ( 0,-1,-1)
907    block_offset(4) = block_offset_def (-1, 0, 0)
908    block_offset(5) = block_offset_def (-1, 0,-1)
909    block_offset(6) = block_offset_def (-1,-1, 0)
910    block_offset(7) = block_offset_def (-1,-1,-1)
911!
912!-- Check the number of particle groups.
913    IF ( number_of_particle_groups > max_number_of_particle_groups )  THEN
914       WRITE( message_string, * ) 'max_number_of_particle_groups =',           &
915                                  max_number_of_particle_groups ,              &
916                                  '&number_of_particle_groups reset to ',      &
917                                  max_number_of_particle_groups
918       CALL message( 'lpm_init', 'PA0213', 0, 1, 0, 6, 0 )
919       number_of_particle_groups = max_number_of_particle_groups
920    ENDIF
921!
922!-- Check if downward-facing walls exist. This case, reflection boundary
923!-- conditions (as well as subgrid-scale velocities) may do not work
924!-- propably (not realized so far).
925    IF ( surf_def_h(1)%ns >= 1 )  THEN
926       WRITE( message_string, * ) 'Overhanging topography do not work '//      &
927                                  'with particles'
928       CALL message( 'lpm_init', 'PA0212', 0, 1, 0, 6, 0 )
929
930    ENDIF
931
932!
933!-- Set default start positions, if necessary
934    IF ( psl(1) == 9999999.9_wp )  psl(1) = 0.0_wp
935    IF ( psr(1) == 9999999.9_wp )  psr(1) = ( nx +1 ) * dx
936    IF ( pss(1) == 9999999.9_wp )  pss(1) = 0.0_wp
937    IF ( psn(1) == 9999999.9_wp )  psn(1) = ( ny +1 ) * dy
938    IF ( psb(1) == 9999999.9_wp )  psb(1) = zu(nz/2)
939    IF ( pst(1) == 9999999.9_wp )  pst(1) = psb(1)
940
941    IF ( pdx(1) == 9999999.9_wp  .OR.  pdx(1) == 0.0_wp )  pdx(1) = dx
942    IF ( pdy(1) == 9999999.9_wp  .OR.  pdy(1) == 0.0_wp )  pdy(1) = dy
943    IF ( pdz(1) == 9999999.9_wp  .OR.  pdz(1) == 0.0_wp )  pdz(1) = zu(2) - zu(1)
944
945!
946!-- If number_particles_per_gridbox is set, the parametres pdx, pdy and pdz are
947!-- calculated diagnostically. Therfore an isotropic distribution is prescribed.
948    IF ( number_particles_per_gridbox /= -1 .AND.   &
949         number_particles_per_gridbox >= 1 )    THEN
950       pdx(1) = (( dx * dy * ( zu(2) - zu(1) ) ) /  &
951             REAL(number_particles_per_gridbox))**0.3333333_wp
952!
953!--    Ensure a smooth value (two significant digits) of distance between
954!--    particles (pdx, pdy, pdz).
955       div = 1000.0_wp
956       DO  WHILE ( pdx(1) < div )
957          div = div / 10.0_wp
958       ENDDO
959       pdx(1) = NINT( pdx(1) * 100.0_wp / div ) * div / 100.0_wp
960       pdy(1) = pdx(1)
961       pdz(1) = pdx(1)
962
963    ENDIF
964
965    DO  j = 2, number_of_particle_groups
966       IF ( psl(j) == 9999999.9_wp )  psl(j) = psl(j-1)
967       IF ( psr(j) == 9999999.9_wp )  psr(j) = psr(j-1)
968       IF ( pss(j) == 9999999.9_wp )  pss(j) = pss(j-1)
969       IF ( psn(j) == 9999999.9_wp )  psn(j) = psn(j-1)
970       IF ( psb(j) == 9999999.9_wp )  psb(j) = psb(j-1)
971       IF ( pst(j) == 9999999.9_wp )  pst(j) = pst(j-1)
972       IF ( pdx(j) == 9999999.9_wp  .OR.  pdx(j) == 0.0_wp )  pdx(j) = pdx(j-1)
973       IF ( pdy(j) == 9999999.9_wp  .OR.  pdy(j) == 0.0_wp )  pdy(j) = pdy(j-1)
974       IF ( pdz(j) == 9999999.9_wp  .OR.  pdz(j) == 0.0_wp )  pdz(j) = pdz(j-1)
975    ENDDO
976
977!
978!-- Allocate arrays required for calculating particle SGS velocities.
979!-- Initialize prefactor required for stoachastic Weil equation.
980    IF ( use_sgs_for_particles  .AND.  .NOT. cloud_droplets )  THEN
981       ALLOCATE( de_dx(nzb:nzt+1,nysg:nyng,nxlg:nxrg), &
982                 de_dy(nzb:nzt+1,nysg:nyng,nxlg:nxrg), &
983                 de_dz(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
984
985       de_dx = 0.0_wp
986       de_dy = 0.0_wp
987       de_dz = 0.0_wp             
988                 
989       sgs_wf_part = 1.0_wp / 3.0_wp
990    ENDIF
991
992!
993!-- Allocate array required for logarithmic vertical interpolation of
994!-- horizontal particle velocities between the surface and the first vertical
995!-- grid level. In order to avoid repeated CPU cost-intensive CALLS of
996!-- intrinsic FORTRAN procedure LOG(z/z0), LOG(z/z0) is precalculated for
997!-- several heights. Splitting into 20 sublayers turned out to be sufficient.
998!-- To obtain exact height levels of particles, linear interpolation is applied
999!-- (see lpm_advec.f90).
1000    IF ( constant_flux_layer )  THEN
1001
1002       ALLOCATE ( log_z_z0(0:number_of_sublayers) )
1003       z_p = zu(nzb+1) - zw(nzb)
1004
1005!
1006!--    Calculate horizontal mean value of z0 used for logartihmic
1007!--    interpolation. Note: this is not exact for heterogeneous z0.
1008!--    However, sensitivity studies showed that the effect is
1009!--    negligible.
1010       z0_av_local  = SUM( surf_def_h(0)%z0 ) + SUM( surf_lsm_h%z0 ) +         &
1011                      SUM( surf_usm_h%z0 )
1012       z0_av_global = 0.0_wp
1013
1014#if defined( __parallel )
1015       CALL MPI_ALLREDUCE(z0_av_local, z0_av_global, 1, MPI_REAL, MPI_SUM, &
1016                          comm2d, ierr )
1017#else
1018       z0_av_global = z0_av_local
1019#endif
1020
1021       z0_av_global = z0_av_global  / ( ( ny + 1 ) * ( nx + 1 ) )
1022!
1023!--    Horizontal wind speed is zero below and at z0
1024       log_z_z0(0) = 0.0_wp
1025!
1026!--    Calculate vertical depth of the sublayers
1027       height_int  = ( z_p - z0_av_global ) / REAL( number_of_sublayers, KIND=wp )
1028!
1029!--    Precalculate LOG(z/z0)
1030       height_p    = z0_av_global
1031       DO  k = 1, number_of_sublayers
1032
1033          height_p    = height_p + height_int
1034          log_z_z0(k) = LOG( height_p / z0_av_global )
1035
1036       ENDDO
1037
1038    ENDIF
1039
1040!
1041!-- Check boundary condition and set internal variables
1042    SELECT CASE ( bc_par_b )
1043
1044       CASE ( 'absorb' )
1045          ibc_par_b = 1
1046
1047       CASE ( 'reflect' )
1048          ibc_par_b = 2
1049
1050       CASE DEFAULT
1051          WRITE( message_string, * )  'unknown boundary condition ',           &
1052                                       'bc_par_b = "', TRIM( bc_par_b ), '"'
1053          CALL message( 'lpm_init', 'PA0217', 1, 2, 0, 6, 0 )
1054
1055    END SELECT
1056    SELECT CASE ( bc_par_t )
1057
1058       CASE ( 'absorb' )
1059          ibc_par_t = 1
1060
1061       CASE ( 'reflect' )
1062          ibc_par_t = 2
1063         
1064       CASE ( 'nested' )
1065          ibc_par_t = 3
1066
1067       CASE DEFAULT
1068          WRITE( message_string, * ) 'unknown boundary condition ',            &
1069                                     'bc_par_t = "', TRIM( bc_par_t ), '"'
1070          CALL message( 'lpm_init', 'PA0218', 1, 2, 0, 6, 0 )
1071
1072    END SELECT
1073    SELECT CASE ( bc_par_lr )
1074
1075       CASE ( 'cyclic' )
1076          ibc_par_lr = 0
1077
1078       CASE ( 'absorb' )
1079          ibc_par_lr = 1
1080
1081       CASE ( 'reflect' )
1082          ibc_par_lr = 2
1083         
1084       CASE ( 'nested' )
1085          ibc_par_lr = 3
1086
1087       CASE DEFAULT
1088          WRITE( message_string, * ) 'unknown boundary condition ',   &
1089                                     'bc_par_lr = "', TRIM( bc_par_lr ), '"'
1090          CALL message( 'lpm_init', 'PA0219', 1, 2, 0, 6, 0 )
1091
1092    END SELECT
1093    SELECT CASE ( bc_par_ns )
1094
1095       CASE ( 'cyclic' )
1096          ibc_par_ns = 0
1097
1098       CASE ( 'absorb' )
1099          ibc_par_ns = 1
1100
1101       CASE ( 'reflect' )
1102          ibc_par_ns = 2
1103         
1104       CASE ( 'nested' )
1105          ibc_par_ns = 3
1106
1107       CASE DEFAULT
1108          WRITE( message_string, * ) 'unknown boundary condition ',   &
1109                                     'bc_par_ns = "', TRIM( bc_par_ns ), '"'
1110          CALL message( 'lpm_init', 'PA0220', 1, 2, 0, 6, 0 )
1111
1112    END SELECT
1113    SELECT CASE ( splitting_mode )
1114
1115       CASE ( 'const' )
1116          i_splitting_mode = 1
1117
1118       CASE ( 'cl_av' )
1119          i_splitting_mode = 2
1120
1121       CASE ( 'gb_av' )
1122          i_splitting_mode = 3
1123
1124       CASE DEFAULT
1125          WRITE( message_string, * )  'unknown splitting_mode = "',            &
1126                                      TRIM( splitting_mode ), '"'
1127          CALL message( 'lpm_init', 'PA0146', 1, 2, 0, 6, 0 )
1128
1129    END SELECT
1130    SELECT CASE ( splitting_function )
1131
1132       CASE ( 'gamma' )
1133          isf = 1
1134
1135       CASE ( 'log' )
1136          isf = 2
1137
1138       CASE ( 'exp' )
1139          isf = 3
1140
1141       CASE DEFAULT
1142          WRITE( message_string, * )  'unknown splitting function = "',        &
1143                                       TRIM( splitting_function ), '"'
1144          CALL message( 'lpm_init', 'PA0147', 1, 2, 0, 6, 0 )
1145
1146    END SELECT
1147!
1148!-- Initialize collision kernels
1149    IF ( collision_kernel /= 'none' )  CALL lpm_init_kernels
1150!
1151!-- For the first model run of a possible job chain initialize the
1152!-- particles, otherwise read the particle data from restart file.
1153    IF ( TRIM( initializing_actions ) == 'read_restart_data'  &
1154         .AND.  read_particles_from_restartfile )  THEN
1155       CALL lpm_rrd_local_particles
1156    ELSE
1157!
1158!--    Allocate particle arrays and set attributes of the initial set of
1159!--    particles, which can be also periodically released at later times.
1160       ALLOCATE( prt_count(nzb:nzt+1,nysg:nyng,nxlg:nxrg), &
1161                 grid_particles(nzb+1:nzt,nys:nyn,nxl:nxr) )
1162
1163       number_of_particles = 0
1164       prt_count           = 0
1165!
1166!--    initialize counter for particle IDs
1167       grid_particles%id_counter = 1
1168!
1169!--    Initialize all particles with dummy values (otherwise errors may
1170!--    occur within restart runs). The reason for this is still not clear
1171!--    and may be presumably caused by errors in the respective user-interface.
1172       zero_particle = particle_type( 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,  &
1173                                      0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,  &
1174                                      0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,  &
1175                                      0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,  &
1176                                      0, 0, 0_idp, .FALSE., -1 )
1177
1178       particle_groups = particle_groups_type( 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp )
1179!
1180!--    Set values for the density ratio and radius for all particle
1181!--    groups, if necessary
1182       IF ( density_ratio(1) == 9999999.9_wp )  density_ratio(1) = 0.0_wp
1183       IF ( radius(1)        == 9999999.9_wp )  radius(1) = 0.0_wp
1184       DO  i = 2, number_of_particle_groups
1185          IF ( density_ratio(i) == 9999999.9_wp )  THEN
1186             density_ratio(i) = density_ratio(i-1)
1187          ENDIF
1188          IF ( radius(i) == 9999999.9_wp )  radius(i) = radius(i-1)
1189       ENDDO
1190
1191       DO  i = 1, number_of_particle_groups
1192          IF ( density_ratio(i) /= 0.0_wp  .AND.  radius(i) == 0 )  THEN
1193             WRITE( message_string, * ) 'particle group #', i, ' has a',       &
1194                                        'density ratio /= 0 but radius = 0'
1195             CALL message( 'lpm_init', 'PA0215', 1, 2, 0, 6, 0 )
1196          ENDIF
1197          particle_groups(i)%density_ratio = density_ratio(i)
1198          particle_groups(i)%radius        = radius(i)
1199       ENDDO
1200!
1201!--    Set a seed value for the random number generator to be exclusively
1202!--    used for the particle code. The generated random numbers should be
1203!--    different on the different PEs.
1204       iran_part = iran_part + myid
1205!
1206!--    Create the particle set, and set the initial particles
1207       CALL lpm_create_particle( phase_init )
1208       last_particle_release_time = particle_advection_start
1209!
1210!--    User modification of initial particles
1211       CALL user_lpm_init
1212!
1213!--    Open file for statistical informations about particle conditions
1214       IF ( write_particle_statistics )  THEN
1215          CALL check_open( 80 )
1216          WRITE ( 80, 8000 )  current_timestep_number, simulated_time,         &
1217                              number_of_particles
1218          CALL close_file( 80 )
1219       ENDIF
1220
1221    ENDIF
1222
1223    IF ( nested_run )  CALL pmcp_g_init
1224!
1225!-- To avoid programm abort, assign particles array to the local version of
1226!-- first grid cell
1227    number_of_particles = prt_count(nzb+1,nys,nxl)
1228    particles => grid_particles(nzb+1,nys,nxl)%particles(1:number_of_particles)
1229!
1230!-- Formats
12318000 FORMAT (I6,1X,F7.2,4X,I10,71X,I10)
1232
1233 END SUBROUTINE lpm_init
1234 
1235!------------------------------------------------------------------------------!
1236! Description:
1237! ------------
1238!> Create Lagrangian particles
1239!------------------------------------------------------------------------------! 
1240 SUBROUTINE lpm_create_particle (phase)
1241
1242    INTEGER(iwp)               ::  alloc_size  !< relative increase of allocated memory for particles
1243    INTEGER(iwp)               ::  i           !< loop variable ( particle groups )
1244    INTEGER(iwp)               ::  ip          !< index variable along x
1245    INTEGER(iwp)               ::  j           !< loop variable ( particles per point )
1246    INTEGER(iwp)               ::  jp          !< index variable along y
1247    INTEGER(iwp)               ::  k           !< index variable along z
1248    INTEGER(iwp)               ::  k_surf      !< index of surface grid point
1249    INTEGER(iwp)               ::  kp          !< index variable along z
1250    INTEGER(iwp)               ::  loop_stride !< loop variable for initialization
1251    INTEGER(iwp)               ::  n           !< loop variable ( number of particles )
1252    INTEGER(iwp)               ::  new_size    !< new size of allocated memory for particles
1253
1254    INTEGER(iwp), INTENT(IN)   ::  phase       !< mode of inititialization
1255
1256    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_count !< start address of new particle
1257    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_start !< start address of new particle
1258
1259    LOGICAL                    ::  first_stride !< flag for initialization
1260
1261    REAL(wp)                   ::  pos_x      !< increment for particle position in x
1262    REAL(wp)                   ::  pos_y      !< increment for particle position in y
1263    REAL(wp)                   ::  pos_z      !< increment for particle position in z
1264    REAL(wp)                   ::  rand_contr !< dummy argument for random position
1265
1266    TYPE(particle_type),TARGET ::  tmp_particle !< temporary particle used for initialization
1267
1268!
1269!-- Calculate particle positions and store particle attributes, if
1270!-- particle is situated on this PE
1271    DO  loop_stride = 1, 2
1272       first_stride = (loop_stride == 1)
1273       IF ( first_stride )   THEN
1274          local_count = 0           ! count number of particles
1275       ELSE
1276          local_count = prt_count   ! Start address of new particles
1277       ENDIF
1278
1279!
1280!--    Calculate initial_weighting_factor diagnostically
1281       IF ( number_concentration /= -1.0_wp .AND. number_concentration > 0.0_wp ) THEN
1282          initial_weighting_factor =  number_concentration  *                        &
1283                                      pdx(1) * pdy(1) * pdz(1)
1284       END IF
1285
1286       n = 0
1287       DO  i = 1, number_of_particle_groups
1288          pos_z = psb(i)
1289          DO WHILE ( pos_z <= pst(i) )
1290             IF ( pos_z >= zw(0) .AND.  pos_z < zw(nzt) )  THEN
1291                pos_y = pss(i)
1292                DO WHILE ( pos_y <= psn(i) )
1293                   IF ( pos_y >= nys * dy  .AND.                  &
1294                        pos_y <  ( nyn + 1 ) * dy  ) THEN
1295                      pos_x = psl(i)
1296               xloop: DO WHILE ( pos_x <= psr(i) )
1297                         IF ( pos_x >= nxl * dx  .AND.            &
1298                              pos_x <  ( nxr + 1) * dx ) THEN
1299                            DO  j = 1, particles_per_point
1300                               n = n + 1
1301                               tmp_particle%x             = pos_x
1302                               tmp_particle%y             = pos_y
1303                               tmp_particle%z             = pos_z
1304                               tmp_particle%age           = 0.0_wp
1305                               tmp_particle%age_m         = 0.0_wp
1306                               tmp_particle%dt_sum        = 0.0_wp
1307                               tmp_particle%e_m           = 0.0_wp
1308                               tmp_particle%rvar1         = 0.0_wp
1309                               tmp_particle%rvar2         = 0.0_wp
1310                               tmp_particle%rvar3         = 0.0_wp
1311                               tmp_particle%speed_x       = 0.0_wp
1312                               tmp_particle%speed_y       = 0.0_wp
1313                               tmp_particle%speed_z       = 0.0_wp
1314                               tmp_particle%origin_x      = pos_x
1315                               tmp_particle%origin_y      = pos_y
1316                               tmp_particle%origin_z      = pos_z
1317                               IF ( curvature_solution_effects )  THEN
1318                                  tmp_particle%aux1      = 0.0_wp    ! dry aerosol radius
1319                                  tmp_particle%aux2      = dt_3d     ! last Rosenbrock timestep
1320                               ELSE
1321                                  tmp_particle%aux1      = 0.0_wp    ! free to use
1322                                  tmp_particle%aux2      = 0.0_wp    ! free to use
1323                               ENDIF
1324                               tmp_particle%radius        = particle_groups(i)%radius
1325                               tmp_particle%weight_factor = initial_weighting_factor
1326                               tmp_particle%class         = 1
1327                               tmp_particle%group         = i
1328                               tmp_particle%id            = 0_idp
1329                               tmp_particle%particle_mask = .TRUE.
1330                               tmp_particle%block_nr      = -1
1331!
1332!--                            Determine the grid indices of the particle position
1333                               ip = INT( tmp_particle%x * ddx )
1334                               jp = INT( tmp_particle%y * ddy )
1335!
1336!--                            In case of stretching the actual k index is found iteratively
1337                               IF ( dz_stretch_level .NE. -9999999.9  .OR.           &
1338                                    dz_stretch_level_start(1) .NE. -9999999.9 ) THEN
1339                                  kp = MINLOC( ABS( tmp_particle%z - zu ), DIM = 1 ) - 1
1340                               ELSE
1341                                  kp = INT( tmp_particle%z / dz(1) + 1 + offset_ocean_nzt )
1342                               ENDIF
1343!
1344!--                            Determine surface level. Therefore, check for
1345!--                            upward-facing wall on w-grid.
1346                               k_surf = get_topography_top_index_ji( jp, ip, 'w' )
1347                               IF ( seed_follows_topography )  THEN
1348!
1349!--                               Particle height is given relative to topography
1350                                  kp = kp + k_surf
1351                                  tmp_particle%z = tmp_particle%z + zw(k_surf)
1352!--                               Skip particle release if particle position is
1353!--                               above model top, or within topography in case
1354!--                               of overhanging structures.
1355                                  IF ( kp > nzt  .OR.                          &
1356                                 .NOT. BTEST( wall_flags_0(kp,jp,ip), 0 ) )  THEN
1357                                     pos_x = pos_x + pdx(i)
1358                                     CYCLE xloop
1359                                  ENDIF
1360!
1361!--                            Skip particle release if particle position is
1362!--                            below surface, or within topography in case
1363!--                            of overhanging structures.
1364                               ELSEIF ( .NOT. seed_follows_topography .AND.    &
1365                                         tmp_particle%z <= zw(k_surf)  .OR.    &
1366                                        .NOT. BTEST( wall_flags_0(kp,jp,ip), 0 ) )&
1367                               THEN
1368                                  pos_x = pos_x + pdx(i)
1369                                  CYCLE xloop
1370                               ENDIF
1371
1372                               local_count(kp,jp,ip) = local_count(kp,jp,ip) + 1
1373
1374                               IF ( .NOT. first_stride )  THEN
1375                                  IF ( ip < nxl  .OR.  jp < nys  .OR.  kp < nzb+1 )  THEN
1376                                     write(6,*) 'xl ',ip,jp,kp,nxl,nys,nzb+1
1377                                  ENDIF
1378                                  IF ( ip > nxr  .OR.  jp > nyn  .OR.  kp > nzt )  THEN
1379                                     write(6,*) 'xu ',ip,jp,kp,nxr,nyn,nzt
1380                                  ENDIF
1381                                  grid_particles(kp,jp,ip)%particles(local_count(kp,jp,ip)) = tmp_particle
1382                               ENDIF
1383                            ENDDO
1384                         ENDIF
1385                         pos_x = pos_x + pdx(i)
1386                      ENDDO xloop
1387                   ENDIF
1388                   pos_y = pos_y + pdy(i)
1389                ENDDO
1390             ENDIF
1391
1392             pos_z = pos_z + pdz(i)
1393          ENDDO
1394       ENDDO
1395
1396       IF ( first_stride )  THEN
1397          DO  ip = nxl, nxr
1398             DO  jp = nys, nyn
1399                DO  kp = nzb+1, nzt
1400                   IF ( phase == PHASE_INIT )  THEN
1401                      IF ( local_count(kp,jp,ip) > 0 )  THEN
1402                         alloc_size = MAX( INT( local_count(kp,jp,ip) *        &
1403                            ( 1.0_wp + alloc_factor / 100.0_wp ) ),            &
1404                            1 )
1405                      ELSE
1406                         alloc_size = 1
1407                      ENDIF
1408                      ALLOCATE(grid_particles(kp,jp,ip)%particles(1:alloc_size))
1409                      DO  n = 1, alloc_size
1410                         grid_particles(kp,jp,ip)%particles(n) = zero_particle
1411                      ENDDO
1412                   ELSEIF ( phase == PHASE_RELEASE )  THEN
1413                      IF ( local_count(kp,jp,ip) > 0 )  THEN
1414                         new_size   = local_count(kp,jp,ip) + prt_count(kp,jp,ip)
1415                         alloc_size = MAX( INT( new_size * ( 1.0_wp +          &
1416                            alloc_factor / 100.0_wp ) ), 1 )
1417                         IF( alloc_size > SIZE( grid_particles(kp,jp,ip)%particles) )  THEN
1418                            CALL realloc_particles_array(ip,jp,kp,alloc_size)
1419                         ENDIF
1420                      ENDIF
1421                   ENDIF
1422                ENDDO
1423             ENDDO
1424          ENDDO
1425       ENDIF
1426
1427    ENDDO
1428
1429    local_start = prt_count+1
1430    prt_count   = local_count
1431!
1432!-- Calculate particle IDs
1433    DO  ip = nxl, nxr
1434       DO  jp = nys, nyn
1435          DO  kp = nzb+1, nzt
1436             number_of_particles = prt_count(kp,jp,ip)
1437             IF ( number_of_particles <= 0 )  CYCLE
1438             particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
1439
1440             DO  n = local_start(kp,jp,ip), number_of_particles  !only new particles
1441
1442                particles(n)%id = 10000_idp**3 * grid_particles(kp,jp,ip)%id_counter + &
1443                                  10000_idp**2 * kp + 10000_idp * jp + ip
1444!
1445!--             Count the number of particles that have been released before
1446                grid_particles(kp,jp,ip)%id_counter =                          &
1447                                         grid_particles(kp,jp,ip)%id_counter + 1
1448
1449             ENDDO
1450
1451          ENDDO
1452       ENDDO
1453    ENDDO
1454!
1455!-- Initialize aerosol background spectrum
1456    IF ( curvature_solution_effects )  THEN
1457       CALL lpm_init_aerosols(local_start)
1458    ENDIF
1459!
1460!-- Add random fluctuation to particle positions.
1461    IF ( random_start_position )  THEN
1462       DO  ip = nxl, nxr
1463          DO  jp = nys, nyn
1464             DO  kp = nzb+1, nzt
1465                number_of_particles = prt_count(kp,jp,ip)
1466                IF ( number_of_particles <= 0 )  CYCLE
1467                particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
1468!
1469!--             Move only new particles. Moreover, limit random fluctuation
1470!--             in order to prevent that particles move more than one grid box,
1471!--             which would lead to problems concerning particle exchange
1472!--             between processors in case pdx/pdy are larger than dx/dy,
1473!--             respectively.
1474                DO  n = local_start(kp,jp,ip), number_of_particles
1475                   IF ( psl(particles(n)%group) /= psr(particles(n)%group) )  THEN
1476                      rand_contr = ( random_function( iran_part ) - 0.5_wp ) * &
1477                                     pdx(particles(n)%group)
1478                      particles(n)%x = particles(n)%x +                        &
1479                              MERGE( rand_contr, SIGN( dx, rand_contr ),       &
1480                                     ABS( rand_contr ) < dx                    &
1481                                   )
1482                   ENDIF
1483                   IF ( pss(particles(n)%group) /= psn(particles(n)%group) )  THEN
1484                      rand_contr = ( random_function( iran_part ) - 0.5_wp ) * &
1485                                     pdy(particles(n)%group)
1486                      particles(n)%y = particles(n)%y +                        &
1487                              MERGE( rand_contr, SIGN( dy, rand_contr ),       &
1488                                     ABS( rand_contr ) < dy                    &
1489                                   )
1490                   ENDIF
1491                   IF ( psb(particles(n)%group) /= pst(particles(n)%group) )  THEN
1492                      rand_contr = ( random_function( iran_part ) - 0.5_wp ) * &
1493                                     pdz(particles(n)%group)
1494                      particles(n)%z = particles(n)%z +                        &
1495                              MERGE( rand_contr, SIGN( dzw(kp), rand_contr ),  &
1496                                     ABS( rand_contr ) < dzw(kp)               &
1497                                   )
1498                   ENDIF
1499                ENDDO
1500!
1501!--             Identify particles located outside the model domain and reflect
1502!--             or absorb them if necessary.
1503                CALL lpm_boundary_conds( 'bottom/top', i, j, k )
1504!
1505!--             Furthermore, remove particles located in topography. Note, as
1506!--             the particle speed is still zero at this point, wall
1507!--             reflection boundary conditions will not work in this case.
1508                particles =>                                                   &
1509                       grid_particles(kp,jp,ip)%particles(1:number_of_particles)
1510                DO  n = local_start(kp,jp,ip), number_of_particles
1511                   i = particles(n)%x * ddx
1512                   j = particles(n)%y * ddy
1513                   k = particles(n)%z / dz(1) + 1 + offset_ocean_nzt
1514                   DO WHILE( zw(k) < particles(n)%z )
1515                      k = k + 1
1516                   ENDDO
1517                   DO WHILE( zw(k-1) > particles(n)%z )
1518                      k = k - 1
1519                   ENDDO
1520!
1521!--                Check if particle is within topography
1522                   IF ( .NOT. BTEST( wall_flags_0(k,j,i), 0 ) )  THEN
1523                      particles(n)%particle_mask = .FALSE.
1524                      deleted_particles = deleted_particles + 1
1525                   ENDIF
1526
1527                ENDDO
1528             ENDDO
1529          ENDDO
1530       ENDDO
1531!
1532!--    Exchange particles between grid cells and processors
1533       CALL lpm_move_particle
1534       CALL lpm_exchange_horiz
1535
1536    ENDIF
1537!
1538!-- In case of random_start_position, delete particles identified by
1539!-- lpm_exchange_horiz and lpm_boundary_conds. Then sort particles into blocks,
1540!-- which is needed for a fast interpolation of the LES fields on the particle
1541!-- position.
1542    CALL lpm_sort_in_subboxes
1543!
1544!-- Determine the current number of particles
1545    DO  ip = nxl, nxr
1546       DO  jp = nys, nyn
1547          DO  kp = nzb+1, nzt
1548             number_of_particles         = number_of_particles                 &
1549                                           + prt_count(kp,jp,ip)
1550          ENDDO
1551       ENDDO
1552    ENDDO
1553!
1554!-- Calculate the number of particles of the total domain
1555#if defined( __parallel )
1556    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1557    CALL MPI_ALLREDUCE( number_of_particles, total_number_of_particles, 1, &
1558    MPI_INTEGER, MPI_SUM, comm2d, ierr )
1559#else
1560    total_number_of_particles = number_of_particles
1561#endif
1562
1563    RETURN
1564
1565 END SUBROUTINE lpm_create_particle
1566 
1567 
1568!------------------------------------------------------------------------------!
1569! Description:
1570! ------------
1571!> This routine initialize the particles as aerosols with physio-chemical
1572!> properties.
1573!------------------------------------------------------------------------------!   
1574 SUBROUTINE lpm_init_aerosols(local_start)
1575
1576    REAL(wp)  :: afactor            !< curvature effects
1577    REAL(wp)  :: bfactor            !< solute effects
1578    REAL(wp)  :: dlogr              !< logarithmic width of radius bin
1579    REAL(wp)  :: e_a                !< vapor pressure
1580    REAL(wp)  :: e_s                !< saturation vapor pressure
1581    REAL(wp)  :: rmin = 0.005e-6_wp !< minimum aerosol radius
1582    REAL(wp)  :: rmax = 10.0e-6_wp  !< maximum aerosol radius
1583    REAL(wp)  :: r_mid              !< mean radius of bin
1584    REAL(wp)  :: r_l                !< left radius of bin
1585    REAL(wp)  :: r_r                !< right radius of bin
1586    REAL(wp)  :: sigma              !< surface tension
1587    REAL(wp)  :: t_int              !< temperature
1588
1589    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg), INTENT(IN) ::  local_start !<
1590
1591    INTEGER(iwp)  :: n              !<
1592    INTEGER(iwp)  :: ip             !<
1593    INTEGER(iwp)  :: jp             !<
1594    INTEGER(iwp)  :: kp             !<
1595
1596!
1597!-- Set constants for different aerosol species
1598    IF ( TRIM(aero_species) .EQ. 'nacl' ) THEN
1599       molecular_weight_of_solute = 0.05844_wp 
1600       rho_s                      = 2165.0_wp
1601       vanthoff                   = 2.0_wp
1602    ELSEIF ( TRIM(aero_species) .EQ. 'c3h4o4' ) THEN
1603       molecular_weight_of_solute = 0.10406_wp 
1604       rho_s                      = 1600.0_wp
1605       vanthoff                   = 1.37_wp
1606    ELSEIF ( TRIM(aero_species) .EQ. 'nh4o3' ) THEN
1607       molecular_weight_of_solute = 0.08004_wp 
1608       rho_s                      = 1720.0_wp
1609       vanthoff                   = 2.31_wp
1610    ELSE
1611       WRITE( message_string, * ) 'unknown aerosol species ',   &
1612                                'aero_species = "', TRIM( aero_species ), '"'
1613       CALL message( 'lpm_init', 'PA0470', 1, 2, 0, 6, 0 )
1614    ENDIF
1615!
1616!-- The following typical aerosol spectra are taken from Jaenicke (1993):
1617!-- Tropospheric aerosols. Published in Aerosol-Cloud-Climate Interactions.
1618    IF ( TRIM(aero_type) .EQ. 'polar' )  THEN
1619       na        = (/ 2.17e1, 1.86e-1, 3.04e-4 /) * 1.0E6
1620       rm        = (/ 0.0689, 0.375, 4.29 /) * 1.0E-6
1621       log_sigma = (/ 0.245, 0.300, 0.291 /)
1622    ELSEIF ( TRIM(aero_type) .EQ. 'background' )  THEN
1623       na        = (/ 1.29e2, 5.97e1, 6.35e1 /) * 1.0E6
1624       rm        = (/ 0.0036, 0.127, 0.259 /) * 1.0E-6
1625       log_sigma = (/ 0.645, 0.253, 0.425 /)
1626    ELSEIF ( TRIM(aero_type) .EQ. 'maritime' )  THEN
1627       na        = (/ 1.33e2, 6.66e1, 3.06e0 /) * 1.0E6
1628       rm        = (/ 0.0039, 0.133, 0.29 /) * 1.0E-6
1629       log_sigma = (/ 0.657, 0.210, 0.396 /)
1630    ELSEIF ( TRIM(aero_type) .EQ. 'continental' )  THEN
1631       na        = (/ 3.20e3, 2.90e3, 3.00e-1 /) * 1.0E6
1632       rm        = (/ 0.01, 0.058, 0.9 /) * 1.0E-6
1633       log_sigma = (/ 0.161, 0.217, 0.380 /)
1634    ELSEIF ( TRIM(aero_type) .EQ. 'desert' )  THEN
1635       na        = (/ 7.26e2, 1.14e3, 1.78e-1 /) * 1.0E6
1636       rm        = (/ 0.001, 0.0188, 10.8 /) * 1.0E-6
1637       log_sigma = (/ 0.247, 0.770, 0.438 /)
1638    ELSEIF ( TRIM(aero_type) .EQ. 'rural' )  THEN
1639       na        = (/ 6.65e3, 1.47e2, 1.99e3 /) * 1.0E6
1640       rm        = (/ 0.00739, 0.0269, 0.0419 /) * 1.0E-6
1641       log_sigma = (/ 0.225, 0.557, 0.266 /)
1642    ELSEIF ( TRIM(aero_type) .EQ. 'urban' )  THEN
1643       na        = (/ 9.93e4, 1.11e3, 3.64e4 /) * 1.0E6
1644       rm        = (/ 0.00651, 0.00714, 0.0248 /) * 1.0E-6
1645       log_sigma = (/ 0.245, 0.666, 0.337 /)
1646    ELSEIF ( TRIM(aero_type) .EQ. 'user' )  THEN
1647       CONTINUE
1648    ELSE
1649       WRITE( message_string, * ) 'unknown aerosol type ',   &
1650                                'aero_type = "', TRIM( aero_type ), '"'
1651       CALL message( 'lpm_init', 'PA0459', 1, 2, 0, 6, 0 )
1652    ENDIF
1653
1654    DO  ip = nxl, nxr
1655       DO  jp = nys, nyn
1656          DO  kp = nzb+1, nzt
1657
1658             number_of_particles = prt_count(kp,jp,ip)
1659             IF ( number_of_particles <= 0 )  CYCLE
1660             particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
1661
1662             dlogr   = ( LOG10(rmax) - LOG10(rmin) ) / ( number_of_particles - local_start(kp,jp,ip) + 1 )
1663!
1664!--          Initialize the aerosols with a predefined spectral distribution
1665!--          of the dry radius (logarithmically increasing bins) and a varying
1666!--          weighting factor
1667             DO  n = local_start(kp,jp,ip), number_of_particles  !only new particles
1668
1669                r_l   = 10.0**( LOG10( rmin ) + (n-1) * dlogr )
1670                r_r   = 10.0**( LOG10( rmin ) + n * dlogr )
1671                r_mid = SQRT( r_l * r_r )
1672
1673                particles(n)%aux1          = r_mid
1674                particles(n)%weight_factor =                                           &
1675                   ( na(1) / ( SQRT( 2.0 * pi ) * log_sigma(1) ) *                     &
1676                     EXP( - LOG10( r_mid / rm(1) )**2 / ( 2.0 * log_sigma(1)**2 ) ) +  &
1677                     na(2) / ( SQRT( 2.0 * pi ) * log_sigma(2) ) *                     &
1678                     EXP( - LOG10( r_mid / rm(2) )**2 / ( 2.0 * log_sigma(2)**2 ) ) +  &
1679                     na(3) / ( SQRT( 2.0 * pi ) * log_sigma(3) ) *                     &
1680                     EXP( - LOG10( r_mid / rm(3) )**2 / ( 2.0 * log_sigma(3)**2 ) )    &
1681                   ) * ( LOG10(r_r) - LOG10(r_l) ) * ( dx * dy * dzw(kp) )
1682
1683!
1684!--             Multiply weight_factor with the namelist parameter aero_weight
1685!--             to increase or decrease the number of simulated aerosols
1686                particles(n)%weight_factor = particles(n)%weight_factor * aero_weight
1687
1688                IF ( particles(n)%weight_factor - FLOOR(particles(n)%weight_factor,KIND=wp) &
1689                     .GT. random_function( iran_part ) )  THEN
1690                   particles(n)%weight_factor = FLOOR(particles(n)%weight_factor,KIND=wp) + 1.0_wp
1691                ELSE
1692                   particles(n)%weight_factor = FLOOR(particles(n)%weight_factor,KIND=wp)
1693                ENDIF
1694!
1695!--             Unnecessary particles will be deleted
1696                IF ( particles(n)%weight_factor .LE. 0.0 )  particles(n)%particle_mask = .FALSE.
1697
1698             ENDDO
1699!
1700!--          Set particle radius to equilibrium radius based on the environmental
1701!--          supersaturation (Khvorostyanov and Curry, 2007, JGR). This avoids
1702!--          the sometimes lengthy growth toward their equilibrium radius within
1703!--          the simulation.
1704             t_int  = pt(kp,jp,ip) * exner(kp)
1705
1706             e_s = magnus( t_int )
1707             e_a = q(kp,jp,ip) * hyp(kp) / ( q(kp,jp,ip) + rd_d_rv )
1708
1709             sigma   = 0.0761_wp - 0.000155_wp * ( t_int - 273.15_wp )
1710             afactor = 2.0_wp * sigma / ( rho_l * r_v * t_int )
1711
1712             bfactor = vanthoff * molecular_weight_of_water *    &
1713                       rho_s / ( molecular_weight_of_solute * rho_l )
1714!
1715!--          The formula is only valid for subsaturated environments. For
1716!--          supersaturations higher than -5 %, the supersaturation is set to -5%.
1717             IF ( e_a / e_s >= 0.95_wp )  e_a = 0.95_wp * e_s
1718
1719             DO  n = local_start(kp,jp,ip), number_of_particles  !only new particles
1720!
1721!--             For details on this equation, see Eq. (14) of Khvorostyanov and
1722!--             Curry (2007, JGR)
1723                particles(n)%radius = bfactor**0.3333333_wp *                  &
1724                   particles(n)%aux1 / ( 1.0_wp - e_a / e_s )**0.3333333_wp / &
1725                   ( 1.0_wp + ( afactor / ( 3.0_wp * bfactor**0.3333333_wp *   &
1726                     particles(n)%aux1 ) ) /                                  &
1727                     ( 1.0_wp - e_a / e_s )**0.6666666_wp                      &
1728                   )
1729
1730             ENDDO
1731
1732          ENDDO
1733       ENDDO
1734    ENDDO
1735
1736 END SUBROUTINE lpm_init_aerosols
1737 
1738 
1739!------------------------------------------------------------------------------!
1740! Description:
1741! ------------
1742!> Calculates quantities required for considering the SGS velocity fluctuations
1743!> in the particle transport by a stochastic approach. The respective
1744!> quantities are: SGS-TKE gradients and horizontally averaged profiles of the
1745!> SGS TKE and the resolved-scale velocity variances.
1746!------------------------------------------------------------------------------!
1747 SUBROUTINE lpm_init_sgs_tke
1748   
1749    USE statistics,                                                            &
1750        ONLY:  flow_statistics_called, hom, sums, sums_l
1751
1752    INTEGER(iwp) ::  i      !< index variable along x
1753    INTEGER(iwp) ::  j      !< index variable along y
1754    INTEGER(iwp) ::  k      !< index variable along z
1755    INTEGER(iwp) ::  m      !< running index for the surface elements
1756
1757    REAL(wp) ::  flag1      !< flag to mask topography
1758
1759!
1760!-- TKE gradient along x and y
1761    DO  i = nxl, nxr
1762       DO  j = nys, nyn
1763          DO  k = nzb, nzt+1
1764
1765             IF ( .NOT. BTEST( wall_flags_0(k,j,i-1), 0 )  .AND.               &
1766                        BTEST( wall_flags_0(k,j,i), 0   )  .AND.               &
1767                        BTEST( wall_flags_0(k,j,i+1), 0 ) )                    &
1768             THEN
1769                de_dx(k,j,i) = 2.0_wp * sgs_wf_part *                          &
1770                               ( e(k,j,i+1) - e(k,j,i) ) * ddx
1771             ELSEIF ( BTEST( wall_flags_0(k,j,i-1), 0 )  .AND.                 &
1772                      BTEST( wall_flags_0(k,j,i), 0   )  .AND.                 &
1773                .NOT. BTEST( wall_flags_0(k,j,i+1), 0 ) )                      &
1774             THEN
1775                de_dx(k,j,i) = 2.0_wp * sgs_wf_part *                          &
1776                               ( e(k,j,i) - e(k,j,i-1) ) * ddx
1777             ELSEIF ( .NOT. BTEST( wall_flags_0(k,j,i), 22   )  .AND.          &
1778                      .NOT. BTEST( wall_flags_0(k,j,i+1), 22 ) )               &   
1779             THEN
1780                de_dx(k,j,i) = 0.0_wp
1781             ELSEIF ( .NOT. BTEST( wall_flags_0(k,j,i-1), 22 )  .AND.          &
1782                      .NOT. BTEST( wall_flags_0(k,j,i), 22   ) )               &
1783             THEN
1784                de_dx(k,j,i) = 0.0_wp
1785             ELSE
1786                de_dx(k,j,i) = sgs_wf_part * ( e(k,j,i+1) - e(k,j,i-1) ) * ddx
1787             ENDIF
1788
1789             IF ( .NOT. BTEST( wall_flags_0(k,j-1,i), 0 )  .AND.               &
1790                        BTEST( wall_flags_0(k,j,i), 0   )  .AND.               &
1791                        BTEST( wall_flags_0(k,j+1,i), 0 ) )                    &
1792             THEN
1793                de_dy(k,j,i) = 2.0_wp * sgs_wf_part *                          &
1794                               ( e(k,j+1,i) - e(k,j,i) ) * ddy
1795             ELSEIF ( BTEST( wall_flags_0(k,j-1,i), 0 )  .AND.                 &
1796                      BTEST( wall_flags_0(k,j,i), 0   )  .AND.                 &
1797                .NOT. BTEST( wall_flags_0(k,j+1,i), 0 ) )                      &
1798             THEN
1799                de_dy(k,j,i) = 2.0_wp * sgs_wf_part *                          &
1800                               ( e(k,j,i) - e(k,j-1,i) ) * ddy
1801             ELSEIF ( .NOT. BTEST( wall_flags_0(k,j,i), 22   )  .AND.          &
1802                      .NOT. BTEST( wall_flags_0(k,j+1,i), 22 ) )               &   
1803             THEN
1804                de_dy(k,j,i) = 0.0_wp
1805             ELSEIF ( .NOT. BTEST( wall_flags_0(k,j-1,i), 22 )  .AND.          &
1806                      .NOT. BTEST( wall_flags_0(k,j,i), 22   ) )               &
1807             THEN
1808                de_dy(k,j,i) = 0.0_wp
1809             ELSE
1810                de_dy(k,j,i) = sgs_wf_part * ( e(k,j+1,i) - e(k,j-1,i) ) * ddy
1811             ENDIF
1812
1813          ENDDO
1814       ENDDO
1815    ENDDO
1816
1817!
1818!-- TKE gradient along z at topograhy and  including bottom and top boundary conditions
1819    DO  i = nxl, nxr
1820       DO  j = nys, nyn
1821          DO  k = nzb+1, nzt-1
1822!
1823!--          Flag to mask topography
1824             flag1 = MERGE( 1.0_wp, 0.0_wp, BTEST( wall_flags_0(k,j,i), 0  ) )
1825
1826             de_dz(k,j,i) = 2.0_wp * sgs_wf_part *                             &
1827                           ( e(k+1,j,i) - e(k-1,j,i) ) / ( zu(k+1) - zu(k-1) ) &
1828                                                 * flag1
1829          ENDDO
1830!
1831!--       upward-facing surfaces
1832          DO  m = bc_h(0)%start_index(j,i), bc_h(0)%end_index(j,i)
1833             k            = bc_h(0)%k(m)
1834             de_dz(k,j,i) = 2.0_wp * sgs_wf_part *                             &
1835                           ( e(k+1,j,i) - e(k,j,i)   ) / ( zu(k+1) - zu(k) )
1836          ENDDO
1837!
1838!--       downward-facing surfaces
1839          DO  m = bc_h(1)%start_index(j,i), bc_h(1)%end_index(j,i)
1840             k            = bc_h(1)%k(m)
1841             de_dz(k,j,i) = 2.0_wp * sgs_wf_part *                             &
1842                           ( e(k,j,i) - e(k-1,j,i)   ) / ( zu(k) - zu(k-1) )
1843          ENDDO
1844
1845          de_dz(nzb,j,i)   = 0.0_wp
1846          de_dz(nzt,j,i)   = 0.0_wp
1847          de_dz(nzt+1,j,i) = 0.0_wp
1848       ENDDO
1849    ENDDO
1850!
1851!-- Ghost point exchange
1852    CALL exchange_horiz( de_dx, nbgp )
1853    CALL exchange_horiz( de_dy, nbgp )
1854    CALL exchange_horiz( de_dz, nbgp )
1855    CALL exchange_horiz( diss, nbgp  )
1856!
1857!-- Set boundary conditions at non-periodic boundaries. Note, at non-period
1858!-- boundaries zero-gradient boundary conditions are set for the subgrid TKE.
1859!-- Thus, TKE gradients normal to the respective lateral boundaries are zero,
1860!-- while tangetial TKE gradients then must be the same as within the prognostic
1861!-- domain. 
1862    IF ( bc_dirichlet_l )  THEN
1863       de_dx(:,:,-1) = 0.0_wp
1864       de_dy(:,:,-1) = de_dy(:,:,0) 
1865       de_dz(:,:,-1) = de_dz(:,:,0)
1866    ENDIF
1867    IF ( bc_dirichlet_r )  THEN
1868       de_dx(:,:,nxr+1) = 0.0_wp
1869       de_dy(:,:,nxr+1) = de_dy(:,:,nxr) 
1870       de_dz(:,:,nxr+1) = de_dz(:,:,nxr)
1871    ENDIF
1872    IF ( bc_dirichlet_n )  THEN
1873       de_dx(:,nyn+1,:) = de_dx(:,nyn,:)
1874       de_dy(:,nyn+1,:) = 0.0_wp 
1875       de_dz(:,nyn+1,:) = de_dz(:,nyn,:)
1876    ENDIF
1877    IF ( bc_dirichlet_s )  THEN
1878       de_dx(:,nys-1,:) = de_dx(:,nys,:)
1879       de_dy(:,nys-1,:) = 0.0_wp 
1880       de_dz(:,nys-1,:) = de_dz(:,nys,:)
1881    ENDIF 
1882!
1883!-- Calculate the horizontally averaged profiles of SGS TKE and resolved
1884!-- velocity variances (they may have been already calculated in routine
1885!-- flow_statistics).
1886    IF ( .NOT. flow_statistics_called )  THEN
1887
1888!
1889!--    First calculate horizontally averaged profiles of the horizontal
1890!--    velocities.
1891       sums_l(:,1,0) = 0.0_wp
1892       sums_l(:,2,0) = 0.0_wp
1893
1894       DO  i = nxl, nxr
1895          DO  j =  nys, nyn
1896             DO  k = nzb, nzt+1
1897!
1898!--             Flag indicating vicinity of wall
1899                flag1 = MERGE( 1.0_wp, 0.0_wp, BTEST( wall_flags_0(k,j,i), 24 ) )
1900
1901                sums_l(k,1,0)  = sums_l(k,1,0)  + u(k,j,i) * flag1
1902                sums_l(k,2,0)  = sums_l(k,2,0)  + v(k,j,i) * flag1
1903             ENDDO
1904          ENDDO
1905       ENDDO
1906
1907#if defined( __parallel )
1908!
1909!--    Compute total sum from local sums
1910       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1911       CALL MPI_ALLREDUCE( sums_l(nzb,1,0), sums(nzb,1), nzt+2-nzb, &
1912                           MPI_REAL, MPI_SUM, comm2d, ierr )
1913       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1914       CALL MPI_ALLREDUCE( sums_l(nzb,2,0), sums(nzb,2), nzt+2-nzb, &
1915                              MPI_REAL, MPI_SUM, comm2d, ierr )
1916#else
1917       sums(:,1) = sums_l(:,1,0)
1918       sums(:,2) = sums_l(:,2,0)
1919#endif
1920
1921!
1922!--    Final values are obtained by division by the total number of grid
1923!--    points used for the summation.
1924       hom(:,1,1,0) = sums(:,1) / ngp_2dh_outer(:,0)   ! u
1925       hom(:,1,2,0) = sums(:,2) / ngp_2dh_outer(:,0)   ! v
1926
1927!
1928!--    Now calculate the profiles of SGS TKE and the resolved-scale
1929!--    velocity variances
1930       sums_l(:,8,0)  = 0.0_wp
1931       sums_l(:,30,0) = 0.0_wp
1932       sums_l(:,31,0) = 0.0_wp
1933       sums_l(:,32,0) = 0.0_wp
1934       DO  i = nxl, nxr
1935          DO  j = nys, nyn
1936             DO  k = nzb, nzt+1
1937!
1938!--             Flag indicating vicinity of wall
1939                flag1 = MERGE( 1.0_wp, 0.0_wp, BTEST( wall_flags_0(k,j,i), 24 ) )
1940
1941                sums_l(k,8,0)  = sums_l(k,8,0)  + e(k,j,i)                       * flag1
1942                sums_l(k,30,0) = sums_l(k,30,0) + ( u(k,j,i) - hom(k,1,1,0) )**2 * flag1
1943                sums_l(k,31,0) = sums_l(k,31,0) + ( v(k,j,i) - hom(k,1,2,0) )**2 * flag1
1944                sums_l(k,32,0) = sums_l(k,32,0) + w(k,j,i)**2                    * flag1
1945             ENDDO
1946          ENDDO
1947       ENDDO
1948
1949#if defined( __parallel )
1950!
1951!--    Compute total sum from local sums
1952       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1953       CALL MPI_ALLREDUCE( sums_l(nzb,8,0), sums(nzb,8), nzt+2-nzb, &
1954                           MPI_REAL, MPI_SUM, comm2d, ierr )
1955       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1956       CALL MPI_ALLREDUCE( sums_l(nzb,30,0), sums(nzb,30), nzt+2-nzb, &
1957                           MPI_REAL, MPI_SUM, comm2d, ierr )
1958       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1959       CALL MPI_ALLREDUCE( sums_l(nzb,31,0), sums(nzb,31), nzt+2-nzb, &
1960                           MPI_REAL, MPI_SUM, comm2d, ierr )
1961       IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
1962       CALL MPI_ALLREDUCE( sums_l(nzb,32,0), sums(nzb,32), nzt+2-nzb, &
1963                           MPI_REAL, MPI_SUM, comm2d, ierr )
1964
1965#else
1966       sums(:,8)  = sums_l(:,8,0)
1967       sums(:,30) = sums_l(:,30,0)
1968       sums(:,31) = sums_l(:,31,0)
1969       sums(:,32) = sums_l(:,32,0)
1970#endif
1971
1972!
1973!--    Final values are obtained by division by the total number of grid
1974!--    points used for the summation.
1975       hom(:,1,8,0)  = sums(:,8)  / ngp_2dh_outer(:,0)   ! e
1976       hom(:,1,30,0) = sums(:,30) / ngp_2dh_outer(:,0)   ! u*2
1977       hom(:,1,31,0) = sums(:,31) / ngp_2dh_outer(:,0)   ! v*2
1978       hom(:,1,32,0) = sums(:,32) / ngp_2dh_outer(:,0)   ! w*2
1979
1980    ENDIF
1981
1982 END SUBROUTINE lpm_init_sgs_tke
1983 
1984 
1985!------------------------------------------------------------------------------!
1986! Description:
1987! ------------
1988!> Sobroutine control lpm actions, i.e. all actions during one time step.
1989!------------------------------------------------------------------------------! 
1990 SUBROUTINE lpm_actions( location )
1991
1992    CHARACTER (LEN=*), INTENT(IN) ::  location !< call location string
1993
1994    INTEGER(iwp)       ::  i                  !<
1995    INTEGER(iwp)       ::  ie                 !<
1996    INTEGER(iwp)       ::  is                 !<
1997    INTEGER(iwp)       ::  j                  !<
1998    INTEGER(iwp)       ::  je                 !<
1999    INTEGER(iwp)       ::  js                 !<
2000    INTEGER(iwp), SAVE ::  lpm_count = 0      !<
2001    INTEGER(iwp)       ::  k                  !<
2002    INTEGER(iwp)       ::  ke                 !<
2003    INTEGER(iwp)       ::  ks                 !<
2004    INTEGER(iwp)       ::  m                  !<
2005    INTEGER(iwp), SAVE ::  steps = 0          !<
2006
2007    LOGICAL            ::  first_loop_stride  !<
2008
2009   
2010    SELECT CASE ( location )
2011
2012       CASE ( 'after_prognostic_equations' )
2013
2014          CALL cpu_log( log_point(25), 'lpm', 'start' )
2015!
2016!--       Write particle data at current time on file.
2017!--       This has to be done here, before particles are further processed,
2018!--       because they may be deleted within this timestep (in case that
2019!--       dt_write_particle_data = dt_prel = particle_maximum_age).
2020          time_write_particle_data = time_write_particle_data + dt_3d
2021          IF ( time_write_particle_data >= dt_write_particle_data )  THEN
2022
2023             CALL lpm_data_output_particles
2024!
2025!--       The MOD function allows for changes in the output interval with restart
2026!--       runs.
2027             time_write_particle_data = MOD( time_write_particle_data, &
2028                                        MAX( dt_write_particle_data, dt_3d ) )
2029          ENDIF
2030
2031!
2032!--       Initialize arrays for marking those particles to be deleted after the
2033!--       (sub-) timestep
2034          deleted_particles = 0
2035
2036!
2037!--       Initialize variables used for accumulating the number of particles
2038!--       xchanged between the subdomains during all sub-timesteps (if sgs
2039!--       velocities are included). These data are output further below on the
2040!--       particle statistics file.
2041          trlp_count_sum      = 0
2042          trlp_count_recv_sum = 0
2043          trrp_count_sum      = 0
2044          trrp_count_recv_sum = 0
2045          trsp_count_sum      = 0
2046          trsp_count_recv_sum = 0
2047          trnp_count_sum      = 0
2048          trnp_count_recv_sum = 0
2049!
2050!--       Calculate exponential term used in case of particle inertia for each
2051!--       of the particle groups
2052          DO  m = 1, number_of_particle_groups
2053             IF ( particle_groups(m)%density_ratio /= 0.0_wp )  THEN
2054                particle_groups(m)%exp_arg  =                                        &
2055                          4.5_wp * particle_groups(m)%density_ratio *                &
2056                          molecular_viscosity / ( particle_groups(m)%radius )**2
2057
2058                particle_groups(m)%exp_term = EXP( -particle_groups(m)%exp_arg *     &
2059                          dt_3d )
2060             ENDIF
2061          ENDDO
2062!
2063!--       If necessary, release new set of particles
2064          IF ( ( simulated_time - last_particle_release_time ) >= dt_prel  .AND. end_time_prel > simulated_time ) &
2065          THEN
2066             DO WHILE ( ( simulated_time - last_particle_release_time ) >= dt_prel )
2067                CALL lpm_create_particle( PHASE_RELEASE )
2068                last_particle_release_time = last_particle_release_time + dt_prel
2069             ENDDO
2070          ENDIF
2071!
2072!--       Reset summation arrays
2073          IF ( cloud_droplets )  THEN
2074             ql_c  = 0.0_wp
2075             ql_v  = 0.0_wp
2076             ql_vp = 0.0_wp
2077          ENDIF
2078
2079          first_loop_stride = .TRUE.
2080          grid_particles(:,:,:)%time_loop_done = .TRUE.
2081!
2082!--       Timestep loop for particle advection.
2083!--       This loop has to be repeated until the advection time of every particle
2084!--       (within the total domain!) has reached the LES timestep (dt_3d).
2085!--       In case of including the SGS velocities, the particle timestep may be
2086!--       smaller than the LES timestep (because of the Lagrangian timescale
2087!--       restriction) and particles may require to undergo several particle
2088!--       timesteps, before the LES timestep is reached. Because the number of these
2089!--       particle timesteps to be carried out is unknown at first, these steps are
2090!--       carried out in the following infinite loop with exit condition.
2091          DO
2092             CALL cpu_log( log_point_s(44), 'lpm_advec', 'start' )
2093             CALL cpu_log( log_point_s(44), 'lpm_advec', 'pause' )
2094             
2095!
2096!--          If particle advection includes SGS velocity components, calculate the
2097!--          required SGS quantities (i.e. gradients of the TKE, as well as
2098!--          horizontally averaged profiles of the SGS TKE and the resolved-scale
2099!--          velocity variances)
2100             IF ( use_sgs_for_particles  .AND.  .NOT. cloud_droplets )  THEN
2101                CALL lpm_init_sgs_tke
2102             ENDIF
2103!
2104!--          In case SGS-particle speed is considered, particles may carry out
2105!--          several particle timesteps. In order to prevent unnecessary
2106!--          treatment of particles that already reached the final time level,
2107!--          particles are sorted into contiguous blocks of finished and
2108!--          not-finished particles, in addition to their already sorting
2109!--          according to their sub-boxes.
2110             IF ( .NOT. first_loop_stride  .AND.  use_sgs_for_particles )            &
2111                CALL lpm_sort_timeloop_done
2112
2113             DO  i = nxl, nxr
2114                DO  j = nys, nyn
2115                   DO  k = nzb+1, nzt
2116
2117                      number_of_particles = prt_count(k,j,i)
2118!
2119!--                   If grid cell gets empty, flag must be true
2120                      IF ( number_of_particles <= 0 )  THEN
2121                         grid_particles(k,j,i)%time_loop_done = .TRUE.
2122                         CYCLE
2123                      ENDIF
2124
2125                      IF ( .NOT. first_loop_stride  .AND.  &
2126                           grid_particles(k,j,i)%time_loop_done ) CYCLE
2127
2128                      particles => grid_particles(k,j,i)%particles(1:number_of_particles)
2129
2130                      particles(1:number_of_particles)%particle_mask = .TRUE.
2131!
2132!--                   Initialize the variable storing the total time that a particle
2133!--                   has advanced within the timestep procedure
2134                      IF ( first_loop_stride )  THEN
2135                         particles(1:number_of_particles)%dt_sum = 0.0_wp
2136                      ENDIF
2137!
2138!--                   Particle (droplet) growth by condensation/evaporation and
2139!--                   collision
2140                      IF ( cloud_droplets  .AND.  first_loop_stride)  THEN
2141!
2142!--                      Droplet growth by condensation / evaporation
2143                         CALL lpm_droplet_condensation(i,j,k)
2144!
2145!--                      Particle growth by collision
2146                         IF ( collision_kernel /= 'none' )  THEN
2147                            CALL lpm_droplet_collision(i,j,k)
2148                         ENDIF
2149
2150                      ENDIF
2151!
2152!--                   Initialize the switch used for the loop exit condition checked
2153!--                   at the end of this loop. If at least one particle has failed to
2154!--                   reach the LES timestep, this switch will be set false in
2155!--                   lpm_advec.
2156                      dt_3d_reached_l = .TRUE.
2157
2158!
2159!--                   Particle advection
2160                      CALL lpm_advec(i,j,k)
2161!
2162!--                   Particle reflection from walls. Only applied if the particles
2163!--                   are in the vertical range of the topography. (Here, some
2164!--                   optimization is still possible.)
2165                      IF ( topography /= 'flat' .AND. k < nzb_max + 2 )  THEN
2166                         CALL  lpm_boundary_conds( 'walls', i, j, k )
2167                      ENDIF
2168!
2169!--                   User-defined actions after the calculation of the new particle
2170!--                   position
2171                      CALL user_lpm_advec(i,j,k)
2172!
2173!--                   Apply boundary conditions to those particles that have crossed
2174!--                   the top or bottom boundary and delete those particles, which are
2175!--                   older than allowed
2176                      CALL lpm_boundary_conds( 'bottom/top', i, j, k )
2177!
2178!---                  If not all particles of the actual grid cell have reached the
2179!--                   LES timestep, this cell has to do another loop iteration. Due to
2180!--                   the fact that particles can move into neighboring grid cells,
2181!--                   these neighbor cells also have to perform another loop iteration.
2182!--                   Please note, this realization does not work properly if
2183!--                   particles move into another subdomain.
2184                      IF ( .NOT. dt_3d_reached_l )  THEN
2185                         ks = MAX(nzb+1,k-1)
2186                         ke = MIN(nzt,k+1)
2187                         js = MAX(nys,j-1)
2188                         je = MIN(nyn,j+1)
2189                         is = MAX(nxl,i-1)
2190                         ie = MIN(nxr,i+1)
2191                         grid_particles(ks:ke,js:je,is:ie)%time_loop_done = .FALSE.
2192                      ELSE
2193                         grid_particles(k,j,i)%time_loop_done = .TRUE.
2194                      ENDIF
2195
2196                   ENDDO
2197                ENDDO
2198             ENDDO
2199
2200             steps = steps + 1
2201             dt_3d_reached_l = ALL(grid_particles(:,:,:)%time_loop_done)
2202!
2203!--          Find out, if all particles on every PE have completed the LES timestep
2204!--          and set the switch corespondingly
2205#if defined( __parallel )
2206             IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2207             CALL MPI_ALLREDUCE( dt_3d_reached_l, dt_3d_reached, 1, MPI_LOGICAL, &
2208                                 MPI_LAND, comm2d, ierr )
2209#else
2210             dt_3d_reached = dt_3d_reached_l
2211#endif
2212
2213             CALL cpu_log( log_point_s(44), 'lpm_advec', 'stop' )
2214
2215!
2216!--          Apply splitting and merging algorithm
2217             IF ( cloud_droplets )  THEN
2218                IF ( splitting ) THEN
2219                   CALL lpm_splitting
2220                ENDIF
2221                IF ( merging ) THEN
2222                   CALL lpm_merging
2223                ENDIF
2224             ENDIF
2225!
2226!--          Move Particles local to PE to a different grid cell
2227             CALL lpm_move_particle
2228!
2229!--          Horizontal boundary conditions including exchange between subdmains
2230             CALL lpm_exchange_horiz
2231
2232!
2233!--          IF .FALSE., lpm_sort_in_subboxes is done inside pcmp
2234             IF ( .NOT. dt_3d_reached .OR. .NOT. nested_run )   THEN   
2235!
2236!--             Pack particles (eliminate those marked for deletion),
2237!--             determine new number of particles
2238                CALL lpm_sort_in_subboxes
2239!
2240!--             Initialize variables for the next (sub-) timestep, i.e., for marking
2241!--             those particles to be deleted after the timestep
2242                deleted_particles = 0
2243             ENDIF
2244
2245             IF ( dt_3d_reached )  EXIT
2246
2247             first_loop_stride = .FALSE.
2248          ENDDO   ! timestep loop
2249!   
2250!--       in case of nested runs do the transfer of particles after every full model time step
2251          IF ( nested_run )   THEN
2252             CALL particles_from_parent_to_child
2253             CALL particles_from_child_to_parent
2254             CALL pmcp_p_delete_particles_in_fine_grid_area
2255
2256             CALL lpm_sort_in_subboxes
2257
2258             deleted_particles = 0
2259          ENDIF
2260
2261!
2262!--       Calculate the new liquid water content for each grid box
2263          IF ( cloud_droplets )  CALL lpm_calc_liquid_water_content
2264
2265!
2266!--       Deallocate unused memory
2267          IF ( deallocate_memory  .AND.  lpm_count == step_dealloc )  THEN
2268             CALL dealloc_particles_array
2269             lpm_count = 0
2270          ELSEIF ( deallocate_memory )  THEN
2271             lpm_count = lpm_count + 1
2272          ENDIF
2273
2274!
2275!--       Write particle statistics (in particular the number of particles
2276!--       exchanged between the subdomains) on file
2277          IF ( write_particle_statistics )  CALL lpm_write_exchange_statistics
2278
2279          CALL cpu_log( log_point(25), 'lpm', 'stop' )
2280         
2281! !
2282! !--       Output of particle time series
2283!           IF ( particle_advection )  THEN
2284!              IF ( time_dopts >= dt_dopts  .OR.                                                        &
2285!                   ( time_since_reference_point >= particle_advection_start  .AND.                     &
2286!                    first_call_lpm ) )  THEN
2287!                 CALL lpm_data_output_ptseries
2288!                 time_dopts = MOD( time_dopts, MAX( dt_dopts, dt_3d ) )
2289!              ENDIF
2290!           ENDIF
2291   
2292       CASE DEFAULT
2293          CONTINUE
2294
2295    END SELECT
2296
2297 END SUBROUTINE lpm_actions
2298 
2299 
2300!------------------------------------------------------------------------------!
2301! Description:
2302! ------------
2303!
2304!------------------------------------------------------------------------------!
2305 SUBROUTINE particles_from_parent_to_child
2306    IMPLICIT NONE
2307
2308    CALL pmcp_c_get_particle_from_parent                         ! Child actions
2309    CALL pmcp_p_fill_particle_win                                ! Parent actions
2310
2311    RETURN
2312 END SUBROUTINE particles_from_parent_to_child
2313
2314 
2315!------------------------------------------------------------------------------!
2316! Description:
2317! ------------
2318!
2319!------------------------------------------------------------------------------!
2320 SUBROUTINE particles_from_child_to_parent
2321    IMPLICIT NONE
2322
2323    CALL pmcp_c_send_particle_to_parent                         ! Child actions
2324    CALL pmcp_p_empty_particle_win                              ! Parent actions
2325
2326    RETURN
2327 END SUBROUTINE particles_from_child_to_parent
2328 
2329!------------------------------------------------------------------------------!
2330! Description:
2331! ------------
2332!> This routine write exchange statistics of the lpm in a ascii file.
2333!------------------------------------------------------------------------------!
2334 SUBROUTINE lpm_write_exchange_statistics
2335
2336    INTEGER(iwp) :: ip         !<
2337    INTEGER(iwp) :: jp         !<
2338    INTEGER(iwp) :: kp         !<
2339    INTEGER(iwp) :: tot_number_of_particles
2340
2341!
2342!-- Determine the current number of particles
2343    number_of_particles         = 0
2344    DO  ip = nxl, nxr
2345       DO  jp = nys, nyn
2346          DO  kp = nzb+1, nzt
2347             number_of_particles = number_of_particles                         &
2348                                     + prt_count(kp,jp,ip)
2349          ENDDO
2350       ENDDO
2351    ENDDO
2352
2353    CALL check_open( 80 )
2354#if defined( __parallel )
2355    WRITE ( 80, 8000 )  current_timestep_number+1, simulated_time+dt_3d, &
2356                        number_of_particles, pleft, trlp_count_sum,      &
2357                        trlp_count_recv_sum, pright, trrp_count_sum,     &
2358                        trrp_count_recv_sum, psouth, trsp_count_sum,     &
2359                        trsp_count_recv_sum, pnorth, trnp_count_sum,     &
2360                        trnp_count_recv_sum
2361#else
2362    WRITE ( 80, 8000 )  current_timestep_number+1, simulated_time+dt_3d, &
2363                        number_of_particles
2364#endif
2365    CALL close_file( 80 )
2366
2367    IF ( number_of_particles > 0 ) THEN
2368        WRITE(9,*) 'number_of_particles ', number_of_particles,                &
2369                    current_timestep_number + 1, simulated_time + dt_3d
2370    ENDIF
2371
2372#if defined( __parallel )
2373    CALL MPI_ALLREDUCE( number_of_particles, tot_number_of_particles, 1,       &
2374                        MPI_INTEGER, MPI_SUM, comm2d, ierr )
2375#else
2376    tot_number_of_particles = number_of_particles
2377#endif
2378
2379    IF ( nested_run )  THEN
2380       CALL pmcp_g_print_number_of_particles( simulated_time+dt_3d,            &
2381                                              tot_number_of_particles)
2382    ENDIF
2383
2384!
2385!-- Formats
23868000 FORMAT (I6,1X,F7.2,4X,I10,5X,4(I3,1X,I4,'/',I4,2X),6X,I10)
2387
2388
2389 END SUBROUTINE lpm_write_exchange_statistics
2390 
2391
2392!------------------------------------------------------------------------------!
2393! Description:
2394! ------------
2395!> Write particle data in FORTRAN binary and/or netCDF format
2396!------------------------------------------------------------------------------!
2397 SUBROUTINE lpm_data_output_particles
2398 
2399    INTEGER(iwp) ::  ip !<
2400    INTEGER(iwp) ::  jp !<
2401    INTEGER(iwp) ::  kp !<
2402
2403    CALL cpu_log( log_point_s(40), 'lpm_data_output', 'start' )
2404
2405!
2406!-- Attention: change version number for unit 85 (in routine check_open)
2407!--            whenever the output format for this unit is changed!
2408    CALL check_open( 85 )
2409
2410    WRITE ( 85 )  simulated_time
2411    WRITE ( 85 )  prt_count
2412         
2413    DO  ip = nxl, nxr
2414       DO  jp = nys, nyn
2415          DO  kp = nzb+1, nzt
2416             number_of_particles = prt_count(kp,jp,ip)
2417             particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
2418             IF ( number_of_particles <= 0 )  CYCLE
2419             WRITE ( 85 )  particles
2420          ENDDO
2421       ENDDO
2422    ENDDO
2423
2424    CALL close_file( 85 )
2425
2426
2427#if defined( __netcdf )
2428! !
2429! !-- Output in netCDF format
2430!     CALL check_open( 108 )
2431!
2432! !
2433! !-- Update the NetCDF time axis
2434!     prt_time_count = prt_time_count + 1
2435!
2436!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_time_prt, &
2437!                             (/ simulated_time /),        &
2438!                             start = (/ prt_time_count /), count = (/ 1 /) )
2439!     CALL netcdf_handle_error( 'lpm_data_output_particles', 1 )
2440!
2441! !
2442! !-- Output the real number of particles used
2443!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_rnop_prt, &
2444!                             (/ number_of_particles /),   &
2445!                             start = (/ prt_time_count /), count = (/ 1 /) )
2446!     CALL netcdf_handle_error( 'lpm_data_output_particles', 2 )
2447!
2448! !
2449! !-- Output all particle attributes
2450!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(1), particles%age,      &
2451!                             start = (/ 1, prt_time_count /),               &
2452!                             count = (/ maximum_number_of_particles /) )
2453!     CALL netcdf_handle_error( 'lpm_data_output_particles', 3 )
2454!
2455!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(2), particles%user,     &
2456!                             start = (/ 1, prt_time_count /),               &
2457!                             count = (/ maximum_number_of_particles /) )
2458!     CALL netcdf_handle_error( 'lpm_data_output_particles', 4 )
2459!
2460!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(3), particles%origin_x, &
2461!                             start = (/ 1, prt_time_count /),               &
2462!                             count = (/ maximum_number_of_particles /) )
2463!     CALL netcdf_handle_error( 'lpm_data_output_particles', 5 )
2464!
2465!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(4), particles%origin_y, &
2466!                             start = (/ 1, prt_time_count /),               &
2467!                             count = (/ maximum_number_of_particles /) )
2468!     CALL netcdf_handle_error( 'lpm_data_output_particles', 6 )
2469!
2470!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(5), particles%origin_z, &
2471!                             start = (/ 1, prt_time_count /),               &
2472!                             count = (/ maximum_number_of_particles /) )
2473!     CALL netcdf_handle_error( 'lpm_data_output_particles', 7 )
2474!
2475!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(6), particles%radius,   &
2476!                             start = (/ 1, prt_time_count /),               &
2477!                             count = (/ maximum_number_of_particles /) )
2478!     CALL netcdf_handle_error( 'lpm_data_output_particles', 8 )
2479!
2480!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(7), particles%speed_x,  &
2481!                             start = (/ 1, prt_time_count /),               &
2482!                             count = (/ maximum_number_of_particles /) )
2483!     CALL netcdf_handle_error( 'lpm_data_output_particles', 9 )
2484!
2485!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(8), particles%speed_y,  &
2486!                             start = (/ 1, prt_time_count /),               &
2487!                             count = (/ maximum_number_of_particles /) )
2488!     CALL netcdf_handle_error( 'lpm_data_output_particles', 10 )
2489!
2490!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(9), particles%speed_z,  &
2491!                             start = (/ 1, prt_time_count /),               &
2492!                             count = (/ maximum_number_of_particles /) )
2493!     CALL netcdf_handle_error( 'lpm_data_output_particles', 11 )
2494!
2495!     nc_stat = NF90_PUT_VAR( id_set_prt,id_var_prt(10),                     &
2496!                             particles%weight_factor,                       &
2497!                             start = (/ 1, prt_time_count /),               &
2498!                             count = (/ maximum_number_of_particles /) )
2499!     CALL netcdf_handle_error( 'lpm_data_output_particles', 12 )
2500!
2501!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(11), particles%x,       &
2502!                             start = (/ 1, prt_time_count /),               &
2503!                             count = (/ maximum_number_of_particles /) )
2504!     CALL netcdf_handle_error( 'lpm_data_output_particles', 13 )
2505!
2506!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(12), particles%y,       &
2507!                             start = (/ 1, prt_time_count /),               &
2508!                             count = (/ maximum_number_of_particles /) )
2509!     CALL netcdf_handle_error( 'lpm_data_output_particles', 14 )
2510!
2511!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(13), particles%z,       &
2512!                             start = (/ 1, prt_time_count /),               &
2513!                             count = (/ maximum_number_of_particles /) )
2514!     CALL netcdf_handle_error( 'lpm_data_output_particles', 15 )
2515!
2516!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(14), particles%class,   &
2517!                             start = (/ 1, prt_time_count /),               &
2518!                             count = (/ maximum_number_of_particles /) )
2519!     CALL netcdf_handle_error( 'lpm_data_output_particles', 16 )
2520!
2521!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(15), particles%group,   &
2522!                             start = (/ 1, prt_time_count /),               &
2523!                             count = (/ maximum_number_of_particles /) )
2524!     CALL netcdf_handle_error( 'lpm_data_output_particles', 17 )
2525!
2526!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(16),                    &
2527!                             particles%id2,                                 &
2528!                             start = (/ 1, prt_time_count /),               &
2529!                             count = (/ maximum_number_of_particles /) )
2530!     CALL netcdf_handle_error( 'lpm_data_output_particles', 18 )
2531!
2532!     nc_stat = NF90_PUT_VAR( id_set_prt, id_var_prt(17), particles%id1,     &
2533!                             start = (/ 1, prt_time_count /),               &
2534!                             count = (/ maximum_number_of_particles /) )
2535!     CALL netcdf_handle_error( 'lpm_data_output_particles', 19 )
2536!
2537#endif
2538
2539    CALL cpu_log( log_point_s(40), 'lpm_data_output', 'stop' )
2540
2541 END SUBROUTINE lpm_data_output_particles
2542 
2543!------------------------------------------------------------------------------!
2544! Description:
2545! ------------
2546!> This routine calculates and provide particle timeseries output.
2547!------------------------------------------------------------------------------!
2548 SUBROUTINE lpm_data_output_ptseries
2549 
2550    INTEGER(iwp) ::  i    !<
2551    INTEGER(iwp) ::  inum !<
2552    INTEGER(iwp) ::  j    !<
2553    INTEGER(iwp) ::  jg   !<
2554    INTEGER(iwp) ::  k    !<
2555    INTEGER(iwp) ::  n    !<
2556
2557    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pts_value   !<
2558    REAL(wp), DIMENSION(:,:), ALLOCATABLE ::  pts_value_l !<
2559
2560
2561    CALL cpu_log( log_point(36), 'data_output_ptseries', 'start' )
2562
2563    IF ( myid == 0 )  THEN
2564!
2565!--    Open file for time series output in NetCDF format
2566       dopts_time_count = dopts_time_count + 1
2567       CALL check_open( 109 )
2568#if defined( __netcdf )
2569!
2570!--    Update the particle time series time axis
2571       nc_stat = NF90_PUT_VAR( id_set_pts, id_var_time_pts,      &
2572                               (/ time_since_reference_point /), &
2573                               start = (/ dopts_time_count /), count = (/ 1 /) )
2574       CALL netcdf_handle_error( 'data_output_ptseries', 391 )
2575#endif
2576
2577    ENDIF
2578
2579    ALLOCATE( pts_value(0:number_of_particle_groups,dopts_num), &
2580              pts_value_l(0:number_of_particle_groups,dopts_num) )
2581
2582    pts_value_l = 0.0_wp
2583    pts_value_l(:,16) = 9999999.9_wp    ! for calculation of minimum radius
2584
2585!
2586!-- Calculate or collect the particle time series quantities for all particles
2587!-- and seperately for each particle group (if there is more than one group)
2588    DO  i = nxl, nxr
2589       DO  j = nys, nyn
2590          DO  k = nzb, nzt
2591             number_of_particles = prt_count(k,j,i)
2592             IF (number_of_particles <= 0)  CYCLE
2593             particles => grid_particles(k,j,i)%particles(1:number_of_particles)
2594             DO  n = 1, number_of_particles
2595
2596                IF ( particles(n)%particle_mask )  THEN  ! Restrict analysis to active particles
2597
2598                   pts_value_l(0,1)  = pts_value_l(0,1) + 1.0_wp  ! total # of particles
2599                   pts_value_l(0,2)  = pts_value_l(0,2) +                      &
2600                          ( particles(n)%x - particles(n)%origin_x )  ! mean x
2601                   pts_value_l(0,3)  = pts_value_l(0,3) +                      &
2602                          ( particles(n)%y - particles(n)%origin_y )  ! mean y
2603                   pts_value_l(0,4)  = pts_value_l(0,4) +                      &
2604                          ( particles(n)%z - particles(n)%origin_z )  ! mean z
2605                   pts_value_l(0,5)  = pts_value_l(0,5) + particles(n)%z        ! mean z (absolute)
2606                   pts_value_l(0,6)  = pts_value_l(0,6) + particles(n)%speed_x  ! mean u
2607                   pts_value_l(0,7)  = pts_value_l(0,7) + particles(n)%speed_y  ! mean v
2608                   pts_value_l(0,8)  = pts_value_l(0,8) + particles(n)%speed_z  ! mean w
2609                   pts_value_l(0,9)  = pts_value_l(0,9)  + particles(n)%rvar1 ! mean sgsu
2610                   pts_value_l(0,10) = pts_value_l(0,10) + particles(n)%rvar2 ! mean sgsv
2611                   pts_value_l(0,11) = pts_value_l(0,11) + particles(n)%rvar3 ! mean sgsw
2612                   IF ( particles(n)%speed_z > 0.0_wp )  THEN
2613                      pts_value_l(0,12) = pts_value_l(0,12) + 1.0_wp  ! # of upward moving prts
2614                      pts_value_l(0,13) = pts_value_l(0,13) +                  &
2615                                              particles(n)%speed_z ! mean w upw.
2616                   ELSE
2617                      pts_value_l(0,14) = pts_value_l(0,14) +                  &
2618                                              particles(n)%speed_z ! mean w down
2619                   ENDIF
2620                   pts_value_l(0,15) = pts_value_l(0,15) + particles(n)%radius ! mean rad
2621                   pts_value_l(0,16) = MIN( pts_value_l(0,16), particles(n)%radius ) ! minrad
2622                   pts_value_l(0,17) = MAX( pts_value_l(0,17), particles(n)%radius ) ! maxrad
2623                   pts_value_l(0,18) = pts_value_l(0,18) + 1.0_wp
2624                   pts_value_l(0,19) = pts_value_l(0,18) + 1.0_wp
2625!
2626!--                Repeat the same for the respective particle group
2627                   IF ( number_of_particle_groups > 1 )  THEN
2628                      jg = particles(n)%group
2629
2630                      pts_value_l(jg,1)  = pts_value_l(jg,1) + 1.0_wp
2631                      pts_value_l(jg,2)  = pts_value_l(jg,2) +                   &
2632                           ( particles(n)%x - particles(n)%origin_x )
2633                      pts_value_l(jg,3)  = pts_value_l(jg,3) +                   &
2634                           ( particles(n)%y - particles(n)%origin_y )
2635                      pts_value_l(jg,4)  = pts_value_l(jg,4) +                   &
2636                           ( particles(n)%z - particles(n)%origin_z )
2637                      pts_value_l(jg,5)  = pts_value_l(jg,5) + particles(n)%z
2638                      pts_value_l(jg,6)  = pts_value_l(jg,6) + particles(n)%speed_x
2639                      pts_value_l(jg,7)  = pts_value_l(jg,7) + particles(n)%speed_y
2640                      pts_value_l(jg,8)  = pts_value_l(jg,8) + particles(n)%speed_z
2641                      pts_value_l(jg,9)  = pts_value_l(jg,9)  + particles(n)%rvar1
2642                      pts_value_l(jg,10) = pts_value_l(jg,10) + particles(n)%rvar2
2643                      pts_value_l(jg,11) = pts_value_l(jg,11) + particles(n)%rvar3
2644                      IF ( particles(n)%speed_z > 0.0_wp )  THEN
2645                         pts_value_l(jg,12) = pts_value_l(jg,12) + 1.0_wp
2646                         pts_value_l(jg,13) = pts_value_l(jg,13) + particles(n)%speed_z
2647                      ELSE
2648                         pts_value_l(jg,14) = pts_value_l(jg,14) + particles(n)%speed_z
2649                      ENDIF
2650                      pts_value_l(jg,15) = pts_value_l(jg,15) + particles(n)%radius
2651                      pts_value_l(jg,16) = MIN( pts_value(jg,16), particles(n)%radius )
2652                      pts_value_l(jg,17) = MAX( pts_value(jg,17), particles(n)%radius )
2653                      pts_value_l(jg,18) = pts_value_l(jg,18) + 1.0_wp
2654                      pts_value_l(jg,19) = pts_value_l(jg,19) + 1.0_wp
2655                   ENDIF
2656
2657                ENDIF
2658
2659             ENDDO
2660
2661          ENDDO
2662       ENDDO
2663    ENDDO
2664
2665
2666#if defined( __parallel )
2667!
2668!-- Sum values of the subdomains
2669    inum = number_of_particle_groups + 1
2670
2671    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2672    CALL MPI_ALLREDUCE( pts_value_l(0,1), pts_value(0,1), 15*inum, MPI_REAL, &
2673                        MPI_SUM, comm2d, ierr )
2674    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2675    CALL MPI_ALLREDUCE( pts_value_l(0,16), pts_value(0,16), inum, MPI_REAL, &
2676                        MPI_MIN, comm2d, ierr )
2677    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2678    CALL MPI_ALLREDUCE( pts_value_l(0,17), pts_value(0,17), inum, MPI_REAL, &
2679                        MPI_MAX, comm2d, ierr )
2680    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2681    CALL MPI_ALLREDUCE( pts_value_l(0,18), pts_value(0,18), inum, MPI_REAL, &
2682                        MPI_MAX, comm2d, ierr )
2683    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2684    CALL MPI_ALLREDUCE( pts_value_l(0,19), pts_value(0,19), inum, MPI_REAL, &
2685                        MPI_MIN, comm2d, ierr )
2686#else
2687    pts_value(:,1:19) = pts_value_l(:,1:19)
2688#endif
2689
2690!
2691!-- Normalize the above calculated quantities (except min/max values) with the
2692!-- total number of particles
2693    IF ( number_of_particle_groups > 1 )  THEN
2694       inum = number_of_particle_groups
2695    ELSE
2696       inum = 0
2697    ENDIF
2698
2699    DO  j = 0, inum
2700
2701       IF ( pts_value(j,1) > 0.0_wp )  THEN
2702
2703          pts_value(j,2:15) = pts_value(j,2:15) / pts_value(j,1)
2704          IF ( pts_value(j,12) > 0.0_wp  .AND.  pts_value(j,12) < 1.0_wp )  THEN
2705             pts_value(j,13) = pts_value(j,13) / pts_value(j,12)
2706             pts_value(j,14) = pts_value(j,14) / ( 1.0_wp - pts_value(j,12) )
2707          ELSEIF ( pts_value(j,12) == 0.0_wp )  THEN
2708             pts_value(j,13) = -1.0_wp
2709          ELSE
2710             pts_value(j,14) = -1.0_wp
2711          ENDIF
2712
2713       ENDIF
2714
2715    ENDDO
2716
2717!
2718!-- Calculate higher order moments of particle time series quantities,
2719!-- seperately for each particle group (if there is more than one group)
2720    DO  i = nxl, nxr
2721       DO  j = nys, nyn
2722          DO  k = nzb, nzt
2723             number_of_particles = prt_count(k,j,i)
2724             IF (number_of_particles <= 0)  CYCLE
2725             particles => grid_particles(k,j,i)%particles(1:number_of_particles)
2726             DO  n = 1, number_of_particles
2727
2728                pts_value_l(0,20) = pts_value_l(0,20) + ( particles(n)%x - &
2729                                    particles(n)%origin_x - pts_value(0,2) )**2 ! x*2
2730                pts_value_l(0,21) = pts_value_l(0,21) + ( particles(n)%y - &
2731                                    particles(n)%origin_y - pts_value(0,3) )**2 ! y*2
2732                pts_value_l(0,22) = pts_value_l(0,22) + ( particles(n)%z - &
2733                                    particles(n)%origin_z - pts_value(0,4) )**2 ! z*2
2734                pts_value_l(0,23) = pts_value_l(0,23) + ( particles(n)%speed_x - &
2735                                                         pts_value(0,6) )**2   ! u*2
2736                pts_value_l(0,24) = pts_value_l(0,24) + ( particles(n)%speed_y - &
2737                                                          pts_value(0,7) )**2   ! v*2
2738                pts_value_l(0,25) = pts_value_l(0,25) + ( particles(n)%speed_z - &
2739                                                          pts_value(0,8) )**2   ! w*2
2740                pts_value_l(0,26) = pts_value_l(0,26) + ( particles(n)%rvar1 - &
2741                                                          pts_value(0,9) )**2   ! u"2
2742                pts_value_l(0,27) = pts_value_l(0,27) + ( particles(n)%rvar2 - &
2743                                                          pts_value(0,10) )**2  ! v"2
2744                pts_value_l(0,28) = pts_value_l(0,28) + ( particles(n)%rvar3 - &
2745                                                          pts_value(0,11) )**2  ! w"2
2746!
2747!--             Repeat the same for the respective particle group
2748                IF ( number_of_particle_groups > 1 )  THEN
2749                   jg = particles(n)%group
2750
2751                   pts_value_l(jg,20) = pts_value_l(jg,20) + ( particles(n)%x - &
2752                                       particles(n)%origin_x - pts_value(jg,2) )**2
2753                   pts_value_l(jg,21) = pts_value_l(jg,21) + ( particles(n)%y - &
2754                                       particles(n)%origin_y - pts_value(jg,3) )**2
2755                   pts_value_l(jg,22) = pts_value_l(jg,22) + ( particles(n)%z - &
2756                                       particles(n)%origin_z - pts_value(jg,4) )**2
2757                   pts_value_l(jg,23) = pts_value_l(jg,23) + ( particles(n)%speed_x - &
2758                                                             pts_value(jg,6) )**2
2759                   pts_value_l(jg,24) = pts_value_l(jg,24) + ( particles(n)%speed_y - &
2760                                                             pts_value(jg,7) )**2
2761                   pts_value_l(jg,25) = pts_value_l(jg,25) + ( particles(n)%speed_z - &
2762                                                             pts_value(jg,8) )**2
2763                   pts_value_l(jg,26) = pts_value_l(jg,26) + ( particles(n)%rvar1 - &
2764                                                             pts_value(jg,9) )**2
2765                   pts_value_l(jg,27) = pts_value_l(jg,27) + ( particles(n)%rvar2 - &
2766                                                             pts_value(jg,10) )**2
2767                   pts_value_l(jg,28) = pts_value_l(jg,28) + ( particles(n)%rvar3 - &
2768                                                             pts_value(jg,11) )**2
2769                ENDIF
2770
2771             ENDDO
2772          ENDDO
2773       ENDDO
2774    ENDDO
2775
2776    pts_value_l(0,29) = ( number_of_particles - pts_value(0,1) / numprocs )**2
2777                                                 ! variance of particle numbers
2778    IF ( number_of_particle_groups > 1 )  THEN
2779       DO  j = 1, number_of_particle_groups
2780          pts_value_l(j,29) = ( pts_value_l(j,1) - &
2781                                pts_value(j,1) / numprocs )**2
2782       ENDDO
2783    ENDIF
2784
2785#if defined( __parallel )
2786!
2787!-- Sum values of the subdomains
2788    inum = number_of_particle_groups + 1
2789
2790    IF ( collective_wait )  CALL MPI_BARRIER( comm2d, ierr )
2791    CALL MPI_ALLREDUCE( pts_value_l(0,20), pts_value(0,20), inum*10, MPI_REAL, &
2792                        MPI_SUM, comm2d, ierr )
2793#else
2794    pts_value(:,20:29) = pts_value_l(:,20:29)
2795#endif
2796
2797!
2798!-- Normalize the above calculated quantities with the total number of
2799!-- particles
2800    IF ( number_of_particle_groups > 1 )  THEN
2801       inum = number_of_particle_groups
2802    ELSE
2803       inum = 0
2804    ENDIF
2805
2806    DO  j = 0, inum
2807
2808       IF ( pts_value(j,1) > 0.0_wp )  THEN
2809          pts_value(j,20:28) = pts_value(j,20:28) / pts_value(j,1)
2810       ENDIF
2811       pts_value(j,29) = pts_value(j,29) / numprocs
2812
2813    ENDDO
2814
2815#if defined( __netcdf )
2816!
2817!-- Output particle time series quantities in NetCDF format
2818    IF ( myid == 0 )  THEN
2819       DO  j = 0, inum
2820          DO  i = 1, dopts_num
2821             nc_stat = NF90_PUT_VAR( id_set_pts, id_var_dopts(i,j),  &
2822                                     (/ pts_value(j,i) /),           &
2823                                     start = (/ dopts_time_count /), &
2824                                     count = (/ 1 /) )
2825             CALL netcdf_handle_error( 'data_output_ptseries', 392 )
2826          ENDDO
2827       ENDDO
2828    ENDIF
2829#endif
2830
2831    DEALLOCATE( pts_value, pts_value_l )
2832
2833    CALL cpu_log( log_point(36), 'data_output_ptseries', 'stop' )
2834
2835END SUBROUTINE lpm_data_output_ptseries
2836
2837 
2838!------------------------------------------------------------------------------!
2839! Description:
2840! ------------
2841!> This routine reads the respective restart data for the lpm.
2842!------------------------------------------------------------------------------!
2843 SUBROUTINE lpm_rrd_local_particles
2844
2845    CHARACTER (LEN=10) ::  particle_binary_version    !<
2846    CHARACTER (LEN=10) ::  version_on_file            !<
2847
2848    INTEGER(iwp) :: alloc_size !<
2849    INTEGER(iwp) :: ip         !<
2850    INTEGER(iwp) :: jp         !<
2851    INTEGER(iwp) :: kp         !<
2852
2853    TYPE(particle_type), DIMENSION(:), ALLOCATABLE :: tmp_particles !<
2854
2855!
2856!-- Read particle data from previous model run.
2857!-- First open the input unit.
2858    IF ( myid_char == '' )  THEN
2859       OPEN ( 90, FILE='PARTICLE_RESTART_DATA_IN'//myid_char,                  &
2860                  FORM='UNFORMATTED' )
2861    ELSE
2862       OPEN ( 90, FILE='PARTICLE_RESTART_DATA_IN/'//myid_char,                 &
2863                  FORM='UNFORMATTED' )
2864    ENDIF
2865
2866!
2867!-- First compare the version numbers
2868    READ ( 90 )  version_on_file
2869    particle_binary_version = '4.0'
2870    IF ( TRIM( version_on_file ) /= TRIM( particle_binary_version ) )  THEN
2871       message_string = 'version mismatch concerning data from prior ' //      &
2872                        'run &version on file = "' //                          &
2873                                      TRIM( version_on_file ) //               &
2874                        '&version in program = "' //                           &
2875                                      TRIM( particle_binary_version ) // '"'
2876       CALL message( 'lpm_read_restart_file', 'PA0214', 1, 2, 0, 6, 0 )
2877    ENDIF
2878
2879!
2880!-- If less particles are stored on the restart file than prescribed by
2881!-- 1, the remainder is initialized by zero_particle to avoid
2882!-- errors.
2883    zero_particle = particle_type( 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,     &
2884                                   0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,     &
2885                                   0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,     &
2886                                   0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp, 0.0_wp,     &
2887                                   0, 0, 0_idp, .FALSE., -1 )
2888!
2889!-- Read some particle parameters and the size of the particle arrays,
2890!-- allocate them and read their contents.
2891    READ ( 90 )  bc_par_b, bc_par_lr, bc_par_ns, bc_par_t,                     &
2892                 last_particle_release_time, number_of_particle_groups,        &
2893                 particle_groups, time_write_particle_data
2894
2895    ALLOCATE( prt_count(nzb:nzt+1,nysg:nyng,nxlg:nxrg),                        &
2896              grid_particles(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
2897
2898    READ ( 90 )  prt_count
2899
2900    DO  ip = nxl, nxr
2901       DO  jp = nys, nyn
2902          DO  kp = nzb+1, nzt
2903
2904             number_of_particles = prt_count(kp,jp,ip)
2905             IF ( number_of_particles > 0 )  THEN
2906                alloc_size = MAX( INT( number_of_particles *                   &
2907                             ( 1.0_wp + alloc_factor / 100.0_wp ) ),           &
2908                             1 )
2909             ELSE
2910                alloc_size = 1
2911             ENDIF
2912
2913             ALLOCATE( grid_particles(kp,jp,ip)%particles(1:alloc_size) )
2914
2915             IF ( number_of_particles > 0 )  THEN
2916                ALLOCATE( tmp_particles(1:number_of_particles) )
2917                READ ( 90 )  tmp_particles
2918                grid_particles(kp,jp,ip)%particles(1:number_of_particles) = tmp_particles
2919                DEALLOCATE( tmp_particles )
2920                IF ( number_of_particles < alloc_size )  THEN
2921                   grid_particles(kp,jp,ip)%particles(number_of_particles+1:alloc_size) &
2922                      = zero_particle
2923                ENDIF
2924             ELSE
2925                grid_particles(kp,jp,ip)%particles(1:alloc_size) = zero_particle
2926             ENDIF
2927
2928          ENDDO
2929       ENDDO
2930    ENDDO
2931
2932    CLOSE ( 90 )
2933!
2934!-- Must be called to sort particles into blocks, which is needed for a fast
2935!-- interpolation of the LES fields on the particle position.
2936    CALL lpm_sort_in_subboxes
2937       
2938
2939 END SUBROUTINE lpm_rrd_local_particles
2940 
2941 
2942 SUBROUTINE lpm_rrd_local( k, nxlf, nxlc, nxl_on_file, nxrf, nxrc,          &
2943                              nxr_on_file, nynf, nync, nyn_on_file, nysf,  &
2944                              nysc, nys_on_file, tmp_3d, found )
2945                             
2946       
2947   USE control_parameters,                                                 &
2948       ONLY: length, restart_string           
2949
2950    INTEGER(iwp) ::  k               !<
2951    INTEGER(iwp) ::  nxlc            !<
2952    INTEGER(iwp) ::  nxlf            !<
2953    INTEGER(iwp) ::  nxl_on_file     !<
2954    INTEGER(iwp) ::  nxrc            !<
2955    INTEGER(iwp) ::  nxrf            !<
2956    INTEGER(iwp) ::  nxr_on_file     !<
2957    INTEGER(iwp) ::  nync            !<
2958    INTEGER(iwp) ::  nynf            !<
2959    INTEGER(iwp) ::  nyn_on_file     !<
2960    INTEGER(iwp) ::  nysc            !<
2961    INTEGER(iwp) ::  nysf            !<
2962    INTEGER(iwp) ::  nys_on_file     !<
2963
2964    LOGICAL, INTENT(OUT)  ::  found
2965
2966    REAL(wp), DIMENSION(nzb:nzt+1,nys_on_file-nbgp:nyn_on_file+nbgp,nxl_on_file-nbgp:nxr_on_file+nbgp) :: tmp_3d   !<
2967
2968   
2969    found = .TRUE.
2970
2971    SELECT CASE ( restart_string(1:length) )
2972   
2973       CASE ( 'iran' ) ! matching random numbers is still unresolved issue
2974          IF ( k == 1 )  READ ( 13 )  iran, iran_part
2975         
2976        CASE ( 'pc_av' )
2977           IF ( .NOT. ALLOCATED( pc_av ) )  THEN
2978              ALLOCATE( pc_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
2979           ENDIF
2980           IF ( k == 1 )  READ ( 13 )  tmp_3d
2981           pc_av(:,nysc-nbgp:nync+nbgp,nxlc-nbgp:nxrc+nbgp) =          &
2982              tmp_3d(:,nysf-nbgp:nynf+nbgp,nxlf-nbgp:nxrf+nbgp)
2983
2984        CASE ( 'pr_av' )
2985           IF ( .NOT. ALLOCATED( pr_av ) )  THEN
2986              ALLOCATE( pr_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
2987           ENDIF
2988           IF ( k == 1 )  READ ( 13 )  tmp_3d
2989           pr_av(:,nysc-nbgp:nync+nbgp,nxlc-nbgp:nxrc+nbgp) =          &
2990              tmp_3d(:,nysf-nbgp:nynf+nbgp,nxlf-nbgp:nxrf+nbgp)
2991 
2992         CASE ( 'ql_c_av' )
2993            IF ( .NOT. ALLOCATED( ql_c_av ) )  THEN
2994               ALLOCATE( ql_c_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
2995            ENDIF
2996            IF ( k == 1 )  READ ( 13 )  tmp_3d
2997            ql_c_av(:,nysc-nbgp:nync+nbgp,nxlc-nbgp:nxrc+nbgp) =        &
2998               tmp_3d(:,nysf-nbgp:nynf+nbgp,nxlf-nbgp:nxrf+nbgp)
2999
3000         CASE ( 'ql_v_av' )
3001            IF ( .NOT. ALLOCATED( ql_v_av ) )  THEN
3002               ALLOCATE( ql_v_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
3003            ENDIF
3004            IF ( k == 1 )  READ ( 13 )  tmp_3d
3005            ql_v_av(:,nysc-nbgp:nync+nbgp,nxlc-nbgp:nxrc+nbgp) =        &
3006               tmp_3d(:,nysf-nbgp:nynf+nbgp,nxlf-nbgp:nxrf+nbgp)
3007
3008         CASE ( 'ql_vp_av' )
3009            IF ( .NOT. ALLOCATED( ql_vp_av ) )  THEN
3010               ALLOCATE( ql_vp_av(nzb:nzt+1,nysg:nyng,nxlg:nxrg) )
3011            ENDIF
3012            IF ( k == 1 )  READ ( 13 )  tmp_3d
3013            ql_vp_av(:,nysc-nbgp:nync+nbgp,nxlc-nbgp:nxrc+nbgp) =       &
3014               tmp_3d(:,nysf-nbgp:nynf+nbgp,nxlf-nbgp:nxrf+nbgp)
3015
3016          CASE DEFAULT
3017
3018             found = .FALSE.
3019
3020       END SELECT
3021               
3022
3023 END SUBROUTINE lpm_rrd_local
3024 
3025!------------------------------------------------------------------------------!
3026! Description:
3027! ------------
3028!> This routine writes the respective restart data for the lpm.
3029!------------------------------------------------------------------------------!
3030 SUBROUTINE lpm_wrd_local
3031 
3032    CHARACTER (LEN=10) ::  particle_binary_version   !<
3033
3034    INTEGER(iwp) ::  ip                              !<
3035    INTEGER(iwp) ::  jp                              !<
3036    INTEGER(iwp) ::  kp                              !<
3037!
3038!-- First open the output unit.
3039    IF ( myid_char == '' )  THEN
3040       OPEN ( 90, FILE='PARTICLE_RESTART_DATA_OUT'//myid_char, &
3041                  FORM='UNFORMATTED')
3042    ELSE
3043       IF ( myid == 0 )  CALL local_system( 'mkdir PARTICLE_RESTART_DATA_OUT' )
3044#if defined( __parallel )
3045!
3046!--    Set a barrier in order to allow that thereafter all other processors
3047!--    in the directory created by PE0 can open their file
3048       CALL MPI_BARRIER( comm2d, ierr )
3049#endif
3050       OPEN ( 90, FILE='PARTICLE_RESTART_DATA_OUT/'//myid_char, &
3051                  FORM='UNFORMATTED' )
3052    ENDIF
3053
3054!
3055!-- Write the version number of the binary format.
3056!-- Attention: After changes to the following output commands the version
3057!-- ---------  number of the variable particle_binary_version must be
3058!--            changed! Also, the version number and the list of arrays
3059!--            to be read in lpm_read_restart_file must be adjusted
3060!--            accordingly.
3061    particle_binary_version = '4.0'
3062    WRITE ( 90 )  particle_binary_version
3063
3064!
3065!-- Write some particle parameters, the size of the particle arrays
3066    WRITE ( 90 )  bc_par_b, bc_par_lr, bc_par_ns, bc_par_t,                    &
3067                  last_particle_release_time, number_of_particle_groups,       &
3068                  particle_groups, time_write_particle_data
3069
3070    WRITE ( 90 )  prt_count
3071         
3072    DO  ip = nxl, nxr
3073       DO  jp = nys, nyn
3074          DO  kp = nzb+1, nzt
3075             number_of_particles = prt_count(kp,jp,ip)
3076             particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
3077             IF ( number_of_particles <= 0 )  CYCLE
3078             WRITE ( 90 )  particles
3079          ENDDO
3080       ENDDO
3081    ENDDO
3082
3083    CLOSE ( 90 )
3084
3085#if defined( __parallel )
3086       CALL MPI_BARRIER( comm2d, ierr )
3087#endif
3088
3089    CALL wrd_write_string( 'iran' ) 
3090    WRITE ( 14 )  iran, iran_part
3091
3092
3093 END SUBROUTINE lpm_wrd_local
3094
3095
3096!------------------------------------------------------------------------------!
3097! Description:
3098! ------------
3099!> This routine writes the respective restart data for the lpm.
3100!------------------------------------------------------------------------------!
3101 SUBROUTINE lpm_wrd_global
3102 
3103    CALL wrd_write_string( 'curvature_solution_effects' ) 
3104    WRITE ( 14 )  curvature_solution_effects
3105
3106 END SUBROUTINE lpm_wrd_global
3107 
3108
3109!------------------------------------------------------------------------------!
3110! Description:
3111! ------------
3112!> This routine writes the respective restart data for the lpm.
3113!------------------------------------------------------------------------------!
3114 SUBROUTINE lpm_rrd_global( found )
3115 
3116    USE control_parameters,                            &
3117        ONLY: length, restart_string
3118
3119    LOGICAL, INTENT(OUT)  ::  found
3120
3121    found = .TRUE.
3122
3123    SELECT CASE ( restart_string(1:length) )
3124
3125       CASE ( 'curvature_solution_effects' )
3126          READ ( 13 )  curvature_solution_effects
3127         
3128!          CASE ( 'global_paramter' )
3129!             READ ( 13 )  global_parameter
3130!          CASE ( 'global_array' )
3131!             IF ( .NOT. ALLOCATED( global_array ) )  ALLOCATE( global_array(1:10) )
3132!             READ ( 13 )  global_array
3133
3134       CASE DEFAULT
3135
3136          found = .FALSE.
3137
3138    END SELECT
3139   
3140 END SUBROUTINE lpm_rrd_global
3141
3142
3143!------------------------------------------------------------------------------!
3144! Description:
3145! ------------
3146!> This is a submodule of the lagrangian particle model. It contains all
3147!> dynamic processes of the lpm. This includes the advection (resolved and sub-
3148!> grid scale) as well as the boundary conditions of particles. As a next step
3149!> this submodule should be excluded as an own file.
3150!------------------------------------------------------------------------------!   
3151 SUBROUTINE lpm_advec (ip,jp,kp)
3152
3153    LOGICAL ::  subbox_at_wall !< flag to see if the current subgridbox is adjacent to a wall
3154
3155    INTEGER(iwp) ::  i                           !< index variable along x
3156    INTEGER(iwp) ::  ip                          !< index variable along x
3157    INTEGER(iwp) ::  j                           !< index variable along y
3158    INTEGER(iwp) ::  jp                          !< index variable along y
3159    INTEGER(iwp) ::  k                           !< index variable along z
3160    INTEGER(iwp) ::  k_wall                      !< vertical index of topography top
3161    INTEGER(iwp) ::  kp                          !< index variable along z
3162    INTEGER(iwp) ::  kw                          !< index variable along z
3163    INTEGER(iwp) ::  n                           !< loop variable over all particles in a grid box
3164    INTEGER(iwp) ::  nb                          !< block number particles are sorted in
3165    INTEGER(iwp) ::  surf_start                  !< Index on surface data-type for current grid box
3166
3167    INTEGER(iwp), DIMENSION(0:7) ::  start_index !< start particle index for current block
3168    INTEGER(iwp), DIMENSION(0:7) ::  end_index   !< start particle index for current block
3169
3170    REAL(wp) ::  aa                 !< dummy argument for horizontal particle interpolation
3171    REAL(wp) ::  bb                 !< dummy argument for horizontal particle interpolation
3172    REAL(wp) ::  cc                 !< dummy argument for horizontal particle interpolation
3173    REAL(wp) ::  d_z_p_z0           !< inverse of interpolation length for logarithmic interpolation
3174    REAL(wp) ::  dd                 !< dummy argument for horizontal particle interpolation
3175    REAL(wp) ::  de_dx_int_l        !< x/y-interpolated TKE gradient (x) at particle position at lower vertical level
3176    REAL(wp) ::  de_dx_int_u        !< x/y-interpolated TKE gradient (x) at particle position at upper vertical level
3177    REAL(wp) ::  de_dy_int_l        !< x/y-interpolated TKE gradient (y) at particle position at lower vertical level
3178    REAL(wp) ::  de_dy_int_u        !< x/y-interpolated TKE gradient (y) at particle position at upper vertical level
3179    REAL(wp) ::  de_dt              !< temporal derivative of TKE experienced by the particle
3180    REAL(wp) ::  de_dt_min          !< lower level for temporal TKE derivative
3181    REAL(wp) ::  de_dz_int_l        !< x/y-interpolated TKE gradient (z) at particle position at lower vertical level
3182    REAL(wp) ::  de_dz_int_u        !< x/y-interpolated TKE gradient (z) at particle position at upper vertical level
3183    REAL(wp) ::  diameter           !< diamter of droplet
3184    REAL(wp) ::  diss_int_l         !< x/y-interpolated dissipation at particle position at lower vertical level
3185    REAL(wp) ::  diss_int_u         !< x/y-interpolated dissipation at particle position at upper vertical level
3186    REAL(wp) ::  dt_particle_m      !< previous particle time step
3187    REAL(wp) ::  dz_temp            !< dummy for the vertical grid spacing
3188    REAL(wp) ::  e_int_l            !< x/y-interpolated TKE at particle position at lower vertical level
3189    REAL(wp) ::  e_int_u            !< x/y-interpolated TKE at particle position at upper vertical level
3190    REAL(wp) ::  e_mean_int         !< horizontal mean TKE at particle height
3191    REAL(wp) ::  exp_arg            !< argument in the exponent - particle radius
3192    REAL(wp) ::  exp_term           !< exponent term
3193    REAL(wp) ::  gg                 !< dummy argument for horizontal particle interpolation
3194    REAL(wp) ::  height_p           !< dummy argument for logarithmic interpolation
3195    REAL(wp) ::  log_z_z0_int       !< logarithmus used for surface_layer interpolation
3196    REAL(wp) ::  random_gauss       !< Gaussian-distributed random number used for SGS particle advection
3197    REAL(wp) ::  RL                 !< Lagrangian autocorrelation coefficient
3198    REAL(wp) ::  rg1                !< Gaussian distributed random number
3199    REAL(wp) ::  rg2                !< Gaussian distributed random number
3200    REAL(wp) ::  rg3                !< Gaussian distributed random number
3201    REAL(wp) ::  sigma              !< velocity standard deviation
3202    REAL(wp) ::  u_int_l            !< x/y-interpolated u-component at particle position at lower vertical level
3203    REAL(wp) ::  u_int_u            !< x/y-interpolated u-component at particle position at upper vertical level
3204    REAL(wp) ::  us_int             !< friction velocity at particle grid box
3205    REAL(wp) ::  usws_int           !< surface momentum flux (u component) at particle grid box
3206    REAL(wp) ::  v_int_l            !< x/y-interpolated v-component at particle position at lower vertical level
3207    REAL(wp) ::  v_int_u            !< x/y-interpolated v-component at particle position at upper vertical level
3208    REAL(wp) ::  vsws_int           !< surface momentum flux (u component) at particle grid box
3209    REAL(wp) ::  vv_int             !< dummy to compute interpolated mean SGS TKE, used to scale SGS advection
3210    REAL(wp) ::  w_int_l            !< x/y-interpolated w-component at particle position at lower vertical level
3211    REAL(wp) ::  w_int_u            !< x/y-interpolated w-component at particle position at upper vertical level
3212    REAL(wp) ::  w_s                !< terminal velocity of droplets
3213    REAL(wp) ::  x                  !< dummy argument for horizontal particle interpolation
3214    REAL(wp) ::  y                  !< dummy argument for horizontal particle interpolation
3215    REAL(wp) ::  z_p                !< surface layer height (0.5 dz)
3216
3217    REAL(wp), PARAMETER ::  a_rog = 9.65_wp      !< parameter for fall velocity
3218    REAL(wp), PARAMETER ::  b_rog = 10.43_wp     !< parameter for fall velocity
3219    REAL(wp), PARAMETER ::  c_rog = 0.6_wp       !< parameter for fall velocity
3220    REAL(wp), PARAMETER ::  k_cap_rog = 4.0_wp   !< parameter for fall velocity
3221    REAL(wp), PARAMETER ::  k_low_rog = 12.0_wp  !< parameter for fall velocity
3222    REAL(wp), PARAMETER ::  d0_rog = 0.745_wp    !< separation diameter
3223
3224    REAL(wp), DIMENSION(number_of_particles) ::  term_1_2       !< flag to communicate whether a particle is near topography or not
3225    REAL(wp), DIMENSION(number_of_particles) ::  dens_ratio     !< ratio between the density of the fluid and the density of the particles
3226    REAL(wp), DIMENSION(number_of_particles) ::  de_dx_int      !< horizontal TKE gradient along x at particle position
3227    REAL(wp), DIMENSION(number_of_particles) ::  de_dy_int      !< horizontal TKE gradient along y at particle position
3228    REAL(wp), DIMENSION(number_of_particles) ::  de_dz_int      !< horizontal TKE gradient along z at particle position
3229    REAL(wp), DIMENSION(number_of_particles) ::  diss_int       !< dissipation at particle position
3230    REAL(wp), DIMENSION(number_of_particles) ::  dt_gap         !< remaining time until particle time integration reaches LES time
3231    REAL(wp), DIMENSION(number_of_particles) ::  dt_particle    !< particle time step
3232    REAL(wp), DIMENSION(number_of_particles) ::  e_int          !< TKE at particle position
3233    REAL(wp), DIMENSION(number_of_particles) ::  fs_int         !< weighting factor for subgrid-scale particle speed
3234    REAL(wp), DIMENSION(number_of_particles) ::  lagr_timescale !< Lagrangian timescale
3235    REAL(wp), DIMENSION(number_of_particles) ::  rvar1_temp     !< SGS particle velocity - u-component
3236    REAL(wp), DIMENSION(number_of_particles) ::  rvar2_temp     !< SGS particle velocity - v-component
3237    REAL(wp), DIMENSION(number_of_particles) ::  rvar3_temp     !< SGS particle velocity - w-component
3238    REAL(wp), DIMENSION(number_of_particles) ::  u_int          !< u-component of particle speed
3239    REAL(wp), DIMENSION(number_of_particles) ::  v_int          !< v-component of particle speed
3240    REAL(wp), DIMENSION(number_of_particles) ::  w_int          !< w-component of particle speed
3241    REAL(wp), DIMENSION(number_of_particles) ::  xv             !< x-position
3242    REAL(wp), DIMENSION(number_of_particles) ::  yv             !< y-position
3243    REAL(wp), DIMENSION(number_of_particles) ::  zv             !< z-position
3244
3245    REAL(wp), DIMENSION(number_of_particles, 3) ::  rg !< vector of Gaussian distributed random numbers
3246
3247    CALL cpu_log( log_point_s(44), 'lpm_advec', 'continue' )
3248
3249!
3250!-- Determine height of Prandtl layer and distance between Prandtl-layer
3251!-- height and horizontal mean roughness height, which are required for
3252!-- vertical logarithmic interpolation of horizontal particle speeds
3253!-- (for particles below first vertical grid level).
3254    z_p      = zu(nzb+1) - zw(nzb)
3255    d_z_p_z0 = 1.0_wp / ( z_p - z0_av_global )
3256
3257    start_index = grid_particles(kp,jp,ip)%start_index
3258    end_index   = grid_particles(kp,jp,ip)%end_index
3259
3260    xv = particles(1:number_of_particles)%x
3261    yv = particles(1:number_of_particles)%y
3262    zv = particles(1:number_of_particles)%z
3263
3264    DO  nb = 0, 7
3265!
3266!--    Interpolate u velocity-component       
3267       i = ip
3268       j = jp + block_offset(nb)%j_off
3269       k = kp + block_offset(nb)%k_off
3270
3271       DO  n = start_index(nb), end_index(nb)
3272!
3273!--       Interpolation of the u velocity component onto particle position. 
3274!--       Particles are interpolation bi-linearly in the horizontal and a
3275!--       linearly in the vertical. An exception is made for particles below
3276!--       the first vertical grid level in case of a prandtl layer. In this
3277!--       case the horizontal particle velocity components are determined using
3278!--       Monin-Obukhov relations (if branch).
3279!--       First, check if particle is located below first vertical grid level
3280!--       above topography (Prandtl-layer height)
3281!--       Determine vertical index of topography top
3282          k_wall = get_topography_top_index_ji( jp, ip, 's' )
3283
3284          IF ( constant_flux_layer  .AND.  zv(n) - zw(k_wall) < z_p )  THEN
3285!
3286!--          Resolved-scale horizontal particle velocity is zero below z0.
3287             IF ( zv(n) - zw(k_wall) < z0_av_global )  THEN
3288                u_int(n) = 0.0_wp
3289             ELSE
3290!
3291!--             Determine the sublayer. Further used as index.
3292                height_p = ( zv(n) - zw(k_wall) - z0_av_global ) &
3293                                     * REAL( number_of_sublayers, KIND=wp )    &
3294                                     * d_z_p_z0
3295!
3296!--             Calculate LOG(z/z0) for exact particle height. Therefore,   
3297!--             interpolate linearly between precalculated logarithm.
3298                log_z_z0_int = log_z_z0(INT(height_p))                         &
3299                                 + ( height_p - INT(height_p) )                &
3300                                 * ( log_z_z0(INT(height_p)+1)                 &
3301                                      - log_z_z0(INT(height_p))                &
3302                                   ) 
3303!
3304!--             Get friction velocity and momentum flux from new surface data
3305!--             types.
3306                IF ( surf_def_h(0)%start_index(jp,ip) <=                   &
3307                     surf_def_h(0)%end_index(jp,ip) )  THEN
3308                   surf_start = surf_def_h(0)%start_index(jp,ip)
3309!--                Limit friction velocity. In narrow canyons or holes the
3310!--                friction velocity can become very small, resulting in a too
3311!--                large particle speed.
3312                   us_int    = MAX( surf_def_h(0)%us(surf_start), 0.01_wp ) 
3313                   usws_int  = surf_def_h(0)%usws(surf_start)
3314                ELSEIF ( surf_lsm_h%start_index(jp,ip) <=                  &
3315                         surf_lsm_h%end_index(jp,ip) )  THEN
3316                   surf_start = surf_lsm_h%start_index(jp,ip)
3317                   us_int    = MAX( surf_lsm_h%us(surf_start), 0.01_wp ) 
3318                   usws_int  = surf_lsm_h%usws(surf_start)
3319                ELSEIF ( surf_usm_h%start_index(jp,ip) <=                  &
3320                         surf_usm_h%end_index(jp,ip) )  THEN
3321                   surf_start = surf_usm_h%start_index(jp,ip)
3322                   us_int    = MAX( surf_usm_h%us(surf_start), 0.01_wp ) 
3323                   usws_int  = surf_usm_h%usws(surf_start)
3324                ENDIF
3325
3326!
3327!--             Neutral solution is applied for all situations, e.g. also for
3328!--             unstable and stable situations. Even though this is not exact
3329!--             this saves a lot of CPU time since several calls of intrinsic
3330!--             FORTRAN procedures (LOG, ATAN) are avoided, This is justified
3331!--             as sensitivity studies revealed no significant effect of
3332!--             using the neutral solution also for un/stable situations.
3333                u_int(n) = -usws_int / ( us_int * kappa + 1E-10_wp )           & 
3334                            * log_z_z0_int - u_gtrans
3335
3336             ENDIF
3337!
3338!--       Particle above the first grid level. Bi-linear interpolation in the
3339!--       horizontal and linear interpolation in the vertical direction.
3340          ELSE
3341
3342             = xv(n) - i * dx
3343             y  = yv(n) + ( 0.5_wp - j ) * dy
3344             aa = x**2          + y**2
3345             bb = ( dx - x )**2 + y**2
3346             cc = x**2          + ( dy - y )**2
3347             dd = ( dx - x )**2 + ( dy - y )**2
3348             gg = aa + bb + cc + dd
3349
3350             u_int_l = ( ( gg - aa ) * u(k,j,i)   + ( gg - bb ) * u(k,j,i+1)   &
3351                         + ( gg - cc ) * u(k,j+1,i) + ( gg - dd ) *            &
3352                         u(k,j+1,i+1) ) / ( 3.0_wp * gg ) - u_gtrans
3353
3354             IF ( k == nzt )  THEN
3355                u_int(n) = u_int_l
3356             ELSE
3357                u_int_u = ( ( gg-aa ) * u(k+1,j,i) + ( gg-bb ) * u(k+1,j,i+1)  &
3358                            + ( gg-cc ) * u(k+1,j+1,i) + ( gg-dd ) *           &
3359                            u(k+1,j+1,i+1) ) / ( 3.0_wp * gg ) - u_gtrans
3360                u_int(n) = u_int_l + ( zv(n) - zu(k) ) / dzw(k+1) *               &
3361                           ( u_int_u - u_int_l )
3362             ENDIF
3363
3364          ENDIF
3365
3366       ENDDO
3367!
3368!--    Same procedure for interpolation of the v velocity-component
3369       i = ip + block_offset(nb)%i_off
3370       j = jp
3371       k = kp + block_offset(nb)%k_off
3372
3373       DO  n = start_index(nb), end_index(nb)
3374
3375!
3376!--       Determine vertical index of topography top
3377          k_wall = get_topography_top_index_ji( jp,ip, 's' )
3378
3379          IF ( constant_flux_layer  .AND.  zv(n) - zw(k_wall) < z_p )  THEN
3380             IF ( zv(n) - zw(k_wall) < z0_av_global )  THEN
3381!
3382!--             Resolved-scale horizontal particle velocity is zero below z0.
3383                v_int(n) = 0.0_wp
3384             ELSE       
3385!
3386!--             Determine the sublayer. Further used as index. Please note,
3387!--             logarithmus can not be reused from above, as in in case of
3388!--             topography particle on u-grid can be above surface-layer height,
3389!--             whereas it can be below on v-grid.
3390                height_p = ( zv(n) - zw(k_wall) - z0_av_global ) &
3391                                  * REAL( number_of_sublayers, KIND=wp )       &
3392                                  * d_z_p_z0
3393!
3394!--             Calculate LOG(z/z0) for exact particle height. Therefore,   
3395!--             interpolate linearly between precalculated logarithm.
3396                log_z_z0_int = log_z_z0(INT(height_p))                         &
3397                                 + ( height_p - INT(height_p) )                &
3398                                 * ( log_z_z0(INT(height_p)+1)                 &
3399                                      - log_z_z0(INT(height_p))                &
3400                                   ) 
3401!
3402!--             Get friction velocity and momentum flux from new surface data
3403!--             types.
3404                IF ( surf_def_h(0)%start_index(jp,ip) <=                   &
3405                     surf_def_h(0)%end_index(jp,ip) )  THEN
3406                   surf_start = surf_def_h(0)%start_index(jp,ip)
3407!--                Limit friction velocity. In narrow canyons or holes the
3408!--                friction velocity can become very small, resulting in a too
3409!--                large particle speed.
3410                   us_int    = MAX( surf_def_h(0)%us(surf_start), 0.01_wp ) 
3411                   vsws_int  = surf_def_h(0)%vsws(surf_start)
3412                ELSEIF ( surf_lsm_h%start_index(jp,ip) <=                  &
3413                         surf_lsm_h%end_index(jp,ip) )  THEN
3414                   surf_start = surf_lsm_h%start_index(jp,ip)
3415                   us_int    = MAX( surf_lsm_h%us(surf_start), 0.01_wp ) 
3416                   vsws_int  = surf_lsm_h%vsws(surf_start)
3417                ELSEIF ( surf_usm_h%start_index(jp,ip) <=                  &
3418                         surf_usm_h%end_index(jp,ip) )  THEN
3419                   surf_start = surf_usm_h%start_index(jp,ip)
3420                   us_int    = MAX( surf_usm_h%us(surf_start), 0.01_wp ) 
3421                   vsws_int  = surf_usm_h%vsws(surf_start)
3422                ENDIF
3423!
3424!--             Neutral solution is applied for all situations, e.g. also for
3425!--             unstable and stable situations. Even though this is not exact
3426!--             this saves a lot of CPU time since several calls of intrinsic
3427!--             FORTRAN procedures (LOG, ATAN) are avoided, This is justified
3428!--             as sensitivity studies revealed no significant effect of
3429!--             using the neutral solution also for un/stable situations.
3430                v_int(n) = -vsws_int / ( us_int * kappa + 1E-10_wp )           &
3431                         * log_z_z0_int - v_gtrans
3432
3433             ENDIF
3434
3435          ELSE
3436             = xv(n) + ( 0.5_wp - i ) * dx
3437             y  = yv(n) - j * dy
3438             aa = x**2          + y**2
3439             bb = ( dx - x )**2 + y**2
3440             cc = x**2          + ( dy - y )**2
3441             dd = ( dx - x )**2 + ( dy - y )**2
3442             gg = aa + bb + cc + dd
3443
3444             v_int_l = ( ( gg - aa ) * v(k,j,i)   + ( gg - bb ) * v(k,j,i+1)   &
3445                       + ( gg - cc ) * v(k,j+1,i) + ( gg - dd ) * v(k,j+1,i+1) &
3446                       ) / ( 3.0_wp * gg ) - v_gtrans
3447
3448             IF ( k == nzt )  THEN
3449                v_int(n) = v_int_l
3450             ELSE
3451                v_int_u = ( ( gg-aa ) * v(k+1,j,i)   + ( gg-bb ) * v(k+1,j,i+1)   &
3452                          + ( gg-cc ) * v(k+1,j+1,i) + ( gg-dd ) * v(k+1,j+1,i+1) &
3453                          ) / ( 3.0_wp * gg ) - v_gtrans
3454                v_int(n) = v_int_l + ( zv(n) - zu(k) ) / dzw(k+1) *               &
3455                                  ( v_int_u - v_int_l )
3456             ENDIF
3457
3458          ENDIF
3459
3460       ENDDO
3461!
3462!--    Same procedure for interpolation of the w velocity-component
3463       i = ip + block_offset(nb)%i_off
3464       j = jp + block_offset(nb)%j_off
3465       k = kp - 1
3466
3467       DO  n = start_index(nb), end_index(nb)
3468
3469          IF ( vertical_particle_advection(particles(n)%group) )  THEN
3470
3471             = xv(n) + ( 0.5_wp - i ) * dx
3472             y  = yv(n) + ( 0.5_wp - j ) * dy
3473             aa = x**2          + y**2
3474             bb = ( dx - x )**2 + y**2
3475             cc = x**2          + ( dy - y )**2
3476             dd = ( dx - x )**2 + ( dy - y )**2
3477             gg = aa + bb + cc + dd
3478
3479             w_int_l = ( ( gg - aa ) * w(k,j,i)   + ( gg - bb ) * w(k,j,i+1)   &
3480                       + ( gg - cc ) * w(k,j+1,i) + ( gg - dd ) * w(k,j+1,i+1) &
3481                       ) / ( 3.0_wp * gg )
3482
3483             IF ( k == nzt )  THEN
3484                w_int(n) = w_int_l
3485             ELSE
3486                w_int_u = ( ( gg-aa ) * w(k+1,j,i)   + &
3487                            ( gg-bb ) * w(k+1,j,i+1) + &
3488                            ( gg-cc ) * w(k+1,j+1,i) + &
3489                            ( gg-dd ) * w(k+1,j+1,i+1) &
3490                          ) / ( 3.0_wp * gg )
3491                w_int(n) = w_int_l + ( zv(n) - zw(k) ) / dzw(k+1) *               &
3492                           ( w_int_u - w_int_l )
3493             ENDIF
3494
3495          ELSE
3496
3497             w_int(n) = 0.0_wp
3498
3499          ENDIF
3500
3501       ENDDO
3502
3503    ENDDO
3504
3505!-- Interpolate and calculate quantities needed for calculating the SGS
3506!-- velocities
3507    IF ( use_sgs_for_particles  .AND.  .NOT. cloud_droplets )  THEN
3508
3509       DO  nb = 0,7
3510
3511          subbox_at_wall = .FALSE.
3512!
3513!--       In case of topography check if subbox is adjacent to a wall
3514          IF ( .NOT. topography == 'flat' ) THEN
3515             i = ip + MERGE( -1_iwp , 1_iwp, BTEST( nb, 2 ) )
3516             j = jp + MERGE( -1_iwp , 1_iwp, BTEST( nb, 1 ) )
3517             k = kp + MERGE( -1_iwp , 1_iwp, BTEST( nb, 0 ) )
3518             IF ( .NOT. BTEST(wall_flags_0(k,  jp, ip), 0) .OR.                &
3519                  .NOT. BTEST(wall_flags_0(kp, j,  ip), 0) .OR.                &
3520                  .NOT. BTEST(wall_flags_0(kp, jp, i ), 0) )                   &
3521             THEN
3522                subbox_at_wall = .TRUE.
3523             ENDIF
3524          ENDIF
3525          IF ( subbox_at_wall ) THEN
3526             e_int(start_index(nb):end_index(nb))     = e(kp,jp,ip) 
3527             diss_int(start_index(nb):end_index(nb))  = diss(kp,jp,ip)
3528             de_dx_int(start_index(nb):end_index(nb)) = de_dx(kp,jp,ip)
3529             de_dy_int(start_index(nb):end_index(nb)) = de_dy(kp,jp,ip)
3530             de_dz_int(start_index(nb):end_index(nb)) = de_dz(kp,jp,ip)
3531!
3532!--          Set flag for stochastic equation.
3533             term_1_2(start_index(nb):end_index(nb)) = 0.0_wp
3534          ELSE
3535             i = ip + block_offset(nb)%i_off
3536             j = jp + block_offset(nb)%j_off
3537             k = kp + block_offset(nb)%k_off
3538
3539             DO  n = start_index(nb), end_index(nb)
3540!
3541!--             Interpolate TKE
3542                x  = xv(n) + ( 0.5_wp - i ) * dx
3543                y  = yv(n) + ( 0.5_wp - j ) * dy
3544                aa = x**2          + y**2
3545                bb = ( dx - x )**2 + y**2
3546                cc = x**2          + ( dy - y )**2
3547                dd = ( dx - x )**2 + ( dy - y )**2
3548                gg = aa + bb + cc + dd
3549
3550                e_int_l = ( ( gg-aa ) * e(k,j,i)   + ( gg-bb ) * e(k,j,i+1)   &
3551                          + ( gg-cc ) * e(k,j+1,i) + ( gg-dd ) * e(k,j+1,i+1) &
3552                          ) / ( 3.0_wp * gg )
3553
3554                IF ( k+1 == nzt+1 )  THEN
3555                   e_int(n) = e_int_l
3556                ELSE
3557                   e_int_u = ( ( gg - aa ) * e(k+1,j,i)   + &
3558                               ( gg - bb ) * e(k+1,j,i+1) + &
3559                               ( gg - cc ) * e(k+1,j+1,i) + &
3560                               ( gg - dd ) * e(k+1,j+1,i+1) &
3561                            ) / ( 3.0_wp * gg )
3562                   e_int(n) = e_int_l + ( zv(n) - zu(k) ) / dzw(k+1) *            &
3563                                     ( e_int_u - e_int_l )
3564                ENDIF
3565!
3566!--             Needed to avoid NaN particle velocities (this might not be
3567!--             required any more)
3568                IF ( e_int(n) <= 0.0_wp )  THEN
3569                   e_int(n) = 1.0E-20_wp
3570                ENDIF
3571!
3572!--             Interpolate the TKE gradient along x (adopt incides i,j,k and
3573!--             all position variables from above (TKE))
3574                de_dx_int_l = ( ( gg - aa ) * de_dx(k,j,i)   + &
3575                                ( gg - bb ) * de_dx(k,j,i+1) + &
3576                                ( gg - cc ) * de_dx(k,j+1,i) + &
3577                                ( gg - dd ) * de_dx(k,j+1,i+1) &
3578                               ) / ( 3.0_wp * gg )
3579
3580                IF ( ( k+1 == nzt+1 )  .OR.  ( k == nzb ) )  THEN
3581                   de_dx_int(n) = de_dx_int_l
3582                ELSE
3583                   de_dx_int_u = ( ( gg - aa ) * de_dx(k+1,j,i)   + &
3584                                   ( gg - bb ) * de_dx(k+1,j,i+1) + &
3585                                   ( gg - cc ) * de_dx(k+1,j+1,i) + &
3586                                   ( gg - dd ) * de_dx(k+1,j+1,i+1) &
3587                                  ) / ( 3.0_wp * gg )
3588                   de_dx_int(n) = de_dx_int_l + ( zv(n) - zu(k) ) / dzw(k+1) *    &
3589                                              ( de_dx_int_u - de_dx_int_l )
3590                ENDIF
3591!
3592!--             Interpolate the TKE gradient along y
3593                de_dy_int_l = ( ( gg - aa ) * de_dy(k,j,i)   + &
3594                                ( gg - bb ) * de_dy(k,j,i+1) + &
3595                                ( gg - cc ) * de_dy(k,j+1,i) + &
3596                                ( gg - dd ) * de_dy(k,j+1,i+1) &
3597                               ) / ( 3.0_wp * gg )
3598                IF ( ( k+1 == nzt+1 )  .OR.  ( k == nzb ) )  THEN
3599                   de_dy_int(n) = de_dy_int_l
3600                ELSE
3601                   de_dy_int_u = ( ( gg - aa ) * de_dy(k+1,j,i)   + &
3602                                   ( gg - bb ) * de_dy(k+1,j,i+1) + &
3603                                   ( gg - cc ) * de_dy(k+1,j+1,i) + &
3604                                   ( gg - dd ) * de_dy(k+1,j+1,i+1) &
3605                                  ) / ( 3.0_wp * gg )
3606                      de_dy_int(n) = de_dy_int_l + ( zv(n) - zu(k) ) / dzw(k+1) * &
3607                                                 ( de_dy_int_u - de_dy_int_l )
3608                ENDIF
3609
3610!
3611!--             Interpolate the TKE gradient along z
3612                IF ( zv(n) < 0.5_wp * dz(1) )  THEN
3613                   de_dz_int(n) = 0.0_wp
3614                ELSE
3615                   de_dz_int_l = ( ( gg - aa ) * de_dz(k,j,i)   + &
3616                                   ( gg - bb ) * de_dz(k,j,i+1) + &
3617                                   ( gg - cc ) * de_dz(k,j+1,i) + &
3618                                   ( gg - dd ) * de_dz(k,j+1,i+1) &
3619                                  ) / ( 3.0_wp * gg )
3620
3621                   IF ( ( k+1 == nzt+1 )  .OR.  ( k == nzb ) )  THEN
3622                      de_dz_int(n) = de_dz_int_l
3623                   ELSE
3624                      de_dz_int_u = ( ( gg - aa ) * de_dz(k+1,j,i)   + &
3625                                      ( gg - bb ) * de_dz(k+1,j,i+1) + &
3626                                      ( gg - cc ) * de_dz(k+1,j+1,i) + &
3627                                      ( gg - dd ) * de_dz(k+1,j+1,i+1) &
3628                                     ) / ( 3.0_wp * gg )
3629                      de_dz_int(n) = de_dz_int_l + ( zv(n) - zu(k) ) / dzw(k+1) * &
3630                                                 ( de_dz_int_u - de_dz_int_l )
3631                   ENDIF
3632                ENDIF
3633
3634!
3635!--             Interpolate the dissipation of TKE
3636                diss_int_l = ( ( gg - aa ) * diss(k,j,i)   + &
3637                               ( gg - bb ) * diss(k,j,i+1) + &
3638                               ( gg - cc ) * diss(k,j+1,i) + &
3639                               ( gg - dd ) * diss(k,j+1,i+1) &
3640                               ) / ( 3.0_wp * gg )
3641
3642                IF ( k == nzt )  THEN
3643                   diss_int(n) = diss_int_l
3644                ELSE
3645                   diss_int_u = ( ( gg - aa ) * diss(k+1,j,i)   + &
3646                                  ( gg - bb ) * diss(k+1,j,i+1) + &
3647                                  ( gg - cc ) * diss(k+1,j+1,i) + &
3648                                  ( gg - dd ) * diss(k+1,j+1,i+1) &
3649                                 ) / ( 3.0_wp * gg )
3650                   diss_int(n) = diss_int_l + ( zv(n) - zu(k) ) / dzw(k+1) *      &
3651                                            ( diss_int_u - diss_int_l )
3652                ENDIF
3653
3654!
3655!--             Set flag for stochastic equation.
3656                term_1_2(n) = 1.0_wp
3657             ENDDO
3658          ENDIF
3659       ENDDO
3660
3661       DO nb = 0,7
3662          i = ip + block_offset(nb)%i_off
3663          j = jp + block_offset(nb)%j_off
3664          k = kp + block_offset(nb)%k_off
3665
3666          DO  n = start_index(nb), end_index(nb)
3667!
3668!--          Vertical interpolation of the horizontally averaged SGS TKE and
3669!--          resolved-scale velocity variances and use the interpolated values
3670!--          to calculate the coefficient fs, which is a measure of the ratio
3671!--          of the subgrid-scale turbulent kinetic energy to the total amount
3672!--          of turbulent kinetic energy.
3673             IF ( k == 0 )  THEN
3674                e_mean_int = hom(0,1,8,0)
3675             ELSE
3676                e_mean_int = hom(k,1,8,0) +                                    &
3677                                           ( hom(k+1,1,8,0) - hom(k,1,8,0) ) / &
3678                                           ( zu(k+1) - zu(k) ) *               &
3679                                           ( zv(n) - zu(k) )
3680             ENDIF
3681
3682             kw = kp - 1
3683
3684             IF ( k == 0 )  THEN
3685                aa  = hom(k+1,1,30,0)  * ( zv(n) / &
3686                                         ( 0.5_wp * ( zu(k+1) - zu(k) ) ) )
3687                bb  = hom(k+1,1,31,0)  * ( zv(n) / &
3688                                         ( 0.5_wp * ( zu(k+1) - zu(k) ) ) )
3689                cc  = hom(kw+1,1,32,0) * ( zv(n) / &
3690                                         ( 1.0_wp * ( zw(kw+1) - zw(kw) ) ) )
3691             ELSE
3692                aa  = hom(k,1,30,0) + ( hom(k+1,1,30,0) - hom(k,1,30,0) ) *    &
3693                           ( ( zv(n) - zu(k) ) / ( zu(k+1) - zu(k) ) )
3694                bb  = hom(k,1,31,0) + ( hom(k+1,1,31,0) - hom(k,1,31,0) ) *    &
3695                           ( ( zv(n) - zu(k) ) / ( zu(k+1) - zu(k) ) )
3696                cc  = hom(kw,1,32,0) + ( hom(kw+1,1,32,0)-hom(kw,1,32,0) ) *   &
3697                           ( ( zv(n) - zw(kw) ) / ( zw(kw+1)-zw(kw) ) )
3698             ENDIF
3699
3700             vv_int = ( 1.0_wp / 3.0_wp ) * ( aa + bb + cc )
3701!
3702!--          Needed to avoid NaN particle velocities. The value of 1.0 is just
3703!--          an educated guess for the given case.
3704             IF ( vv_int + ( 2.0_wp / 3.0_wp ) * e_mean_int == 0.0_wp )  THEN
3705                fs_int(n) = 1.0_wp
3706             ELSE
3707                fs_int(n) = ( 2.0_wp / 3.0_wp ) * e_mean_int /                 &
3708                            ( vv_int + ( 2.0_wp / 3.0_wp ) * e_mean_int )
3709             ENDIF
3710
3711          ENDDO
3712       ENDDO
3713
3714       DO  nb = 0, 7
3715          DO  n = start_index(nb), end_index(nb)
3716             rg(n,1) = random_gauss( iran_part, 5.0_wp )
3717             rg(n,2) = random_gauss( iran_part, 5.0_wp )
3718             rg(n,3) = random_gauss( iran_part, 5.0_wp )
3719          ENDDO
3720       ENDDO
3721
3722       DO  nb = 0, 7
3723          DO  n = start_index(nb), end_index(nb)
3724
3725!
3726!--          Calculate the Lagrangian timescale according to Weil et al. (2004).
3727             lagr_timescale(n) = ( 4.0_wp * e_int(n) + 1E-20_wp ) / &
3728                              ( 3.0_wp * fs_int(n) * c_0 * diss_int(n) + 1E-20_wp )
3729
3730!
3731!--          Calculate the next particle timestep. dt_gap is the time needed to
3732!--          complete the current LES timestep.
3733             dt_gap(n) = dt_3d - particles(n)%dt_sum
3734             dt_particle(n) = MIN( dt_3d, 0.025_wp * lagr_timescale(n), dt_gap(n) )
3735             particles(n)%aux1 = lagr_timescale(n)
3736             particles(n)%aux2 = dt_gap(n)
3737!
3738!--          The particle timestep should not be too small in order to prevent
3739!--          the number of particle timesteps of getting too large
3740             IF ( dt_particle(n) < dt_min_part  .AND.  dt_min_part < dt_gap(n) )  THEN
3741                dt_particle(n) = dt_min_part
3742             ENDIF
3743             rvar1_temp(n) = particles(n)%rvar1
3744             rvar2_temp(n) = particles(n)%rvar2
3745             rvar3_temp(n) = particles(n)%rvar3
3746!
3747!--          Calculate the SGS velocity components
3748             IF ( particles(n)%age == 0.0_wp )  THEN
3749!
3750!--             For new particles the SGS components are derived from the SGS
3751!--             TKE. Limit the Gaussian random number to the interval
3752!--             [-5.0*sigma, 5.0*sigma] in order to prevent the SGS velocities
3753!--             from becoming unrealistically large.
3754                rvar1_temp(n) = SQRT( 2.0_wp * sgs_wf_part * e_int(n)          &
3755                                          + 1E-20_wp ) * ( rg(n,1) - 1.0_wp )
3756                rvar2_temp(n) = SQRT( 2.0_wp * sgs_wf_part * e_int(n)          &
3757                                          + 1E-20_wp ) * ( rg(n,2) - 1.0_wp )
3758                rvar3_temp(n) = SQRT( 2.0_wp * sgs_wf_part * e_int(n)          &
3759                                          + 1E-20_wp ) * ( rg(n,3) - 1.0_wp )
3760
3761             ELSE
3762!
3763!--             Restriction of the size of the new timestep: compared to the
3764!--             previous timestep the increase must not exceed 200%. First,
3765!--             check if age > age_m, in order to prevent that particles get zero
3766!--             timestep.
3767                dt_particle_m = MERGE( dt_particle(n),                         &
3768                                       particles(n)%age - particles(n)%age_m,  &
3769                                       particles(n)%age - particles(n)%age_m < &
3770                                       1E-8_wp )
3771                IF ( dt_particle(n) > 2.0_wp * dt_particle_m )  THEN
3772                   dt_particle(n) = 2.0_wp * dt_particle_m
3773                ENDIF
3774
3775!--             For old particles the SGS components are correlated with the
3776!--             values from the previous timestep. Random numbers have also to
3777!--             be limited (see above).
3778!--             As negative values for the subgrid TKE are not allowed, the
3779!--             change of the subgrid TKE with time cannot be smaller than
3780!--             -e_int(n)/dt_particle. This value is used as a lower boundary
3781!--             value for the change of TKE
3782                de_dt_min = - e_int(n) / dt_particle(n)
3783
3784                de_dt = ( e_int(n) - particles(n)%e_m ) / dt_particle_m
3785
3786                IF ( de_dt < de_dt_min )  THEN
3787                   de_dt = de_dt_min
3788                ENDIF
3789
3790                CALL weil_stochastic_eq(rvar1_temp(n), fs_int(n), e_int(n),& 
3791                                        de_dx_int(n), de_dt, diss_int(n),       &
3792                                        dt_particle(n), rg(n,1), term_1_2(n) )
3793
3794                CALL weil_stochastic_eq(rvar2_temp(n), fs_int(n), e_int(n),& 
3795                                        de_dy_int(n), de_dt, diss_int(n),       &
3796                                        dt_particle(n), rg(n,2), term_1_2(n) )
3797
3798                CALL weil_stochastic_eq(rvar3_temp(n), fs_int(n), e_int(n),& 
3799                                        de_dz_int(n), de_dt, diss_int(n),       &
3800                                        dt_particle(n), rg(n,3), term_1_2(n) )
3801
3802             ENDIF
3803
3804          ENDDO
3805       ENDDO
3806!
3807!--    Check if the added SGS velocities result in a violation of the CFL-
3808!--    criterion. If yes choose a smaller timestep based on the new velocities
3809!--    and calculate SGS velocities again
3810       dz_temp = zw(kp)-zw(kp-1)
3811       
3812       DO  nb = 0, 7
3813          DO  n = start_index(nb), end_index(nb)
3814             IF ( .NOT. particles(n)%age == 0.0_wp .AND.                       &
3815                (ABS( u_int(n) + rvar1_temp(n) ) > (dx/dt_particle(n))  .OR.   &
3816                 ABS( v_int(n) + rvar2_temp(n) ) > (dy/dt_particle(n))  .OR.   &
3817                 ABS( w_int(n) + rvar3_temp(n) ) > (dz_temp/dt_particle(n)))) THEN
3818               
3819                dt_particle(n) = 0.9_wp * MIN(                                 &
3820                                 ( dx / ABS( u_int(n) + rvar1_temp(n) ) ),     &
3821                                 ( dy / ABS( v_int(n) + rvar2_temp(n) ) ),     &
3822                                 ( dz_temp / ABS( w_int(n) + rvar3_temp(n) ) ) )
3823
3824!
3825!--             Reset temporary SGS velocites to "current" ones
3826                rvar1_temp(n) = particles(n)%rvar1
3827                rvar2_temp(n) = particles(n)%rvar2
3828                rvar3_temp(n) = particles(n)%rvar3
3829               
3830                de_dt_min = - e_int(n) / dt_particle(n)
3831
3832                de_dt = ( e_int(n) - particles(n)%e_m ) / dt_particle_m
3833
3834                IF ( de_dt < de_dt_min )  THEN
3835                   de_dt = de_dt_min
3836                ENDIF
3837
3838                CALL weil_stochastic_eq(rvar1_temp(n), fs_int(n), e_int(n),& 
3839                                        de_dx_int(n), de_dt, diss_int(n),       &
3840                                        dt_particle(n), rg(n,1), term_1_2(n) )
3841
3842                CALL weil_stochastic_eq(rvar2_temp(n), fs_int(n), e_int(n),& 
3843                                        de_dy_int(n), de_dt, diss_int(n),       &
3844                                        dt_particle(n), rg(n,2), term_1_2(n) )
3845
3846                CALL weil_stochastic_eq(rvar3_temp(n), fs_int(n), e_int(n),& 
3847                                        de_dz_int(n), de_dt, diss_int(n),       &
3848                                        dt_particle(n), rg(n,3), term_1_2(n) )
3849             ENDIF                           
3850             
3851!
3852!--          Update particle velocites
3853             particles(n)%rvar1 = rvar1_temp(n)
3854             particles(n)%rvar2 = rvar2_temp(n)
3855             particles(n)%rvar3 = rvar3_temp(n)
3856             u_int(n) = u_int(n) + particles(n)%rvar1
3857             v_int(n) = v_int(n) + particles(n)%rvar2
3858             w_int(n) = w_int(n) + particles(n)%rvar3
3859!
3860!--          Store the SGS TKE of the current timelevel which is needed for
3861!--          for calculating the SGS particle velocities at the next timestep
3862             particles(n)%e_m = e_int(n)
3863          ENDDO
3864       ENDDO
3865       
3866    ELSE
3867!
3868!--    If no SGS velocities are used, only the particle timestep has to
3869!--    be set
3870       dt_particle = dt_3d
3871
3872    ENDIF
3873
3874    dens_ratio = particle_groups(particles(1:number_of_particles)%group)%density_ratio
3875
3876    IF ( ANY( dens_ratio == 0.0_wp ) )  THEN
3877       DO  nb = 0, 7
3878          DO  n = start_index(nb), end_index(nb)
3879
3880!
3881!--          Particle advection
3882             IF ( dens_ratio(n) == 0.0_wp )  THEN
3883!
3884!--             Pure passive transport (without particle inertia)
3885                particles(n)%x = xv(n) + u_int(n) * dt_particle(n)
3886                particles(n)%y = yv(n) + v_int(n) * dt_particle(n)
3887                particles(n)%z = zv(n) + w_int(n) * dt_particle(n)
3888
3889                particles(n)%speed_x = u_int(n)
3890                particles(n)%speed_y = v_int(n)
3891                particles(n)%speed_z = w_int(n)
3892
3893             ELSE
3894!
3895!--             Transport of particles with inertia
3896                particles(n)%x = particles(n)%x + particles(n)%speed_x * &
3897                                                  dt_particle(n)
3898                particles(n)%y = particles(n)%y + particles(n)%speed_y * &
3899                                                  dt_particle(n)
3900                particles(n)%z = particles(n)%z + particles(n)%speed_z * &
3901                                                  dt_particle(n)
3902
3903!
3904!--             Update of the particle velocity
3905                IF ( cloud_droplets )  THEN
3906!
3907!--                Terminal velocity is computed for vertical direction (Rogers et
3908!--                al., 1993, J. Appl. Meteorol.)
3909                   diameter = particles(n)%radius * 2000.0_wp !diameter in mm
3910                   IF ( diameter <= d0_rog )  THEN
3911                      w_s = k_cap_rog * diameter * ( 1.0_wp - EXP( -k_low_rog * diameter ) )
3912                   ELSE
3913                      w_s = a_rog - b_rog * EXP( -c_rog * diameter )
3914                   ENDIF
3915
3916!
3917!--                If selected, add random velocities following Soelch and Kaercher
3918!--                (2010, Q. J. R. Meteorol. Soc.)
3919                   IF ( use_sgs_for_particles )  THEN
3920                      lagr_timescale(n) = km(kp,jp,ip) / MAX( e(kp,jp,ip), 1.0E-20_wp )
3921                      RL             = EXP( -1.0_wp * dt_3d / MAX( lagr_timescale(n), &
3922                                             1.0E-20_wp ) )
3923                      sigma          = SQRT( e(kp,jp,ip) )
3924
3925                      rg1 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
3926                      rg2 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
3927                      rg3 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
3928
3929                      particles(n)%rvar1 = RL * particles(n)%rvar1 +              &
3930                                           SQRT( 1.0_wp - RL**2 ) * sigma * rg1
3931                      particles(n)%rvar2 = RL * particles(n)%rvar2 +              &
3932                                           SQRT( 1.0_wp - RL**2 ) * sigma * rg2
3933                      particles(n)%rvar3 = RL * particles(n)%rvar3 +              &
3934                                           SQRT( 1.0_wp - RL**2 ) * sigma * rg3
3935
3936                      particles(n)%speed_x = u_int(n) + particles(n)%rvar1
3937                      particles(n)%speed_y = v_int(n) + particles(n)%rvar2
3938                      particles(n)%speed_z = w_int(n) + particles(n)%rvar3 - w_s
3939                   ELSE
3940                      particles(n)%speed_x = u_int(n)
3941                      particles(n)%speed_y = v_int(n)
3942                      particles(n)%speed_z = w_int(n) - w_s
3943                   ENDIF
3944
3945                ELSE
3946
3947                   IF ( use_sgs_for_particles )  THEN
3948                      exp_arg  = particle_groups(particles(n)%group)%exp_arg
3949                      exp_term = EXP( -exp_arg * dt_particle(n) )
3950                   ELSE
3951                      exp_arg  = particle_groups(particles(n)%group)%exp_arg
3952                      exp_term = particle_groups(particles(n)%group)%exp_term
3953                   ENDIF
3954                   particles(n)%speed_x = particles(n)%speed_x * exp_term +         &
3955                                          u_int(n) * ( 1.0_wp - exp_term )
3956                   particles(n)%speed_y = particles(n)%speed_y * exp_term +         &
3957                                          v_int(n) * ( 1.0_wp - exp_term )
3958                   particles(n)%speed_z = particles(n)%speed_z * exp_term +         &
3959                                          ( w_int(n) - ( 1.0_wp - dens_ratio(n) ) * &
3960                                          g / exp_arg ) * ( 1.0_wp - exp_term )
3961                ENDIF
3962
3963             ENDIF
3964          ENDDO
3965       ENDDO
3966   
3967    ELSE
3968
3969       DO  nb = 0, 7
3970          DO  n = start_index(nb), end_index(nb)
3971!
3972!--          Transport of particles with inertia
3973             particles(n)%x = xv(n) + particles(n)%speed_x * dt_particle(n)
3974             particles(n)%y = yv(n) + particles(n)%speed_y * dt_particle(n)
3975             particles(n)%z = zv(n) + particles(n)%speed_z * dt_particle(n)
3976!
3977!--          Update of the particle velocity
3978             IF ( cloud_droplets )  THEN
3979!
3980!--             Terminal velocity is computed for vertical direction (Rogers et al.,
3981!--             1993, J. Appl. Meteorol.)
3982                diameter = particles(n)%radius * 2000.0_wp !diameter in mm
3983                IF ( diameter <= d0_rog )  THEN
3984                   w_s = k_cap_rog * diameter * ( 1.0_wp - EXP( -k_low_rog * diameter ) )
3985                ELSE
3986                   w_s = a_rog - b_rog * EXP( -c_rog * diameter )
3987                ENDIF
3988
3989!
3990!--             If selected, add random velocities following Soelch and Kaercher
3991!--             (2010, Q. J. R. Meteorol. Soc.)
3992                IF ( use_sgs_for_particles )  THEN
3993                    lagr_timescale(n) = km(kp,jp,ip) / MAX( e(kp,jp,ip), 1.0E-20_wp )
3994                     RL             = EXP( -1.0_wp * dt_3d / MAX( lagr_timescale(n), &
3995                                             1.0E-20_wp ) )
3996                    sigma          = SQRT( e(kp,jp,ip) )
3997
3998                    rg1 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
3999                    rg2 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
4000                    rg3 = random_gauss( iran_part, 5.0_wp ) - 1.0_wp
4001
4002                    particles(n)%rvar1 = RL * particles(n)%rvar1 +                &
4003                                         SQRT( 1.0_wp - RL**2 ) * sigma * rg1
4004                    particles(n)%rvar2 = RL * particles(n)%rvar2 +                &
4005                                         SQRT( 1.0_wp - RL**2 ) * sigma * rg2
4006                    particles(n)%rvar3 = RL * particles(n)%rvar3 +                &
4007                                         SQRT( 1.0_wp - RL**2 ) * sigma * rg3
4008
4009                    particles(n)%speed_x = u_int(n) + particles(n)%rvar1
4010                    particles(n)%speed_y = v_int(n) + particles(n)%rvar2
4011                    particles(n)%speed_z = w_int(n) + particles(n)%rvar3 - w_s
4012                ELSE
4013                    particles(n)%speed_x = u_int(n)
4014                    particles(n)%speed_y = v_int(n)
4015                    particles(n)%speed_z = w_int(n) - w_s
4016                ENDIF
4017
4018             ELSE
4019
4020                IF ( use_sgs_for_particles )  THEN
4021                   exp_arg  = particle_groups(particles(n)%group)%exp_arg
4022                   exp_term = EXP( -exp_arg * dt_particle(n) )
4023                ELSE
4024                   exp_arg  = particle_groups(particles(n)%group)%exp_arg
4025                   exp_term = particle_groups(particles(n)%group)%exp_term
4026                ENDIF
4027                particles(n)%speed_x = particles(n)%speed_x * exp_term +             &
4028                                       u_int(n) * ( 1.0_wp - exp_term )
4029                particles(n)%speed_y = particles(n)%speed_y * exp_term +             &
4030                                       v_int(n) * ( 1.0_wp - exp_term )
4031                particles(n)%speed_z = particles(n)%speed_z * exp_term +             &
4032                                       ( w_int(n) - ( 1.0_wp - dens_ratio(n) ) * g / &
4033                                       exp_arg ) * ( 1.0_wp - exp_term )
4034             ENDIF
4035          ENDDO
4036       ENDDO
4037
4038    ENDIF
4039
4040!
4041!-- Store the old age of the particle ( needed to prevent that a
4042!-- particle crosses several PEs during one timestep, and for the
4043!-- evaluation of the subgrid particle velocity fluctuations )
4044    particles(1:number_of_particles)%age_m = particles(1:number_of_particles)%age
4045
4046    DO  nb = 0, 7
4047       DO  n = start_index(nb), end_index(nb)
4048!
4049!--       Increment the particle age and the total time that the particle
4050!--       has advanced within the particle timestep procedure
4051          particles(n)%age    = particles(n)%age    + dt_particle(n)
4052          particles(n)%dt_sum = particles(n)%dt_sum + dt_particle(n)
4053
4054!
4055!--       Check whether there is still a particle that has not yet completed
4056!--       the total LES timestep
4057          IF ( ( dt_3d - particles(n)%dt_sum ) > 1E-8_wp )  THEN
4058             dt_3d_reached_l = .FALSE.
4059          ENDIF
4060
4061       ENDDO
4062    ENDDO
4063
4064    CALL cpu_log( log_point_s(44), 'lpm_advec', 'pause' )
4065
4066
4067 END SUBROUTINE lpm_advec
4068
4069 
4070!------------------------------------------------------------------------------! 
4071! Description:
4072! ------------
4073!> Calculation of subgrid-scale particle speed using the stochastic model
4074!> of Weil et al. (2004, JAS, 61, 2877-2887).
4075!------------------------------------------------------------------------------!
4076 SUBROUTINE weil_stochastic_eq( v_sgs, fs_n, e_n, dedxi_n, dedt_n, diss_n,     &
4077                                dt_n, rg_n, fac )
4078                               
4079    REAL(wp) ::  a1      !< dummy argument
4080    REAL(wp) ::  dedt_n  !< time derivative of TKE at particle position
4081    REAL(wp) ::  dedxi_n !< horizontal derivative of TKE at particle position
4082    REAL(wp) ::  diss_n  !< dissipation at particle position
4083    REAL(wp) ::  dt_n    !< particle timestep
4084    REAL(wp) ::  e_n     !< TKE at particle position
4085    REAL(wp) ::  fac     !< flag to identify adjacent topography
4086    REAL(wp) ::  fs_n    !< weighting factor to prevent that subgrid-scale particle speed becomes too large
4087    REAL(wp) ::  rg_n    !< random number
4088    REAL(wp) ::  term1   !< memory term
4089    REAL(wp) ::  term2   !< drift correction term
4090    REAL(wp) ::  term3   !< random term
4091    REAL(wp) ::  v_sgs   !< subgrid-scale velocity component
4092
4093!-- At first, limit TKE to a small non-zero number, in order to prevent
4094!-- the occurrence of extremely large SGS-velocities in case TKE is zero,
4095!-- (could occur at the simulation begin).
4096    e_n = MAX( e_n, 1E-20_wp )
4097!
4098!-- Please note, terms 1 and 2 (drift and memory term, respectively) are
4099!-- multiplied by a flag to switch of both terms near topography.
4100!-- This is necessary, as both terms may cause a subgrid-scale velocity build up
4101!-- if particles are trapped in regions with very small TKE, e.g. in narrow street
4102!-- canyons resolved by only a few grid points. Hence, term 1 and term 2 are
4103!-- disabled if one of the adjacent grid points belongs to topography.
4104!-- Moreover, in this case, the  previous subgrid-scale component is also set
4105!-- to zero.
4106
4107    a1 = fs_n * c_0 * diss_n
4108!
4109!-- Memory term
4110    term1 = - a1 * v_sgs * dt_n / ( 4.0_wp * sgs_wf_part * e_n + 1E-20_wp )    &
4111                 * fac
4112!
4113!-- Drift correction term
4114    term2 = ( ( dedt_n * v_sgs / e_n ) + dedxi_n ) * 0.5_wp * dt_n              &
4115                 * fac
4116!
4117!-- Random term
4118    term3 = SQRT( MAX( a1, 1E-20_wp ) ) * ( rg_n - 1.0_wp ) * SQRT( dt_n )
4119!
4120!-- In cese one of the adjacent grid-boxes belongs to topograhy, the previous
4121!-- subgrid-scale velocity component is set to zero, in order to prevent a
4122!-- velocity build-up.
4123!-- This case, set also previous subgrid-scale component to zero.
4124    v_sgs = v_sgs * fac + term1 + term2 + term3
4125
4126 END SUBROUTINE weil_stochastic_eq
4127 
4128 
4129!------------------------------------------------------------------------------! 
4130! Description:
4131! ------------
4132!> Boundary conditions for the Lagrangian particles.
4133!> The routine consists of two different parts. One handles the bottom (flat)
4134!> and top boundary. In this part, also particles which exceeded their lifetime
4135!> are deleted.
4136!> The other part handles the reflection of particles from vertical walls.
4137!> This part was developed by Jin Zhang during 2006-2007.
4138!>
4139!> To do: Code structure for finding the t_index values and for checking the
4140!> -----  reflection conditions is basically the same for all four cases, so it
4141!>        should be possible to further simplify/shorten it.
4142!>
4143!> THE WALLS PART OF THIS ROUTINE HAS NOT BEEN TESTED FOR OCEAN RUNS SO FAR!!!!
4144!> (see offset_ocean_*)
4145!------------------------------------------------------------------------------!
4146 SUBROUTINE lpm_boundary_conds( location_bc , i, j, k )
4147
4148    CHARACTER (LEN=*), INTENT(IN) ::  location_bc !< general mode: boundary conditions at bottom/top of the model domain
4149                                   !< or at vertical surfaces (buildings, terrain steps)   
4150    INTEGER(iwp), INTENT(IN) ::  i !< grid index of particle box along x
4151    INTEGER(iwp), INTENT(IN) ::  j !< grid index of particle box along y
4152    INTEGER(iwp), INTENT(IN) ::  k !< grid index of particle box along z
4153   
4154    INTEGER(iwp) ::  inc            !< dummy for sorting algorithmus
4155    INTEGER(iwp) ::  ir             !< dummy for sorting algorithmus
4156    INTEGER(iwp) ::  i1             !< grid index (x) of old particle position
4157    INTEGER(iwp) ::  i2             !< grid index (x) of current particle position
4158    INTEGER(iwp) ::  i3             !< grid index (x) of intermediate particle position
4159    INTEGER(iwp) ::  jr             !< dummy for sorting algorithmus
4160    INTEGER(iwp) ::  j1             !< grid index (y) of old particle position
4161    INTEGER(iwp) ::  j2             !< grid index (y) of current particle position
4162    INTEGER(iwp) ::  j3             !< grid index (y) of intermediate particle position
4163    INTEGER(iwp) ::  k1             !< grid index (z) of old particle position
4164    INTEGER(iwp) ::  k2             !< grid index (z) of current particle position
4165    INTEGER(iwp) ::  k3             !< grid index (z) of intermediate particle position
4166    INTEGER(iwp) ::  n              !< particle number
4167    INTEGER(iwp) ::  t_index        !< running index for intermediate particle timesteps in reflection algorithmus
4168    INTEGER(iwp) ::  t_index_number !< number of intermediate particle timesteps in reflection algorithmus
4169    INTEGER(iwp) ::  tmp_x          !< dummy for sorting algorithm
4170    INTEGER(iwp) ::  tmp_y          !< dummy for sorting algorithm
4171    INTEGER(iwp) ::  tmp_z          !< dummy for sorting algorithm
4172
4173    INTEGER(iwp), DIMENSION(0:10) :: x_ind(0:10) = 0 !< index array (x) of intermediate particle positions
4174    INTEGER(iwp), DIMENSION(0:10) :: y_ind(0:10) = 0 !< index array (y) of intermediate particle positions
4175    INTEGER(iwp), DIMENSION(0:10) :: z_ind(0:10) = 0 !< index array (z) of intermediate particle positions
4176   
4177    LOGICAL  ::  cross_wall_x    !< flag to check if particle reflection along x is necessary
4178    LOGICAL  ::  cross_wall_y    !< flag to check if particle reflection along y is necessary
4179    LOGICAL  ::  cross_wall_z    !< flag to check if particle reflection along z is necessary
4180    LOGICAL  ::  reflect_x       !< flag to check if particle is already reflected along x
4181    LOGICAL  ::  reflect_y       !< flag to check if particle is already reflected along y
4182    LOGICAL  ::  reflect_z       !< flag to check if particle is already reflected along z
4183    LOGICAL  ::  tmp_reach_x     !< dummy for sorting algorithmus
4184    LOGICAL  ::  tmp_reach_y     !< dummy for sorting algorithmus
4185    LOGICAL  ::  tmp_reach_z     !< dummy for sorting algorithmus
4186    LOGICAL  ::  x_wall_reached  !< flag to check if particle has already reached wall
4187    LOGICAL  ::  y_wall_reached  !< flag to check if particle has already reached wall
4188    LOGICAL  ::  z_wall_reached  !< flag to check if particle has already reached wall
4189
4190    LOGICAL, DIMENSION(0:10) ::  reach_x  !< flag to check if particle is at a yz-wall
4191    LOGICAL, DIMENSION(0:10) ::  reach_y  !< flag to check if particle is at a xz-wall
4192    LOGICAL, DIMENSION(0:10) ::  reach_z  !< flag to check if particle is at a xy-wall
4193
4194    REAL(wp) ::  dt_particle    !< particle timestep
4195    REAL(wp) ::  eps = 1E-10_wp !< security number to check if particle has reached a wall
4196    REAL(wp) ::  pos_x          !< intermediate particle position (x)
4197    REAL(wp) ::  pos_x_old      !< particle position (x) at previous particle timestep
4198    REAL(wp) ::  pos_y          !< intermediate particle position (y)
4199    REAL(wp) ::  pos_y_old      !< particle position (y) at previous particle timestep
4200    REAL(wp) ::  pos_z          !< intermediate particle position (z)
4201    REAL(wp) ::  pos_z_old      !< particle position (z) at previous particle timestep
4202    REAL(wp) ::  prt_x          !< current particle position (x)
4203    REAL(wp) ::  prt_y          !< current particle position (y)
4204    REAL(wp) ::  prt_z          !< current particle position (z)
4205    REAL(wp) ::  t_old          !< previous reflection time
4206    REAL(wp) ::  tmp_t          !< dummy for sorting algorithmus
4207    REAL(wp) ::  xwall          !< location of wall in x
4208    REAL(wp) ::  ywall          !< location of wall in y
4209    REAL(wp) ::  zwall          !< location of wall in z
4210
4211    REAL(wp), DIMENSION(0:10) ::  t  !< reflection time
4212
4213    SELECT CASE ( location_bc )
4214
4215       CASE ( 'bottom/top' )
4216
4217!     IF ( location_bc == 'bottom/top' )  THEN
4218
4219!
4220!--    Apply boundary conditions to those particles that have crossed the top or
4221!--    bottom boundary and delete those particles, which are older than allowed
4222       DO  n = 1, number_of_particles
4223
4224!
4225!--       Stop if particles have moved further than the length of one
4226!--       PE subdomain (newly released particles have age = age_m!)
4227          IF ( particles(n)%age /= particles(n)%age_m )  THEN
4228             IF ( ABS(particles(n)%speed_x) >                                  &
4229                  ((nxr-nxl+2)*dx)/(particles(n)%age-particles(n)%age_m)  .OR. &
4230                  ABS(particles(n)%speed_y) >                                  &
4231                  ((nyn-nys+2)*dy)/(particles(n)%age-particles(n)%age_m) )  THEN
4232
4233                  WRITE( message_string, * )  'particle too fast.  n = ',  n
4234                  CALL message( 'lpm_boundary_conds', 'PA0148', 2, 2, -1, 6, 1 )
4235             ENDIF
4236          ENDIF
4237
4238          IF ( particles(n)%age > particle_maximum_age  .AND.  &
4239               particles(n)%particle_mask )                              &
4240          THEN
4241             particles(n)%particle_mask  = .FALSE.
4242             deleted_particles = deleted_particles + 1
4243          ENDIF
4244
4245          IF ( particles(n)%z >= zw(nz)  .AND.  particles(n)%particle_mask )  THEN
4246             IF ( ibc_par_t == 1 )  THEN
4247!
4248!--             Particle absorption
4249                particles(n)%particle_mask  = .FALSE.
4250                deleted_particles = deleted_particles + 1
4251             ELSEIF ( ibc_par_t == 2 )  THEN
4252!
4253!--             Particle reflection
4254                particles(n)%z       = 2.0_wp * zw(nz) - particles(n)%z
4255                particles(n)%speed_z = -particles(n)%speed_z
4256                IF ( use_sgs_for_particles  .AND. &
4257                     particles(n)%rvar3 > 0.0_wp )  THEN
4258                   particles(n)%rvar3 = -particles(n)%rvar3
4259                ENDIF
4260             ENDIF
4261          ENDIF
4262         
4263          IF ( particles(n)%z < zw(0)  .AND.  particles(n)%particle_mask )  THEN
4264             IF ( ibc_par_b == 1 )  THEN
4265!
4266!--             Particle absorption
4267                particles(n)%particle_mask  = .FALSE.
4268                deleted_particles = deleted_particles + 1
4269             ELSEIF ( ibc_par_b == 2 )  THEN
4270!
4271!--             Particle reflection
4272                particles(n)%z       = 2.0_wp * zw(0) - particles(n)%z
4273                particles(n)%speed_z = -particles(n)%speed_z
4274                IF ( use_sgs_for_particles  .AND. &
4275                     particles(n)%rvar3 < 0.0_wp )  THEN
4276                   particles(n)%rvar3 = -particles(n)%rvar3
4277                ENDIF
4278             ENDIF
4279          ENDIF
4280       ENDDO
4281
4282!     ELSEIF ( location_bc == 'walls' )  THEN
4283      CASE ( 'walls' )
4284
4285       CALL cpu_log( log_point_s(48), 'lpm_wall_reflect', 'start' )
4286
4287       DO  n = 1, number_of_particles
4288!
4289!--       Recalculate particle timestep
4290          dt_particle = particles(n)%age - particles(n)%age_m
4291!
4292!--       Obtain x/y indices for current particle position
4293          i2 = particles(n)%x * ddx
4294          j2 = particles(n)%y * ddy
4295          IF (zw(k)   < particles(n)%z ) k2 = k + 1
4296          IF (zw(k)   > particles(n)%z .AND. zw(k-1) < particles(n)%z ) k2 = k
4297          IF (zw(k-1) > particles(n)%z ) k2 = k - 1 
4298!
4299!--       Save current particle positions
4300          prt_x = particles(n)%x
4301          prt_y = particles(n)%y
4302          prt_z = particles(n)%z
4303!
4304!--       Recalculate old particle positions
4305          pos_x_old = particles(n)%x - particles(n)%speed_x * dt_particle
4306          pos_y_old = particles(n)%y - particles(n)%speed_y * dt_particle
4307          pos_z_old = particles(n)%z - particles(n)%speed_z * dt_particle
4308!
4309!--       Obtain x/y indices for old particle positions
4310          i1 = i
4311          j1 = j
4312          k1 = k
4313!
4314!--       Determine horizontal as well as vertical walls at which particle can
4315!--       be potentially reflected.
4316!--       Start with walls aligned in yz layer.
4317!--       Wall to the right
4318          IF ( prt_x > pos_x_old )  THEN
4319             xwall = ( i1 + 1 ) * dx
4320!
4321!--       Wall to the left
4322          ELSE
4323             xwall = i1 * dx
4324          ENDIF
4325!
4326!--       Walls aligned in xz layer
4327!--       Wall to the north
4328          IF ( prt_y > pos_y_old )  THEN
4329             ywall = ( j1 +1 ) * dy
4330!--       Wall to the south
4331          ELSE
4332             ywall = j1 * dy
4333          ENDIF
4334
4335          IF ( prt_z > pos_z_old ) THEN
4336             zwall = zw(k)
4337          ELSE
4338             zwall = zw(k-1)
4339          ENDIF     
4340!
4341!--       Initialize flags to check if particle reflection is necessary
4342          cross_wall_x = .FALSE.
4343          cross_wall_y = .FALSE.
4344          cross_wall_z = .FALSE.
4345!
4346!--       Initialize flags to check if a wall is reached
4347          reach_x      = .FALSE.
4348          reach_y      = .FALSE.
4349          reach_z      = .FALSE.
4350!
4351!--       Initialize flags to check if a particle was already reflected
4352          reflect_x    = .FALSE.
4353          reflect_y    = .FALSE.
4354          reflect_z    = .FALSE.
4355!
4356!--       Initialize flags to check if a wall is already crossed.
4357!--       ( Required to obtain correct indices. )
4358          x_wall_reached = .FALSE.
4359          y_wall_reached = .FALSE.
4360          z_wall_reached = .FALSE.
4361!
4362!--       Initialize time array
4363          t     = 0.0_wp
4364!
4365!--       Check if particle can reach any wall. This case, calculate the
4366!--       fractional time needed to reach this wall. Store this fractional
4367!--       timestep in array t. Moreover, store indices for these grid
4368!--       boxes where the respective wall belongs to. 
4369!--       Start with x-direction.
4370          t_index    = 1
4371          t(t_index) = ( xwall - pos_x_old )                                   &
4372                     / MERGE( MAX( prt_x - pos_x_old,  1E-30_wp ),             &
4373                              MIN( prt_x - pos_x_old, -1E-30_wp ),             &
4374                              prt_x > pos_x_old )
4375          x_ind(t_index)   = i2
4376          y_ind(t_index)   = j1
4377          z_ind(t_index)   = k1
4378          reach_x(t_index) = .TRUE.
4379          reach_y(t_index) = .FALSE.
4380          reach_z(t_index) = .FALSE.
4381!
4382!--       Store these values only if particle really reaches any wall. t must
4383!--       be in a interval between [0:1].
4384          IF ( t(t_index) <= 1.0_wp .AND. t(t_index) >= 0.0_wp )  THEN
4385             t_index      = t_index + 1
4386             cross_wall_x = .TRUE.
4387          ENDIF
4388!
4389!--       y-direction
4390          t(t_index) = ( ywall - pos_y_old )                                   &
4391                     / MERGE( MAX( prt_y - pos_y_old,  1E-30_wp ),             &
4392                              MIN( prt_y - pos_y_old, -1E-30_wp ),             &
4393                              prt_y > pos_y_old )
4394          x_ind(t_index)   = i1
4395          y_ind(t_index)   = j2
4396          z_ind(t_index)   = k1
4397          reach_x(t_index) = .FALSE.
4398          reach_y(t_index) = .TRUE.
4399          reach_z(t_index) = .FALSE.
4400          IF ( t(t_index) <= 1.0_wp .AND. t(t_index) >= 0.0_wp )  THEN
4401             t_index      = t_index + 1
4402             cross_wall_y = .TRUE.
4403          ENDIF
4404!
4405!--       z-direction
4406          t(t_index) = (zwall - pos_z_old )                                    &
4407                     / MERGE( MAX( prt_z - pos_z_old,  1E-30_wp ),             &
4408                              MIN( prt_z - pos_z_old, -1E-30_wp ),             &
4409                              prt_z > pos_z_old )
4410                     
4411          x_ind(t_index)   = i1
4412          y_ind(t_index)   = j1
4413          z_ind(t_index)   = k2
4414          reach_x(t_index) = .FALSE.
4415          reach_y(t_index) = .FALSE.
4416          reach_z(t_index) = .TRUE.
4417          IF( t(t_index) <= 1.0_wp .AND. t(t_index) >= 0.0_wp) THEN
4418             t_index      = t_index + 1
4419             cross_wall_z = .TRUE.
4420          ENDIF
4421         
4422          t_index_number = t_index - 1
4423!
4424!--       Carry out reflection only if particle reaches any wall
4425          IF ( cross_wall_x .OR. cross_wall_y .OR. cross_wall_z )  THEN
4426!
4427!--          Sort fractional timesteps in ascending order. Also sort the
4428!--          corresponding indices and flag according to the time interval a 
4429!--          particle reaches the respective wall.
4430             inc = 1
4431             jr  = 1
4432             DO WHILE ( inc <= t_index_number )
4433                inc = 3 * inc + 1
4434             ENDDO
4435
4436             DO WHILE ( inc > 1 )
4437                inc = inc / 3
4438                DO  ir = inc+1, t_index_number
4439                   tmp_t       = t(ir)
4440                   tmp_x       = x_ind(ir)
4441                   tmp_y       = y_ind(ir)
4442                   tmp_z       = z_ind(ir)
4443                   tmp_reach_x = reach_x(ir)
4444                   tmp_reach_y = reach_y(ir)
4445                   tmp_reach_z = reach_z(ir)
4446                   jr    = ir
4447                   DO WHILE ( t(jr-inc) > tmp_t )
4448                      t(jr)       = t(jr-inc)
4449                      x_ind(jr)   = x_ind(jr-inc)
4450                      y_ind(jr)   = y_ind(jr-inc)
4451                      z_ind(jr)   = z_ind(jr-inc)
4452                      reach_x(jr) = reach_x(jr-inc)
4453                      reach_y(jr) = reach_y(jr-inc)
4454                      reach_z(jr) = reach_z(jr-inc)
4455                      jr    = jr - inc
4456                      IF ( jr <= inc )  EXIT
4457                   ENDDO
4458                   t(jr)       = tmp_t
4459                   x_ind(jr)   = tmp_x
4460                   y_ind(jr)   = tmp_y
4461                   z_ind(jr)   = tmp_z
4462                   reach_x(jr) = tmp_reach_x
4463                   reach_y(jr) = tmp_reach_y
4464                   reach_z(jr) = tmp_reach_z
4465                ENDDO
4466             ENDDO
4467!
4468!--          Initialize temporary particle positions
4469             pos_x = pos_x_old
4470             pos_y = pos_y_old
4471             pos_z = pos_z_old
4472!
4473!--          Loop over all times a particle possibly moves into a new grid box
4474             t_old = 0.0_wp
4475             DO t_index = 1, t_index_number
4476!           
4477!--             Calculate intermediate particle position according to the
4478!--             timesteps a particle reaches any wall.
4479                pos_x = pos_x + ( t(t_index) - t_old ) * dt_particle           &
4480                                                       * particles(n)%speed_x
4481                pos_y = pos_y + ( t(t_index) - t_old ) * dt_particle           &
4482                                                       * particles(n)%speed_y
4483                pos_z = pos_z + ( t(t_index) - t_old ) * dt_particle           &
4484                                                       * particles(n)%speed_z
4485!
4486!--             Obtain x/y grid indices for intermediate particle position from
4487!--             sorted index array
4488                i3 = x_ind(t_index)
4489                j3 = y_ind(t_index)
4490                k3 = z_ind(t_index)
4491!
4492!--             Check which wall is already reached
4493                IF ( .NOT. x_wall_reached )  x_wall_reached = reach_x(t_index) 
4494                IF ( .NOT. y_wall_reached )  y_wall_reached = reach_y(t_index)
4495                IF ( .NOT. z_wall_reached )  z_wall_reached = reach_z(t_index)
4496!
4497!--             Check if a particle needs to be reflected at any yz-wall. If
4498!--             necessary, carry out reflection. Please note, a security
4499!--             constant is required, as the particle position does not
4500!--             necessarily exactly match the wall location due to rounding
4501!--             errors.
4502                IF ( reach_x(t_index)                      .AND.               & 
4503                     ABS( pos_x - xwall ) < eps            .AND.               &
4504                     .NOT. BTEST(wall_flags_0(k3,j3,i3),0) .AND.               &
4505                     .NOT. reflect_x )  THEN
4506!
4507!
4508!--                Reflection in x-direction.
4509!--                Ensure correct reflection by MIN/MAX functions, depending on
4510!--                direction of particle transport.
4511!--                Due to rounding errors pos_x does not exactly match the wall
4512!--                location, leading to erroneous reflection.             
4513                   pos_x = MERGE( MIN( 2.0_wp * xwall - pos_x, xwall ),        &
4514                                  MAX( 2.0_wp * xwall - pos_x, xwall ),        &
4515                                  particles(n)%x > xwall )
4516!
4517!--                Change sign of particle speed                     
4518                   particles(n)%speed_x = - particles(n)%speed_x
4519!
4520!--                Also change sign of subgrid-scale particle speed
4521                   particles(n)%rvar1 = - particles(n)%rvar1
4522!
4523!--                Set flag that reflection along x is already done
4524                   reflect_x          = .TRUE.
4525!
4526!--                As the particle does not cross any further yz-wall during
4527!--                this timestep, set further x-indices to the current one.
4528                   x_ind(t_index:t_index_number) = i1
4529!
4530!--             If particle already reached the wall but was not reflected,
4531!--             set further x-indices to the new one.
4532                ELSEIF ( x_wall_reached .AND. .NOT. reflect_x )  THEN
4533                    x_ind(t_index:t_index_number) = i2
4534                ENDIF !particle reflection in x direction done
4535
4536!
4537!--             Check if a particle needs to be reflected at any xz-wall. If
4538!--             necessary, carry out reflection. Please note, a security
4539!--             constant is required, as the particle position does not
4540!--             necessarily exactly match the wall location due to rounding
4541!--             errors.
4542                IF ( reach_y(t_index)                      .AND.               & 
4543                     ABS( pos_y - ywall ) < eps            .AND.               &
4544                     .NOT. BTEST(wall_flags_0(k3,j3,i3),0) .AND.               &
4545                     .NOT. reflect_y )  THEN
4546!
4547!
4548!--                Reflection in y-direction.
4549!--                Ensure correct reflection by MIN/MAX functions, depending on
4550!--                direction of particle transport.
4551!--                Due to rounding errors pos_y does not exactly match the wall
4552!--                location, leading to erroneous reflection.             
4553                   pos_y = MERGE( MIN( 2.0_wp * ywall - pos_y, ywall ),        &
4554                                  MAX( 2.0_wp * ywall - pos_y, ywall ),        &
4555                                  particles(n)%y > ywall )
4556!
4557!--                Change sign of particle speed                     
4558                   particles(n)%speed_y = - particles(n)%speed_y
4559!
4560!--                Also change sign of subgrid-scale particle speed
4561                   particles(n)%rvar2 = - particles(n)%rvar2
4562!
4563!--                Set flag that reflection along y is already done
4564                   reflect_y          = .TRUE.
4565!
4566!--                As the particle does not cross any further xz-wall during
4567!--                this timestep, set further y-indices to the current one.
4568                   y_ind(t_index:t_index_number) = j1
4569!
4570!--             If particle already reached the wall but was not reflected,
4571!--             set further y-indices to the new one.
4572                ELSEIF ( y_wall_reached .AND. .NOT. reflect_y )  THEN
4573                    y_ind(t_index:t_index_number) = j2
4574                ENDIF !particle reflection in y direction done
4575               
4576!
4577!--             Check if a particle needs to be reflected at any xy-wall. If
4578!--             necessary, carry out reflection. Please note, a security
4579!--             constant is required, as the particle position does not
4580!--             necessarily exactly match the wall location due to rounding
4581!--             errors.
4582                IF ( reach_z(t_index)                      .AND.               & 
4583                     ABS( pos_z - zwall ) < eps            .AND.               &
4584                     .NOT. BTEST(wall_flags_0(k3,j3,i3),0) .AND.               &
4585                     .NOT. reflect_z )  THEN
4586!
4587!
4588!--                Reflection in z-direction.
4589!--                Ensure correct reflection by MIN/MAX functions, depending on
4590!--                direction of particle transport.
4591!--                Due to rounding errors pos_z does not exactly match the wall
4592!--                location, leading to erroneous reflection.             
4593                   pos_z = MERGE( MIN( 2.0_wp * zwall - pos_z, zwall ),        &
4594                                  MAX( 2.0_wp * zwall - pos_z, zwall ),        &
4595                                  particles(n)%z > zwall )
4596!
4597!--                Change sign of particle speed                     
4598                   particles(n)%speed_z = - particles(n)%speed_z
4599!
4600!--                Also change sign of subgrid-scale particle speed
4601                   particles(n)%rvar3 = - particles(n)%rvar3
4602!
4603!--                Set flag that reflection along z is already done
4604                   reflect_z          = .TRUE.
4605!
4606!--                As the particle does not cross any further xy-wall during
4607!--                this timestep, set further z-indices to the current one.
4608                   z_ind(t_index:t_index_number) = k1
4609!
4610!--             If particle already reached the wall but was not reflected,
4611!--             set further z-indices to the new one.
4612                ELSEIF ( z_wall_reached .AND. .NOT. reflect_z )  THEN
4613                    z_ind(t_index:t_index_number) = k2
4614                ENDIF !particle reflection in z direction done               
4615               
4616!
4617!--             Swap time
4618                t_old = t(t_index)
4619
4620             ENDDO
4621!
4622!--          If a particle was reflected, calculate final position from last
4623!--          intermediate position.
4624             IF ( reflect_x .OR. reflect_y .OR. reflect_z )  THEN
4625
4626                particles(n)%x = pos_x + ( 1.0_wp - t_old ) * dt_particle      &
4627                                                         * particles(n)%speed_x
4628                particles(n)%y = pos_y + ( 1.0_wp - t_old ) * dt_particle      &
4629                                                         * particles(n)%speed_y
4630                particles(n)%z = pos_z + ( 1.0_wp - t_old ) * dt_particle      &
4631                                                         * particles(n)%speed_z
4632
4633             ENDIF
4634
4635          ENDIF
4636
4637       ENDDO
4638
4639       CALL cpu_log( log_point_s(48), 'lpm_wall_reflect', 'stop' )
4640
4641       CASE DEFAULT
4642          CONTINUE
4643
4644    END SELECT
4645
4646 END SUBROUTINE lpm_boundary_conds
4647 
4648 
4649 SUBROUTINE lpm_droplet_condensation (i,j,k)
4650
4651    INTEGER(iwp), INTENT(IN) :: i              !<
4652    INTEGER(iwp), INTENT(IN) :: j              !<
4653    INTEGER(iwp), INTENT(IN) :: k              !<
4654    INTEGER(iwp) :: n                          !<
4655
4656    REAL(wp) ::  afactor                       !< curvature effects
4657    REAL(wp) ::  arg                           !<
4658    REAL(wp) ::  bfactor                       !< solute effects
4659    REAL(wp) ::  ddenom                        !<
4660    REAL(wp) ::  delta_r                       !<
4661    REAL(wp) ::  diameter                      !< diameter of cloud droplets
4662    REAL(wp) ::  diff_coeff                    !< diffusivity for water vapor
4663    REAL(wp) ::  drdt                          !<
4664    REAL(wp) ::  dt_ros                        !<
4665    REAL(wp) ::  dt_ros_sum                    !<
4666    REAL(wp) ::  d2rdtdr                       !<
4667    REAL(wp) ::  e_a                           !< current vapor pressure
4668    REAL(wp) ::  e_s                           !< current saturation vapor pressure
4669    REAL(wp) ::  error                         !< local truncation error in Rosenbrock
4670    REAL(wp) ::  k1                            !<
4671    REAL(wp) ::  k2                            !<
4672    REAL(wp) ::  r_err                         !< First order estimate of Rosenbrock radius
4673    REAL(wp) ::  r_ros                         !< Rosenbrock radius
4674    REAL(wp) ::  r_ros_ini                     !< initial Rosenbrock radius
4675    REAL(wp) ::  r0                            !< gas-kinetic lengthscale
4676    REAL(wp) ::  sigma                         !< surface tension of water
4677    REAL(wp) ::  thermal_conductivity          !< thermal conductivity for water
4678    REAL(wp) ::  t_int                         !< temperature
4679    REAL(wp) ::  w_s                           !< terminal velocity of droplets
4680    REAL(wp) ::  re_p                          !< particle Reynolds number
4681!
4682!-- Parameters for Rosenbrock method (see Verwer et al., 1999)
4683    REAL(wp), PARAMETER :: prec = 1.0E-3_wp     !< precision of Rosenbrock solution
4684    REAL(wp), PARAMETER :: q_increase = 1.5_wp  !< increase factor in timestep
4685    REAL(wp), PARAMETER :: q_decrease = 0.9_wp  !< decrease factor in timestep
4686    REAL(wp), PARAMETER :: gamma = 0.292893218814_wp !< = 1.0 - 1.0 / SQRT(2.0)
4687!
4688!-- Parameters for terminal velocity
4689    REAL(wp), PARAMETER ::  a_rog = 9.65_wp      !< parameter for fall velocity
4690    REAL(wp), PARAMETER ::  b_rog = 10.43_wp     !< parameter for fall velocity
4691    REAL(wp), PARAMETER ::  c_rog = 0.6_wp       !< parameter for fall velocity
4692    REAL(wp), PARAMETER ::  k_cap_rog = 4.0_wp   !< parameter for fall velocity
4693    REAL(wp), PARAMETER ::  k_low_rog = 12.0_wp  !< parameter for fall velocity
4694    REAL(wp), PARAMETER ::  d0_rog = 0.745_wp    !< separation diameter
4695
4696    REAL(wp), DIMENSION(number_of_particles) ::  ventilation_effect     !<
4697    REAL(wp), DIMENSION(number_of_particles) ::  new_r                  !<
4698
4699    CALL cpu_log( log_point_s(42), 'lpm_droplet_condens', 'start' )
4700
4701!
4702!-- Absolute temperature
4703    t_int = pt(k,j,i) * exner(k)
4704!
4705!-- Saturation vapor pressure (Eq. 10 in Bolton, 1980)
4706    e_s = magnus( t_int )
4707!
4708!-- Current vapor pressure
4709    e_a = q(k,j,i) * hyp(k) / ( q(k,j,i) + rd_d_rv )
4710!
4711!-- Thermal conductivity for water (from Rogers and Yau, Table 7.1)
4712    thermal_conductivity = 7.94048E-05_wp * t_int + 0.00227011_wp
4713!
4714!-- Moldecular diffusivity of water vapor in air (Hall und Pruppacher, 1976)
4715    diff_coeff           = 0.211E-4_wp * ( t_int / 273.15_wp )**1.94_wp * &
4716                           ( 101325.0_wp / hyp(k) )
4717!
4718!-- Lengthscale for gas-kinetic effects (from Mordy, 1959, p. 23):
4719    r0 = diff_coeff / 0.036_wp * SQRT( 2.0_wp * pi / ( r_v * t_int ) )
4720!
4721!-- Calculate effects of heat conductivity and diffusion of water vapor on the
4722!-- diffusional growth process (usually known as 1.0 / (F_k + F_d) )
4723    ddenom  = 1.0_wp / ( rho_l * r_v * t_int / ( e_s * diff_coeff ) +          &
4724                         ( l_v / ( r_v * t_int ) - 1.0_wp ) * rho_l *          &
4725                         l_v / ( thermal_conductivity * t_int )                &
4726                       )
4727    new_r = 0.0_wp
4728!
4729!-- Determine ventilation effect on evaporation of large drops
4730    DO  n = 1, number_of_particles
4731
4732       IF ( particles(n)%radius >= 4.0E-5_wp  .AND.  e_a / e_s < 1.0_wp )  THEN
4733!
4734!--       Terminal velocity is computed for vertical direction (Rogers et al.,
4735!--       1993, J. Appl. Meteorol.)
4736          diameter = particles(n)%radius * 2000.0_wp !diameter in mm
4737          IF ( diameter <= d0_rog )  THEN
4738             w_s = k_cap_rog * diameter * ( 1.0_wp - EXP( -k_low_rog * diameter ) )
4739          ELSE
4740             w_s = a_rog - b_rog * EXP( -c_rog * diameter )
4741          ENDIF
4742!
4743!--       Calculate droplet's Reynolds number
4744          re_p = 2.0_wp * particles(n)%radius * w_s / molecular_viscosity
4745!
4746!--       Ventilation coefficient (Rogers and Yau, 1989):
4747          IF ( re_p > 2.5_wp )  THEN
4748             ventilation_effect(n) = 0.78_wp + 0.28_wp * SQRT( re_p )
4749          ELSE
4750             ventilation_effect(n) = 1.0_wp + 0.09_wp * re_p
4751          ENDIF
4752       ELSE
4753!
4754!--       For small droplets or in supersaturated environments, the ventilation
4755!--       effect does not play a role
4756          ventilation_effect(n) = 1.0_wp
4757       ENDIF
4758    ENDDO
4759
4760    IF( .NOT. curvature_solution_effects ) then
4761!
4762!--    Use analytic model for diffusional growth including gas-kinetic
4763!--    effects (Mordy, 1959) but without the impact of aerosols.
4764       DO  n = 1, number_of_particles
4765          arg      = ( particles(n)%radius + r0 )**2 + 2.0_wp * dt_3d * ddenom * &
4766                                                       ventilation_effect(n) *   &
4767                                                       ( e_a / e_s - 1.0_wp )
4768          arg      = MAX( arg, ( 0.01E-6 + r0 )**2 )
4769          new_r(n) = SQRT( arg ) - r0
4770       ENDDO
4771
4772    ELSE
4773!
4774!--    Integrate the diffusional growth including gas-kinetic (Mordy, 1959),
4775!--    as well as curvature and solute effects (e.g., Köhler, 1936).
4776!
4777!--    Curvature effect (afactor) with surface tension (sigma) by Straka (2009)
4778       sigma = 0.0761_wp - 0.000155_wp * ( t_int - 273.15_wp )
4779!
4780!--    Solute effect (afactor)
4781       afactor = 2.0_wp * sigma / ( rho_l * r_v * t_int )
4782
4783       DO  n = 1, number_of_particles
4784!
4785!--       Solute effect (bfactor)
4786          bfactor = vanthoff * rho_s * particles(n)%aux1**3 *                    &
4787                    molecular_weight_of_water / ( rho_l * molecular_weight_of_solute )
4788
4789          dt_ros     = particles(n)%aux2  ! use previously stored Rosenbrock timestep
4790          dt_ros_sum = 0.0_wp
4791
4792          r_ros     = particles(n)%radius  ! initialize Rosenbrock particle radius
4793          r_ros_ini = r_ros
4794!
4795!--       Integrate growth equation using a 2nd-order Rosenbrock method
4796!--       (see Verwer et al., 1999, Eq. (3.2)). The Rosenbrock method adjusts
4797!--       its with internal timestep to minimize the local truncation error.
4798          DO WHILE ( dt_ros_sum < dt_3d )
4799
4800             dt_ros = MIN( dt_ros, dt_3d - dt_ros_sum )
4801
4802             DO
4803
4804                drdt = ddenom * ventilation_effect(n) * ( e_a / e_s - 1.0 -    &
4805                                                          afactor / r_ros +    &
4806                                                          bfactor / r_ros**3   &
4807                                                        ) / ( r_ros + r0 )
4808
4809                d2rdtdr = -ddenom * ventilation_effect(n) * (                  &
4810                                                (e_a / e_s - 1.0) * r_ros**4 - &
4811                                                afactor * r0 * r_ros**2 -      &
4812                                                2.0 * afactor * r_ros**3 +     &
4813                                                3.0 * bfactor * r0 +           &
4814                                                4.0 * bfactor * r_ros          &
4815                                                            )                  &
4816                          / ( r_ros**4 * ( r_ros + r0 )**2 )
4817
4818                k1    = drdt / ( 1.0 - gamma * dt_ros * d2rdtdr )
4819
4820                r_ros = MAX(r_ros_ini + k1 * dt_ros, particles(n)%aux1)
4821                r_err = r_ros
4822
4823                drdt  = ddenom * ventilation_effect(n) * ( e_a / e_s - 1.0 -   &
4824                                                           afactor / r_ros +   &
4825                                                           bfactor / r_ros**3  &
4826                                                         ) / ( r_ros + r0 )
4827
4828                k2 = ( drdt - dt_ros * 2.0 * gamma * d2rdtdr * k1 ) / &
4829                     ( 1.0 - dt_ros * gamma * d2rdtdr )
4830
4831                r_ros = MAX(r_ros_ini + dt_ros * ( 1.5 * k1 + 0.5 * k2), particles(n)%aux1)
4832   !
4833   !--          Check error of the solution, and reduce dt_ros if necessary.
4834                error = ABS(r_err - r_ros) / r_ros
4835                IF ( error .GT. prec )  THEN
4836                   dt_ros = SQRT( q_decrease * prec / error ) * dt_ros
4837                   r_ros  = r_ros_ini
4838                ELSE
4839                   dt_ros_sum = dt_ros_sum + dt_ros
4840                   dt_ros     = q_increase * dt_ros
4841                   r_ros_ini  = r_ros
4842                   EXIT
4843                ENDIF
4844
4845             END DO
4846
4847          END DO !Rosenbrock loop
4848!
4849!--       Store new particle radius
4850          new_r(n) = r_ros
4851!
4852!--       Store internal time step value for next PALM step
4853          particles(n)%aux2 = dt_ros
4854
4855       ENDDO !Particle loop
4856
4857    ENDIF
4858
4859    DO  n = 1, number_of_particles
4860!
4861!--    Sum up the change in liquid water for the respective grid
4862!--    box for the computation of the release/depletion of water vapor
4863!--    and heat.
4864       ql_c(k,j,i) = ql_c(k,j,i) + particles(n)%weight_factor *          &
4865                                   rho_l * 1.33333333_wp * pi *                &
4866                                   ( new_r(n)**3 - particles(n)%radius**3 ) /  &
4867                                   ( rho_surface * dx * dy * dzw(k) )
4868!
4869!--    Check if the increase in liqid water is not too big. If this is the case,
4870!--    the model timestep might be too long.
4871       IF ( ql_c(k,j,i) > 100.0_wp )  THEN
4872          WRITE( message_string, * ) 'k=',k,' j=',j,' i=',i,                &
4873                       ' ql_c=',ql_c(k,j,i), '&part(',n,')%wf=',            &
4874                       particles(n)%weight_factor,' delta_r=',delta_r
4875          CALL message( 'lpm_droplet_condensation', 'PA0143', 2, 2, -1, 6, 1 )
4876       ENDIF
4877!
4878!--    Check if the change in the droplet radius is not too big. If this is the
4879!--    case, the model timestep might be too long.
4880       delta_r = new_r(n) - particles(n)%radius
4881       IF ( delta_r < 0.0_wp  .AND. new_r(n) < 0.0_wp )  THEN
4882          WRITE( message_string, * ) '#1 k=',k,' j=',j,' i=',i,             &
4883                       ' e_s=',e_s, ' e_a=',e_a,' t_int=',t_int,               &
4884                       '&delta_r=',delta_r,                                    &
4885                       ' particle_radius=',particles(n)%radius
4886          CALL message( 'lpm_droplet_condensation', 'PA0144', 2, 2, -1, 6, 1 )
4887       ENDIF
4888!
4889!--    Sum up the total volume of liquid water (needed below for
4890!--    re-calculating the weighting factors)
4891       ql_v(k,j,i) = ql_v(k,j,i) + particles(n)%weight_factor * new_r(n)**3
4892!
4893!--    Determine radius class of the particle needed for collision
4894       IF ( use_kernel_tables )  THEN
4895          particles(n)%class = ( LOG( new_r(n) ) - rclass_lbound ) /           &
4896                               ( rclass_ubound - rclass_lbound ) *             &
4897                               radius_classes
4898          particles(n)%class = MIN( particles(n)%class, radius_classes )
4899          particles(n)%class = MAX( particles(n)%class, 1 )
4900       ENDIF
4901 !
4902 !--   Store new radius to particle features
4903       particles(n)%radius = new_r(n)
4904
4905    ENDDO
4906
4907    CALL cpu_log( log_point_s(42), 'lpm_droplet_condens', 'stop' )
4908
4909
4910 END SUBROUTINE lpm_droplet_condensation
4911
4912
4913!------------------------------------------------------------------------------!
4914! Description:
4915! ------------
4916!> Release of latent heat and change of mixing ratio due to condensation /
4917!> evaporation of droplets.
4918!------------------------------------------------------------------------------!
4919 SUBROUTINE lpm_interaction_droplets_ptq
4920
4921    INTEGER(iwp) ::  i    !< running index x direction
4922    INTEGER(iwp) ::  j    !< running index y direction
4923    INTEGER(iwp) ::  k    !< running index z direction
4924
4925    REAL(wp) ::  flag     !< flag to mask topography grid points
4926
4927    DO  i = nxl, nxr
4928       DO  j = nys, nyn
4929          DO  k = nzb+1, nzt
4930!
4931!--          Predetermine flag to mask topography
4932             flag = MERGE( 1.0_wp, 0.0_wp, BTEST( wall_flags_0(k,j,i), 0 ) )
4933
4934             q_p(k,j,i)  = q_p(k,j,i)  - ql_c(k,j,i) * flag
4935             pt_p(k,j,i) = pt_p(k,j,i) + lv_d_cp * ql_c(k,j,i) * d_exner(k) &
4936                                                     * flag
4937          ENDDO
4938       ENDDO
4939    ENDDO
4940
4941 END SUBROUTINE lpm_interaction_droplets_ptq
4942
4943
4944!------------------------------------------------------------------------------!
4945! Description:
4946! ------------
4947!> Release of latent heat and change of mixing ratio due to condensation /
4948!> evaporation of droplets. Call for grid point i,j
4949!------------------------------------------------------------------------------!
4950 SUBROUTINE lpm_interaction_droplets_ptq_ij( i, j )
4951
4952    INTEGER(iwp) ::  i    !< running index x direction
4953    INTEGER(iwp) ::  j    !< running index y direction
4954    INTEGER(iwp) ::  k    !< running index z direction
4955
4956    REAL(wp) ::  flag     !< flag to mask topography grid points
4957
4958
4959    DO  k = nzb+1, nzt
4960!
4961!--    Predetermine flag to mask topography
4962       flag = MERGE( 1.0_wp, 0.0_wp, BTEST( wall_flags_0(k,j,i), 0 ) )
4963
4964       q_p(k,j,i)  = q_p(k,j,i)  - ql_c(k,j,i) * flag
4965       pt_p(k,j,i) = pt_p