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

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

Some reformatting

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