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

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

Bugfix: Added working precision

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