source: palm/trunk/SOURCE/mod_particle_attributes.f90 @ 2334

Last change on this file since 2334 was 2312, checked in by hoffmann, 7 years ago

various improvements of the LCM

  • Property svn:keywords set to Id
File size: 16.4 KB
Line 
1!> @file mod_particle_attributes.f90
2!------------------------------------------------------------------------------!
3! This file is part of PALM.
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-2017 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! ------------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: mod_particle_attributes.f90 2312 2017-07-14 20:26:51Z gronemeier $
27! Aerosol initialization improved.
28!
29! 2305 2017-07-06 11:18:47Z hoffmann
30! Improved calculation of particle IDs.
31!
32! 2278 2017-06-12 13:08:18Z schwenkel
33! Added comments
34!
35! 2265 2017-06-08 16:58:28Z schwenkel
36! Unused variables removed.
37!
38! 2263 2017-06-08 14:59:01Z schwenkel
39! Implemented splitting and merging algorithm
40!
41! 2183 2017-03-17 14:29:15Z schwenkel
42!
43! 2182 2017-03-17 14:27:40Z schwenkel
44! Added parameters for simplified particle initialization.
45!
46! 2122 2017-01-18 12:22:54Z hoffmann
47! Calculation of particle ID
48! Particle attribute dvrp_psize renamed to user: this attribute can be used by
49! by the user to store any variable
50!
51! 2000 2016-08-20 18:09:15Z knoop
52! Forced header and separation lines into 80 columns
53!
54! 1936 2016-06-13 13:37:44Z suehring
55! +deallocate_memory, step_dealloc
56!
57! 1929 2016-06-09 16:25:25Z suehring
58! -sgs_wfu_par, sgs_wfv_par, sgs_wfw_par
59! + sgs_wf_par
60!
61! 1871 2016-04-15 11:46:09Z hoffmann
62! Initialization of aerosols added.
63!
64! 1849 2016-04-08 11:33:18Z hoffmann
65! bfactor, mass_of_solute, molecular_weight_of_solute, molecular_weight_of_water,
66! vanthoff added from modules
67!
68! 1831 2016-04-07 13:15:51Z hoffmann
69! palm_kernel removed, curvature_solution_effects added
70!
71! 1822 2016-04-07 07:49:42Z hoffmann
72! +collision_algorithm, all_or_nothing, average_impact
73! Tails removed.
74!
75! 1727 2015-11-20 07:22:02Z knoop
76! Bugfix: Cause of syntax warning gfortran preprocessor removed
77!
78! 1682 2015-10-07 23:56:08Z knoop
79! Code annotations made doxygen readable
80!
81! 1575 2015-03-27 09:56:27Z raasch
82! +seed_follows_topography
83!
84! 1359 2014-04-11 17:15:14Z hoffmann
85! new module containing all particle related variables
86! -dt_sort_particles
87!
88! Description:
89! ------------
90!> Definition of variables used to compute particle transport
91!------------------------------------------------------------------------------!
92MODULE particle_attributes
93
94
95    USE kinds
96
97    CHARACTER(LEN=15) ::  aero_type = 'maritime'                   !< aerosol type
98    CHARACTER(LEN=15) ::  bc_par_lr = 'cyclic'                     !< left/right boundary condition
99    CHARACTER(LEN=15) ::  bc_par_ns = 'cyclic'                     !< north/south boundary condition
100    CHARACTER(LEN=15) ::  bc_par_b  = 'reflect'                    !< bottom boundary condition
101    CHARACTER(LEN=15) ::  bc_par_t  = 'absorb'                     !< top boundary condition
102    CHARACTER(LEN=15) ::  collision_kernel = 'none'                !< collision kernel
103    CHARACTER(LEN=5)  ::  splitting_function = 'gamma'             !< function for calculation critical weighting factor
104    CHARACTER(LEN=5)  ::  splitting_mode = 'const'                 !< splitting mode
105
106    INTEGER(iwp) ::  deleted_particles = 0                        !< number of deleted particles per time step
107    INTEGER(iwp) ::  dissipation_classes = 10                     !< namelist parameter (see documentation)
108    INTEGER(iwp) ::  ibc_par_b                                    !< particle bottom boundary condition dummy
109    INTEGER(iwp) ::  ibc_par_lr                                   !< particle left/right boundary condition dummy
110    INTEGER(iwp) ::  ibc_par_ns                                   !< particle north/south boundary condition dummy
111    INTEGER(iwp) ::  ibc_par_t                                    !< particle top boundary condition dummy
112    INTEGER(iwp) ::  iran_part = -1234567                         !< number for random generator
113    INTEGER(iwp) ::  isf                                          !< dummy for splitting function
114    INTEGER(iwp) ::  i_splitting_mode                             !< dummy for splitting mode
115    INTEGER(iwp) ::  max_number_particles_per_gridbox = 100       !< namelist parameter (see documentation)
116    INTEGER(iwp) ::  merge_drp = 0                                !< number of merged droplets
117    INTEGER(iwp) ::  min_nr_particle = 50                         !< namelist parameter (see documentation)
118    INTEGER(iwp) ::  new_particles = 0                            !< number of new particles
119    INTEGER(iwp) ::  n_max = 100                                  !< number of radii bin for splitting functions
120    INTEGER(iwp) ::  number_of_particles = 0                      !< number of particles for each grid box (3d array is saved on prt_count)
121    INTEGER(iwp) ::  number_of_particle_groups = 1                !< namelist parameter (see documentation)
122    INTEGER(iwp) ::  number_of_sublayers = 20                     !< number of sublayers for particle velocities betwenn surface and first grid level
123    INTEGER(iwp) ::  number_particles_per_gridbox = -1            !< namelist parameter (see documentation)
124    INTEGER(iwp) ::  offset_ocean_nzt = 0                         !< in case of oceans runs, the vertical index calculations need an offset
125    INTEGER(iwp) ::  offset_ocean_nzt_m1 = 0                      !< in case of oceans runs, the vertical index calculations need an offset
126    INTEGER(iwp) ::  particles_per_point = 1                      !< namelist parameter (see documentation)
127    INTEGER(iwp) ::  radius_classes = 20                          !< namelist parameter (see documentation)
128    INTEGER(iwp) ::  sort_count = 0                               !< counter for sorting particles
129    INTEGER(iwp) ::  splitting_factor = 2                         !< namelist parameter (see documentation)
130    INTEGER(iwp) ::  splitting_factor_max = 5                     !< namelist parameter (see documentation)
131    INTEGER(iwp) ::  step_dealloc = 100                           !< namelist parameter (see documentation)
132    INTEGER(iwp) ::  sum_merge_drp = 0                            !< sum of merged super droplets
133    INTEGER(iwp) ::  sum_new_particles = 0                        !< sum of created particles (in splitting algorithm)
134    INTEGER(iwp) ::  total_number_of_particles                    !< total number of particles in the whole model domain
135    INTEGER(iwp) ::  trlp_count_sum                               !< parameter for particle exchange of PEs
136    INTEGER(iwp) ::  trlp_count_recv_sum                          !< parameter for particle exchange of PEs
137    INTEGER(iwp) ::  trrp_count_sum                               !< parameter for particle exchange of PEs
138    INTEGER(iwp) ::  trrp_count_recv_sum                          !< parameter for particle exchange of PEs
139    INTEGER(iwp) ::  trsp_count_sum                               !< parameter for particle exchange of PEs
140    INTEGER(iwp) ::  trsp_count_recv_sum                          !< parameter for particle exchange of PEs
141    INTEGER(iwp) ::  trnp_count_sum                               !< parameter for particle exchange of PEs
142    INTEGER(iwp) ::  trnp_count_recv_sum                          !< parameter for particle exchange of PEs
143
144    INTEGER(iwp), PARAMETER ::  max_number_of_particle_groups = 10 !< maximum allowed number of particle groups
145
146    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  prt_count  !< 3d array of number of particles of every grid box
147
148    LOGICAL ::  curvature_solution_effects = .FALSE.      !< namelist parameter (see documentation)
149    LOGICAL ::  deallocate_memory = .TRUE.                !< namelist parameter (see documentation)
150    LOGICAL ::  hall_kernel = .FALSE.                     !< flag for collision kernel
151    LOGICAL ::  merging = .FALSE.                         !< namelist parameter (see documentation)
152    LOGICAL ::  particle_advection = .FALSE.              !< parameter to steer the advection of particles
153    LOGICAL ::  random_start_position = .FALSE.           !< namelist parameter (see documentation)
154    LOGICAL ::  read_particles_from_restartfile = .TRUE.  !< namelist parameter (see documentation)
155    LOGICAL ::  seed_follows_topography = .FALSE.         !< namelist parameter (see documentation)
156    LOGICAL ::  splitting = .FALSE.                       !< namelist parameter (see documentation)
157    LOGICAL ::  use_kernel_tables = .FALSE.               !< parameter, which turns on the use of precalculated collision kernels
158    LOGICAL ::  use_sgs_for_particles = .FALSE.           !< namelist parameter (see documentation)
159    LOGICAL ::  wang_kernel = .FALSE.                     !< flag for collision kernel
160    LOGICAL ::  write_particle_statistics = .FALSE.       !< namelist parameter (see documentation)
161
162    LOGICAL, DIMENSION(max_number_of_particle_groups) ::                       &
163                vertical_particle_advection = .TRUE.              !< Switch on/off vertical particle transport
164
165    REAL(wp) ::  aero_weight = 1.0_wp                      !< namelist parameter (see documentation)
166    REAL(wp) ::  alloc_factor = 20.0_wp                    !< namelist parameter (see documentation)
167    REAL(wp) ::  c_0 = 3.0_wp                              !< parameter for lagrangian timescale
168    REAL(wp) ::  dt_min_part = 0.0002_wp                   !< minimum particle time step when SGS velocities are used (s)
169    REAL(wp) ::  dt_prel = 9999999.9_wp                    !< namelist parameter (see documentation)
170    REAL(wp) ::  dt_write_particle_data = 9999999.9_wp     !< namelist parameter (see documentation)
171    REAL(wp) ::  end_time_prel = 9999999.9_wp              !< namelist parameter (see documentation)
172    REAL(wp) ::  initial_weighting_factor = 1.0_wp         !< namelist parameter (see documentation)
173    REAL(wp) ::  log_sigma(3) = 1.0_wp                     !< namelist parameter (see documentation)
174    REAL(wp) ::  molecular_weight_of_solute = 0.05844_wp   !< mol. m. NaCl (kg mol-1)
175    REAL(wp) ::  molecular_weight_of_water = 0.01801528_wp !< mol. m. H2O (kg mol-1)
176    REAL(wp) ::  na(3) = 0.0_wp                            !< namelist parameter (see documentation)
177    REAL(wp) ::  number_concentration = -1.0_wp            !< namelist parameter (see documentation)
178    REAL(wp) ::  particle_advection_start = 0.0_wp         !< namelist parameter (see documentation)
179    REAL(wp) ::  radius_merge = 1.0E-7_wp                  !< namelist parameter (see documentation)
180    REAL(wp) ::  radius_split = 40.0E-6_wp                 !< namelist parameter (see documentation)
181    REAL(wp) ::  rho_s = 2165.0_wp                         !< density of NaCl (kg m-3)
182    REAL(wp) ::  rm(3) = 1.0E-6_wp                         !< namelist parameter (see documentation)
183    REAL(wp) ::  sgs_wf_part                               !< parameter for sgs
184    REAL(wp) ::  time_prel = 0.0_wp                        !< time for particle release
185    REAL(wp) ::  time_write_particle_data = 0.0_wp         !< write particle data at current time on file
186    REAL(wp) ::  vanthoff = 2.0_wp                         !< van't Hoff factor for NaCl
187    REAL(wp) ::  weight_factor_merge = -1.0_wp             !< namelist parameter (see documentation)
188    REAL(wp) ::  weight_factor_split = -1.0_wp             !< namelist parameter (see documentation)
189    REAL(wp) ::  z0_av_global                              !< horizontal mean value of z0
190
191    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  density_ratio = 9999999.9_wp  !< namelist parameter (see documentation)
192    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdx = 9999999.9_wp            !< namelist parameter (see documentation)
193    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdy = 9999999.9_wp            !< namelist parameter (see documentation)
194    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pdz = 9999999.9_wp            !< namelist parameter (see documentation)
195    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psb = 9999999.9_wp            !< namelist parameter (see documentation)
196    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psl = 9999999.9_wp            !< namelist parameter (see documentation)
197    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psn = 9999999.9_wp            !< namelist parameter (see documentation)
198    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  psr = 9999999.9_wp            !< namelist parameter (see documentation)
199    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pss = 9999999.9_wp            !< namelist parameter (see documentation)
200    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  pst = 9999999.9_wp            !< namelist parameter (see documentation).
201    REAL(wp), DIMENSION(max_number_of_particle_groups) ::  radius = 9999999.9_wp         !< namelist parameter (see documentation)
202
203    REAL(wp), DIMENSION(:), ALLOCATABLE     ::  log_z_z0   !< Precalculate LOG(z/z0)
204
205
206    TYPE particle_type
207        REAL(wp)     ::  aux1          !< auxiliary multi-purpose feature
208        REAL(wp)     ::  aux2          !< auxiliary multi-purpose feature
209        REAL(wp)     ::  radius        !< radius of particle
210        REAL(wp)     ::  age           !< age of particle
211        REAL(wp)     ::  age_m         !<
212        REAL(wp)     ::  dt_sum        !<
213        REAL(wp)     ::  e_m           !< interpolated sgs tke
214        REAL(wp)     ::  origin_x      !< origin x-position of particle (changed cyclic bc)
215        REAL(wp)     ::  origin_y      !< origin y-position of particle (changed cyclic bc)
216        REAL(wp)     ::  origin_z      !< origin z-position of particle (changed cyclic bc)
217        REAL(wp)     ::  rvar1         !<
218        REAL(wp)     ::  rvar2         !<
219        REAL(wp)     ::  rvar3         !<
220        REAL(wp)     ::  speed_x       !< speed of particle in x
221        REAL(wp)     ::  speed_y       !< speed of particle in y
222        REAL(wp)     ::  speed_z       !< speed of particle in z
223        REAL(wp)     ::  weight_factor !< weighting factor
224        REAL(wp)     ::  x             !< x-position
225        REAL(wp)     ::  y             !< y-position
226        REAL(wp)     ::  z             !< z-position
227        INTEGER(iwp) ::  class         !< radius class needed for collision
228        INTEGER(iwp) ::  group         !< number of particle group
229        INTEGER(idp) ::  id            !< particle ID (64 bit integer)
230        LOGICAL      ::  particle_mask !< if this parameter is set to false the particle will be deleted
231        INTEGER(iwp) ::  block_nr      !< number for sorting (removable?)
232    END TYPE particle_type
233
234    TYPE(particle_type), DIMENSION(:), POINTER ::  particles       !< Particle array for this grid cell
235    TYPE(particle_type)                        ::  zero_particle   !< zero particle to avoid weird thinge
236
237    TYPE particle_groups_type
238        SEQUENCE
239        REAL(wp) ::  density_ratio  !< density ratio of the fluid and the particles
240        REAL(wp) ::  radius         !< radius of particle
241        REAL(wp) ::  exp_arg        !< exponential term of particle inertia
242        REAL(wp) ::  exp_term       !< exponential term of particle inertia
243    END TYPE particle_groups_type
244
245    TYPE(particle_groups_type), DIMENSION(max_number_of_particle_groups) ::    &
246       particle_groups
247
248    TYPE  grid_particle_def
249        INTEGER(iwp), DIMENSION(0:7)               ::  start_index        !< start particle index for current block
250        INTEGER(iwp), DIMENSION(0:7)               ::  end_index          !< end particle index for current block
251        INTEGER(iwp)                               ::  id_counter         !< particle id counter
252        LOGICAL                                    ::  time_loop_done     !< timestep loop for particle advection
253        TYPE(particle_type), POINTER, DIMENSION(:) ::  particles          !< Particle array for this grid cell
254    END TYPE grid_particle_def
255
256    TYPE(grid_particle_def), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  grid_particles
257
258    TYPE block_offset_def          !<
259        INTEGER(iwp) ::  i_off     !<
260        INTEGER(iwp) ::  j_off     !<
261        INTEGER(iwp) ::  k_off     !<
262    END TYPE block_offset_def
263
264    TYPE(block_offset_def), DIMENSION(0:7)         ::  block_offset
265
266    SAVE
267
268
269END MODULE particle_attributes
Note: See TracBrowser for help on using the repository browser.