source: palm/trunk/SOURCE/user_lpm_advec.f90 @ 2696

Last change on this file since 2696 was 2696, checked in by kanani, 4 years ago

Merge of branch palm4u into trunk

  • Property svn:keywords set to Id
File size: 3.4 KB
Line 
1!> @file user_lpm_advec.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-2017 Leibniz Universitaet Hannover
18!------------------------------------------------------------------------------!
19!
20! Current revisions:
21! -----------------
22!
23!
24! Former revisions:
25! -----------------
26! $Id: user_lpm_advec.f90 2696 2017-12-14 17:12:51Z kanani $
27! Particle loops adapted for sub-box structure, i.e. for each sub-box the
28! particle loop runs from start_index up to end_index instead from 1 to
29! number_of_particles.
30!
31! 2101 2017-01-05 16:42:31Z suehring
32!
33! 2000 2016-08-20 18:09:15Z knoop
34! Forced header and separation lines into 80 columns
35!
36! 1682 2015-10-07 23:56:08Z knoop
37! Code annotations made doxygen readable
38!
39! 1416 2014-06-04 16:04:03Z suehring
40! Provide template for new particle structure.
41! Moreover, user_lpm_advec is called for each gridpoint.
42!
43! 1359 2014-04-11 17:15:14Z hoffmann
44! New particle structure integrated.
45!
46! 1320 2014-03-20 08:40:49Z raasch
47! kind-parameters added to all INTEGER and REAL declaration statements,
48! kinds are defined in new module kinds,
49! old module precision_kind is removed,
50! comment fields (!:) to be used for variable explanations added to
51! all variable declaration statements
52!
53! 1036 2012-10-22 13:43:42Z raasch
54! code put under GPL (PALM 3.9)
55!
56! 849 2012-03-15 10:35:09Z raasch
57! routine renamed user_lpm_advec
58!
59! 211 2008-11-11 04:46:24Z raasch
60! Former file user_interface.f90 split into one file per subroutine
61!
62! Description:
63! ------------
64!> Modification of initial particles by the user.
65!------------------------------------------------------------------------------!
66 SUBROUTINE user_lpm_advec( ip, jp, kp )
67 
68
69    USE kinds
70   
71    USE particle_attributes
72   
73    USE user
74
75    IMPLICIT NONE
76
77    INTEGER(iwp) ::  ip   !< index of particle grid box, x-direction
78    INTEGER(iwp) ::  jp   !< index of particle grid box, y-direction
79    INTEGER(iwp) ::  kp   !< index of particle grid box, z-direction
80    INTEGER(iwp) ::  n    !< particle index
81    INTEGER(iwp) ::  nb   !< index of sub-box particles are sorted in
82
83    INTEGER(iwp), DIMENSION(0:7)  ::  start_index !< start particle index for current sub-box
84    INTEGER(iwp), DIMENSION(0:7)  ::  end_index   !< start particle index for current sub-box
85
86!
87!-- Here the user-defined actions follow
88!   number_of_particles = prt_count(kp,jp,ip)
89!   particles => grid_particles(kp,jp,ip)%particles(1:number_of_particles)
90!
91!   start_index = grid_particles(kp,jp,ip)%start_index
92!   end_index   = grid_particles(kp,jp,ip)%end_index
93!
94!   IF ( number_of_particles <= 0 )  CYCLE
95!   DO  n = 1, number_of_particles
96!   DO  nb = 0, 7
97!      DO  n = start_index(nb), end_index(nb)
98!         particles(n)%xxx =
99!      ENDDO
100!   ENDDO
101
102 END SUBROUTINE user_lpm_advec
103
Note: See TracBrowser for help on using the repository browser.