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

Last change on this file since 2997 was 2718, checked in by maronga, 7 years ago

deleting of deprecated files; headers updated where needed

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