| 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 | ! Code annotations made doxygen readable |
|---|
| 22 | ! |
|---|
| 23 | ! Former revisions: |
|---|
| 24 | ! ----------------- |
|---|
| 25 | ! $Id: mod_particle_attributes.f90 1682 2015-10-07 23:56:08Z knoop $ |
|---|
| 26 | ! |
|---|
| 27 | ! 1575 2015-03-27 09:56:27Z raasch |
|---|
| 28 | ! +seed_follows_topography |
|---|
| 29 | ! |
|---|
| 30 | ! 1359 2014-04-11 17:15:14Z hoffmann |
|---|
| 31 | ! new module containing all particle related variables |
|---|
| 32 | ! -dt_sort_particles |
|---|
| 33 | ! |
|---|
| 34 | ! Description: |
|---|
| 35 | ! ------------ |
|---|
| 36 | !> Definition of variables used to compute particle transport |
|---|
| 37 | !------------------------------------------------------------------------------! |
|---|
| 38 | MODULE particle_attributes |
|---|
| 39 | |
|---|
| 40 | |
|---|
| 41 | USE kinds |
|---|
| 42 | |
|---|
| 43 | CHARACTER(LEN=15) :: bc_par_lr = 'cyclic', bc_par_ns = 'cyclic', & |
|---|
| 44 | bc_par_b = 'reflect', bc_par_t = 'absorb', & |
|---|
| 45 | collision_kernel = 'none' |
|---|
| 46 | |
|---|
| 47 | INTEGER(iwp) :: deleted_particles = 0, deleted_tails = 0, & |
|---|
| 48 | dissipation_classes = 10, ibc_par_lr, & |
|---|
| 49 | ibc_par_ns, ibc_par_b, ibc_par_t, iran_part = -1234567, & |
|---|
| 50 | maximum_number_of_particles = 0, & |
|---|
| 51 | maximum_number_of_tailpoints = 100, & |
|---|
| 52 | maximum_number_of_tails = 0, & |
|---|
| 53 | min_nr_particle = 50, & |
|---|
| 54 | mpi_particle_type, & |
|---|
| 55 | number_of_particles = 0, & |
|---|
| 56 | number_of_particle_groups = 1, number_of_tails = 0, & |
|---|
| 57 | number_of_initial_tails = 0, number_of_sublayers = 20, & |
|---|
| 58 | offset_ocean_nzt = 0, & |
|---|
| 59 | offset_ocean_nzt_m1 = 0, particles_per_point = 1, & |
|---|
| 60 | particle_file_count = 0, radius_classes = 20, & |
|---|
| 61 | skip_particles_for_tail = 100, sort_count = 0, & |
|---|
| 62 | total_number_of_particles, total_number_of_tails = 0, & |
|---|
| 63 | trlp_count_sum, trlp_count_recv_sum, trrp_count_sum, & |
|---|
| 64 | trrp_count_recv_sum, trsp_count_sum, trsp_count_recv_sum, & |
|---|
| 65 | trnp_count_sum, trnp_count_recv_sum |
|---|
| 66 | |
|---|
| 67 | INTEGER(iwp), PARAMETER :: max_number_of_particle_groups = 10 |
|---|
| 68 | |
|---|
| 69 | INTEGER(iwp), DIMENSION(:), ALLOCATABLE :: new_tail_id |
|---|
| 70 | INTEGER(iwp), DIMENSION(:,:,:), ALLOCATABLE :: prt_count |
|---|
| 71 | |
|---|
| 72 | LOGICAL :: hall_kernel = .FALSE., palm_kernel = .FALSE., & |
|---|
| 73 | particle_advection = .FALSE., random_start_position = .FALSE., & |
|---|
| 74 | read_particles_from_restartfile = .TRUE., & |
|---|
| 75 | seed_follows_topography = .FALSE., & |
|---|
| 76 | uniform_particles = .TRUE., use_kernel_tables = .FALSE., & |
|---|
| 77 | use_particle_tails = .FALSE., use_sgs_for_particles = .FALSE., & |
|---|
| 78 | wang_kernel = .FALSE., write_particle_statistics = .FALSE. |
|---|
| 79 | |
|---|
| 80 | LOGICAL, DIMENSION(max_number_of_particle_groups) :: & |
|---|
| 81 | vertical_particle_advection = .TRUE. |
|---|
| 82 | |
|---|
| 83 | LOGICAL, DIMENSION(:), ALLOCATABLE :: tail_mask |
|---|
| 84 | |
|---|
| 85 | REAL(wp) :: alloc_factor = 20.0_wp, c_0 = 3.0_wp, & |
|---|
| 86 | dt_min_part = 0.0002_wp, dt_prel = 9999999.9_wp, & |
|---|
| 87 | dt_write_particle_data = 9999999.9_wp, & |
|---|
| 88 | dvrp_psize = 9999999.9_wp, end_time_prel = 9999999.9_wp, & |
|---|
| 89 | initial_weighting_factor = 1.0_wp, & |
|---|
| 90 | maximum_tailpoint_age = 100000.0_wp, & |
|---|
| 91 | minimum_tailpoint_distance = 0.0_wp, & |
|---|
| 92 | particle_advection_start = 0.0_wp, & |
|---|
| 93 | sgs_wfu_part = 0.3333333_wp, sgs_wfv_part = 0.3333333_wp, & |
|---|
| 94 | sgs_wfw_part = 0.3333333_wp, time_prel = 0.0_wp, & |
|---|
| 95 | time_sort_particles = 0.0_wp, & |
|---|
| 96 | time_write_particle_data = 0.0_wp, z0_av_global |
|---|
| 97 | |
|---|
| 98 | REAL(wp), DIMENSION(max_number_of_particle_groups) :: & |
|---|
| 99 | density_ratio = 9999999.9_wp, pdx = 9999999.9_wp, & |
|---|
| 100 | pdy = 9999999.9_wp, pdz = 9999999.9_wp, psb = 9999999.9_wp, & |
|---|
| 101 | psl = 9999999.9_wp, psn = 9999999.9_wp, psr = 9999999.9_wp, & |
|---|
| 102 | pss = 9999999.9_wp, pst = 9999999.9_wp, radius = 9999999.9_wp |
|---|
| 103 | |
|---|
| 104 | REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: particle_tail_coordinates |
|---|
| 105 | |
|---|
| 106 | REAL(wp), DIMENSION(:), ALLOCATABLE :: log_z_z0 |
|---|
| 107 | |
|---|
| 108 | TYPE particle_type |
|---|
| 109 | SEQUENCE |
|---|
| 110 | #if defined( __twocachelines ) |
|---|
| 111 | REAL(wp) :: radius |
|---|
| 112 | REAL(sp) :: x, y, z, speed_x, speed_y, speed_z |
|---|
| 113 | REAL(wp) :: weight_factor, rvar1, dt_sum |
|---|
| 114 | INTEGER(iwp) :: class |
|---|
| 115 | LOGICAL :: particle_mask |
|---|
| 116 | |
|---|
| 117 | REAL(wp) :: dvrp_psize, rvar2, rvar3 |
|---|
| 118 | REAL(sp) :: age, origin_x, origin_y, origin_z, e_m, age_m |
|---|
| 119 | INTEGER(iwp) :: group, tailpoints, tail_id, block_nr |
|---|
| 120 | #else |
|---|
| 121 | REAL(wp) :: radius, age, age_m, dt_sum, dvrp_psize, e_m, & |
|---|
| 122 | origin_x, origin_y, origin_z, rvar1, rvar2, rvar3, & |
|---|
| 123 | speed_x, speed_y, speed_z, weight_factor, x, y, z |
|---|
| 124 | INTEGER(iwp) :: class, group, tailpoints, tail_id |
|---|
| 125 | LOGICAL :: particle_mask |
|---|
| 126 | INTEGER(iwp) :: block_nr |
|---|
| 127 | #endif !One 32 Bit word for 64 Bit alignment in Type declaration |
|---|
| 128 | END TYPE particle_type |
|---|
| 129 | |
|---|
| 130 | TYPE(particle_type), DIMENSION(:), POINTER :: particles |
|---|
| 131 | TYPE(particle_type) :: zero_particle |
|---|
| 132 | |
|---|
| 133 | TYPE particle_groups_type |
|---|
| 134 | SEQUENCE |
|---|
| 135 | REAL(wp) :: density_ratio, radius, exp_arg, exp_term |
|---|
| 136 | END TYPE particle_groups_type |
|---|
| 137 | |
|---|
| 138 | TYPE(particle_groups_type), DIMENSION(max_number_of_particle_groups) :: & |
|---|
| 139 | particle_groups |
|---|
| 140 | |
|---|
| 141 | TYPE grid_particle_def |
|---|
| 142 | INTEGER(iwp), DIMENSION(0:7) :: start_index |
|---|
| 143 | INTEGER(iwp), DIMENSION(0:7) :: end_index |
|---|
| 144 | LOGICAL :: time_loop_done |
|---|
| 145 | TYPE(particle_type), POINTER, DIMENSION(:) :: particles !Particle array for this grid cell |
|---|
| 146 | END TYPE grid_particle_def |
|---|
| 147 | |
|---|
| 148 | TYPE(grid_particle_def), DIMENSION(:,:,:), ALLOCATABLE, TARGET :: grid_particles |
|---|
| 149 | |
|---|
| 150 | TYPE block_offset_def |
|---|
| 151 | INTEGER(iwp) :: i_off |
|---|
| 152 | INTEGER(iwp) :: j_off |
|---|
| 153 | INTEGER(iwp) :: k_off |
|---|
| 154 | END TYPE block_offset_def |
|---|
| 155 | |
|---|
| 156 | TYPE(block_offset_def), DIMENSION(0:7) :: block_offset |
|---|
| 157 | |
|---|
| 158 | SAVE |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | END MODULE particle_attributes |
|---|
| 162 | |
|---|
