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

Last change on this file since 4313 was 4182, checked in by scharf, 22 months ago
  • corrected "Former revisions" section
  • minor formatting in "Former revisions" section
  • added "Author" section
  • Property svn:keywords set to Id
File size: 7.0 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!
[3655]17! Copyright 1997-2019 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 4182 2019-08-22 15:20:23Z suehring $
[4182]27! Corrected "Former revisions" section
28!
29! 4043 2019-06-18 16:59:00Z schwenkel
[4043]30! Remove min_nr_particle
31!
32! 4017 2019-06-06 12:16:46Z schwenkel
[3786]33! interoperable C datatypes introduced in particle type to avoid compiler warnings
34!
35! 3720 2019-02-06 13:19:55Z knoop
[3560]36! time_prel replaced by last_particle_release_time
[4182]37! 1359 2014-04-11 17:15:14Z hoffmann
38! new module containing all particle related variables
39! -dt_sort_particles
[2716]40!
[1359]41! Description:
42! ------------
[1682]43!> Definition of variables used to compute particle transport
[1359]44!------------------------------------------------------------------------------!
[1682]45MODULE particle_attributes
[1359]46
[3405]47    USE, INTRINSIC ::  ISO_C_BINDING
[2312]48
[1359]49    USE kinds
50
[2265]51    INTEGER(iwp) ::  dissipation_classes = 10                     !< namelist parameter (see documentation)
[2263]52    INTEGER(iwp) ::  ibc_par_b                                    !< particle bottom boundary condition dummy
53    INTEGER(iwp) ::  ibc_par_lr                                   !< particle left/right boundary condition dummy
54    INTEGER(iwp) ::  ibc_par_ns                                   !< particle north/south boundary condition dummy
55    INTEGER(iwp) ::  ibc_par_t                                    !< particle top boundary condition dummy
[2312]56    INTEGER(iwp) ::  number_of_particles = 0                      !< number of particles for each grid box (3d array is saved on prt_count)
57    INTEGER(iwp) ::  number_of_particle_groups = 1                !< namelist parameter (see documentation)
[1359]58
[2263]59    INTEGER(iwp), PARAMETER ::  max_number_of_particle_groups = 10 !< maximum allowed number of particle groups
[1359]60
[2263]61    INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE ::  prt_count  !< 3d array of number of particles of every grid box
[4017]62   
[2263]63    LOGICAL ::  particle_advection = .FALSE.              !< parameter to steer the advection of particles
[4017]64    LOGICAL ::  use_sgs_for_particles = .FALSE.           !< namelist parameter (see documentation)   
[2263]65    LOGICAL ::  wang_kernel = .FALSE.                     !< flag for collision kernel
[2312]66
[2265]67    REAL(wp) ::  alloc_factor = 20.0_wp                    !< namelist parameter (see documentation)
68    REAL(wp) ::  particle_advection_start = 0.0_wp         !< namelist parameter (see documentation)
[1359]69
[3786]70!
71!-- WARNING: For compatibility of derived types, the BIND attribute is required, and interoperable C
72!-- datatypes must be used. These type are hard wired here! So changes in working precision (wp, iwp)
73!-- will not affect the particle_type!
74!-- The main reason for introducing the interoperable datatypes was to avoid compiler warnings of
75!-- the gfortran compiler.
76!-- The BIND attribite is required because of C_F_POINTER usage in the pmc particle interface.
[3405]77    TYPE, BIND(C) ::  particle_type
[3786]78        REAL(C_DOUBLE) ::  aux1          !< auxiliary multi-purpose feature
79        REAL(C_DOUBLE) ::  aux2          !< auxiliary multi-purpose feature
80        REAL(C_DOUBLE) ::  radius        !< radius of particle
81        REAL(C_DOUBLE) ::  age           !< age of particle
82        REAL(C_DOUBLE) ::  age_m         !<
83        REAL(C_DOUBLE) ::  dt_sum        !<
84        REAL(C_DOUBLE) ::  e_m           !< interpolated sgs tke
85        REAL(C_DOUBLE) ::  origin_x      !< origin x-position of particle (changed cyclic bc)
86        REAL(C_DOUBLE) ::  origin_y      !< origin y-position of particle (changed cyclic bc)
87        REAL(C_DOUBLE) ::  origin_z      !< origin z-position of particle (changed cyclic bc)
88        REAL(C_DOUBLE) ::  rvar1         !<
89        REAL(C_DOUBLE) ::  rvar2         !<
90        REAL(C_DOUBLE) ::  rvar3         !<
91        REAL(C_DOUBLE) ::  speed_x       !< speed of particle in x
92        REAL(C_DOUBLE) ::  speed_y       !< speed of particle in y
93        REAL(C_DOUBLE) ::  speed_z       !< speed of particle in z
94        REAL(C_DOUBLE) ::  weight_factor !< weighting factor
95        REAL(C_DOUBLE) ::  x             !< x-position
96        REAL(C_DOUBLE) ::  y             !< y-position
97        REAL(C_DOUBLE) ::  z             !< z-position
98        INTEGER(C_INT) ::  class         !< radius class needed for collision
99        INTEGER(C_INT) ::  group         !< number of particle group
100        INTEGER(C_LONG_LONG) ::  id            !< particle ID (64 bit integer)
[3720]101        LOGICAL(C_BOOL) ::  particle_mask !< if this parameter is set to false the particle will be deleted
[3786]102        INTEGER(C_INT) ::  block_nr      !< number for sorting (removable?)
[1359]103    END TYPE particle_type
104
[2265]105    TYPE(particle_type), DIMENSION(:), POINTER ::  particles       !< Particle array for this grid cell
106    TYPE(particle_type)                        ::  zero_particle   !< zero particle to avoid weird thinge
[1359]107
108    TYPE particle_groups_type
109        SEQUENCE
[2265]110        REAL(wp) ::  density_ratio  !< density ratio of the fluid and the particles
111        REAL(wp) ::  radius         !< radius of particle
112        REAL(wp) ::  exp_arg        !< exponential term of particle inertia
113        REAL(wp) ::  exp_term       !< exponential term of particle inertia
[1359]114    END TYPE particle_groups_type
115
116    TYPE(particle_groups_type), DIMENSION(max_number_of_particle_groups) ::    &
117       particle_groups
118
119    TYPE  grid_particle_def
[2265]120        INTEGER(iwp), DIMENSION(0:7)               ::  start_index        !< start particle index for current block
121        INTEGER(iwp), DIMENSION(0:7)               ::  end_index          !< end particle index for current block
[2305]122        INTEGER(iwp)                               ::  id_counter         !< particle id counter
[2265]123        LOGICAL                                    ::  time_loop_done     !< timestep loop for particle advection
124        TYPE(particle_type), POINTER, DIMENSION(:) ::  particles          !< Particle array for this grid cell
[1359]125    END TYPE grid_particle_def
126
127    TYPE(grid_particle_def), DIMENSION(:,:,:), ALLOCATABLE, TARGET ::  grid_particles
128
[2265]129    TYPE block_offset_def          !<
130        INTEGER(iwp) ::  i_off     !<
131        INTEGER(iwp) ::  j_off     !<
132        INTEGER(iwp) ::  k_off     !<
[1359]133    END TYPE block_offset_def
134
135    TYPE(block_offset_def), DIMENSION(0:7)         ::  block_offset
136
137    SAVE
138
139
140END MODULE particle_attributes
Note: See TracBrowser for help on using the repository browser.