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