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

Last change on this file since 3436 was 3405, checked in by raasch, 6 years ago

bugfix: BIND attribute added to derived type particle_type, bugfix: nx, ny are required in non-parallel case

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