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

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

Implement reset method as bottom boundary condition

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