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

Last change on this file since 1823 was 1823, checked in by hoffmann, 5 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 7.1 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 terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2014  Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! ------------------
21!
22!
23! Former revisions:
24! -----------------
25! $Id: mod_particle_attributes.f90 1823 2016-04-07 08:57:52Z hoffmann $
26!
27! 1822 2016-04-07 07:49:42Z hoffmann
28! +collision_algorithm, all_or_nothing, average_impact
29! Tails removed.
30!
31! 1727 2015-11-20 07:22:02Z knoop
32! Bugfix: Cause of syntax warning gfortran preprocessor removed
33!
34! 1682 2015-10-07 23:56:08Z knoop
35! Code annotations made doxygen readable
36!
37! 1575 2015-03-27 09:56:27Z raasch
38! +seed_follows_topography
39!
40! 1359 2014-04-11 17:15:14Z hoffmann
41! new module containing all particle related variables
42! -dt_sort_particles
43!
44! Description:
45! ------------
46!> Definition of variables used to compute particle transport
47!------------------------------------------------------------------------------!
48MODULE particle_attributes
49 
50
51    USE kinds
52
53    CHARACTER(LEN=15) ::  bc_par_lr = 'cyclic'                    !< left/right boundary condition
54    CHARACTER(LEN=15) ::  bc_par_ns = 'cyclic'                    !< north/south boundary condition
55    CHARACTER(LEN=15) ::  bc_par_b  = 'reflect'                   !< bottom boundary condition
56    CHARACTER(LEN=15) ::  bc_par_t  = 'absorb'                    !< top boundary condition
57    CHARACTER(LEN=15) ::  collision_algorithm = 'all_or_nothing'  !< collision algorithm
58    CHARACTER(LEN=15) ::  collision_kernel = 'none'               !< collision kernel
59
60    INTEGER(iwp) ::  deleted_particles = 0,                                    &
61                     dissipation_classes = 10, ibc_par_lr,                     &
62                     ibc_par_ns, ibc_par_b, ibc_par_t, iran_part = -1234567,   &
63                     maximum_number_of_particles = 0,                          &
64                     min_nr_particle = 50,                                     &
65                     mpi_particle_type,                                        &
66                     number_of_particles = 0,                                  &
67                     number_of_particle_groups = 1,                            &
68                     number_of_sublayers = 20,                                 &
69                     offset_ocean_nzt = 0,                                     &
70                     offset_ocean_nzt_m1 = 0, particles_per_point = 1,         &
71                     particle_file_count = 0, radius_classes = 20,             &
72                     sort_count = 0,                                           &
73                     total_number_of_particles,                                &
74                     trlp_count_sum, trlp_count_recv_sum, trrp_count_sum,      &
75                     trrp_count_recv_sum, trsp_count_sum, trsp_count_recv_sum, &
76                     trnp_count_sum, trnp_count_recv_sum
77
78    INTEGER(iwp), PARAMETER ::  max_number_of_particle_groups = 10
79
80    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  prt_count
81
82    LOGICAL ::  all_or_nothing = .FALSE., average_impact = .FALSE.,            &
83                hall_kernel = .FALSE., palm_kernel = .FALSE.,                  &
84                particle_advection = .FALSE., random_start_position = .FALSE., &
85                read_particles_from_restartfile = .TRUE.,                      &
86                seed_follows_topography = .FALSE.,                             &
87                uniform_particles = .TRUE., use_kernel_tables = .FALSE.,       &
88                use_sgs_for_particles = .FALSE., wang_kernel = .FALSE.,        &
89                write_particle_statistics = .FALSE.
90
91    LOGICAL, DIMENSION(max_number_of_particle_groups) ::                       &
92                vertical_particle_advection = .TRUE.
93
94    REAL(wp) ::  alloc_factor = 20.0_wp, c_0 = 3.0_wp,                         &
95                 dt_min_part = 0.0002_wp, dt_prel = 9999999.9_wp,              &
96                 dt_write_particle_data = 9999999.9_wp,                        &
97                 end_time_prel = 9999999.9_wp,                                 &
98                 initial_weighting_factor = 1.0_wp,                            &
99                 particle_advection_start = 0.0_wp,                            &
100                 sgs_wfu_part = 0.3333333_wp, sgs_wfv_part = 0.3333333_wp,     &
101                 sgs_wfw_part = 0.3333333_wp, time_prel = 0.0_wp,              &
102                 time_sort_particles = 0.0_wp,                                 &
103                 time_write_particle_data = 0.0_wp, z0_av_global
104
105    REAL(wp), DIMENSION(max_number_of_particle_groups) ::                      &
106                 density_ratio = 9999999.9_wp, pdx = 9999999.9_wp,             &
107                 pdy = 9999999.9_wp, pdz = 9999999.9_wp, psb = 9999999.9_wp,   &
108                 psl = 9999999.9_wp, psn = 9999999.9_wp, psr = 9999999.9_wp,   &
109                 pss = 9999999.9_wp, pst = 9999999.9_wp, radius = 9999999.9_wp
110
111    REAL(wp), DIMENSION(:), ALLOCATABLE     ::  log_z_z0
112
113    TYPE particle_type
114        SEQUENCE
115        REAL(wp)     ::  radius, age, age_m, dt_sum, dvrp_psize, e_m,          &
116                         origin_x, origin_y, origin_z, rvar1, rvar2, rvar3,    &
117                         speed_x, speed_y, speed_z, weight_factor, x, y, z
118        INTEGER(iwp) ::  class, group, tailpoints, tail_id
119        LOGICAL      ::  particle_mask
120        INTEGER(iwp) ::  block_nr
121    END TYPE particle_type
122
123    TYPE(particle_type), DIMENSION(:), POINTER ::  particles
124    TYPE(particle_type)                        ::  zero_particle
125
126    TYPE particle_groups_type
127        SEQUENCE
128        REAL(wp) ::  density_ratio, radius, exp_arg, exp_term
129    END TYPE particle_groups_type
130
131    TYPE(particle_groups_type), DIMENSION(max_number_of_particle_groups) ::    &
132       particle_groups
133
134    TYPE  grid_particle_def
135        INTEGER(iwp), DIMENSION(0:7)               ::  start_index
136        INTEGER(iwp), DIMENSION(0:7)               ::  end_index
137        LOGICAL                                    ::  time_loop_done
138        TYPE(particle_type), POINTER, DIMENSION(:) ::  particles                !Particle array for this grid cell
139    END TYPE grid_particle_def
140
141    TYPE(grid_particle_def), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  grid_particles
142
143    TYPE block_offset_def
144        INTEGER(iwp) ::  i_off
145        INTEGER(iwp) ::  j_off
146        INTEGER(iwp) ::  k_off
147    END TYPE block_offset_def
148
149    TYPE(block_offset_def), DIMENSION(0:7)         ::  block_offset
150
151    SAVE
152
153
154END MODULE particle_attributes
155
Note: See TracBrowser for help on using the repository browser.