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

Last change on this file since 4168 was 4168, checked in by suehring, 22 months ago

Replace get_topography_top_index functions by pre-calculated arrays in order to save computational resources

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