Changeset 1682 for palm/trunk/SOURCE/lpm_droplet_collision.f90

Timestamp:

Oct 7, 2015 11:56:08 PM (9 years ago)

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/lpm_droplet_collision.f90 (modified) (4 diffs)

palm/trunk/SOURCE/lpm_droplet_collision.f90

@@ -1 @@
- SUBROUTINE lpm_droplet_collision (i,j,k)
-
+!> @file lpm_droplet_collision.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! ------------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -59 +58 @@
 ! Description:
 ! ------------
-! Calculates change in droplet radius by collision. Droplet collision is
-! calculated for each grid box seperately. Collision is parameterized by
-! using collision kernels. Three different kernels are available:
-! PALM kernel: Kernel is approximated using a method from Rogers and
-!              Yau (1989, A Short Course in Cloud Physics, Pergamon Press).
-!              All droplets smaller than the treated one are represented by
-!              one droplet with mean features. Collision efficiencies are taken
-!              from the respective table in Rogers and Yau.
-! Hall kernel: Kernel from Hall (1980, J. Atmos. Sci., 2486-2507), which
-!              considers collision due to pure gravitational effects.
-! Wang kernel: Beside gravitational effects (treated with the Hall-kernel) also
-!              the effects of turbulence on the collision are considered using
-!              parameterizations of Ayala et al. (2008, New J. Phys., 10,
-!              075015) and Wang and Grabowski (2009, Atmos. Sci. Lett., 10,
-!              1-8). This kernel includes three possible effects of turbulence:
-!              the modification of the relative velocity between the droplets,
-!              the effect of preferential concentration, and the enhancement of
-!              collision efficiencies. 
+!> Calculates change in droplet radius by collision. Droplet collision is
+!> calculated for each grid box seperately. Collision is parameterized by
+!> using collision kernels. Three different kernels are available:
+!> PALM kernel: Kernel is approximated using a method from Rogers and
+!>              Yau (1989, A Short Course in Cloud Physics, Pergamon Press).
+!>              All droplets smaller than the treated one are represented by
+!>              one droplet with mean features. Collision efficiencies are taken
+!>              from the respective table in Rogers and Yau.
+!> Hall kernel: Kernel from Hall (1980, J. Atmos. Sci., 2486-2507), which
+!>              considers collision due to pure gravitational effects.
+!> Wang kernel: Beside gravitational effects (treated with the Hall-kernel) also
+!>              the effects of turbulence on the collision are considered using
+!>              parameterizations of Ayala et al. (2008, New J. Phys., 10,
+!>              075015) and Wang and Grabowski (2009, Atmos. Sci. Lett., 10,
+!>              1-8). This kernel includes three possible effects of turbulence:
+!>              the modification of the relative velocity between the droplets,
+!>              the effect of preferential concentration, and the enhancement of
+!>              collision efficiencies. 
 !------------------------------------------------------------------------------!
+ SUBROUTINE lpm_droplet_collision (i,j,k)
+ 
 
 
@@ -115 +116 @@
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  eclass   !:
-    INTEGER(iwp) ::  i        !:
-    INTEGER(iwp) ::  ii       !:
-    INTEGER(iwp) ::  inc      !:
-    INTEGER(iwp) ::  is       !:
-    INTEGER(iwp) ::  j        !:
-    INTEGER(iwp) ::  jj       !:
-    INTEGER(iwp) ::  js       !:
-    INTEGER(iwp) ::  k        !:
-    INTEGER(iwp) ::  kk       !:
-    INTEGER(iwp) ::  n        !:
-    INTEGER(iwp) ::  pse      !:
-    INTEGER(iwp) ::  psi      !:
-    INTEGER(iwp) ::  rclass_l !:
-    INTEGER(iwp) ::  rclass_s !:
-
-    INTEGER(iwp), DIMENSION(prt_count(k,j,i)) ::  rclass_v !:
-
-    LOGICAL, SAVE ::  first_flag = .TRUE. !:
-
-    TYPE(particle_type) :: tmp_particle   !:
-
-    REAL(wp) ::  aa       !:
-    REAL(wp) ::  auxn     !: temporary variables
-    REAL(wp) ::  auxs     !: temporary variables
-    REAL(wp) ::  bb       !:
-    REAL(wp) ::  cc       !:
-    REAL(wp) ::  dd       !:
-    REAL(wp) ::  ddV      !:
-    REAL(wp) ::  delta_r  !:
-    REAL(wp) ::  delta_v  !:
-    REAL(wp) ::  epsilon  !:
-    REAL(wp) ::  gg       !:
-    REAL(wp) ::  mean_r   !:
-    REAL(wp) ::  ql_int   !:
-    REAL(wp) ::  ql_int_l !:
-    REAL(wp) ::  ql_int_u !:
-    REAL(wp) ::  r3       !:
-    REAL(wp) ::  sl_r3    !:
-    REAL(wp) ::  sl_r4    !:
-    REAL(wp) ::  sum1     !:
-    REAL(wp) ::  sum2     !:
-    REAL(wp) ::  sum3     !:
-    REAL(wp) ::  u_int    !:
-    REAL(wp) ::  u_int_l  !:
-    REAL(wp) ::  u_int_u  !:
-    REAL(wp) ::  v_int    !:
-    REAL(wp) ::  v_int_l  !:
-    REAL(wp) ::  v_int_u  !:
-    REAL(wp) ::  w_int    !:
-    REAL(wp) ::  w_int_l  !:
-    REAL(wp) ::  w_int_u  !:
-    REAL(wp) ::  x        !:
-    REAL(wp) ::  y        !:
-
-    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rad    !:
-    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight !:
+    INTEGER(iwp) ::  eclass   !<
+    INTEGER(iwp) ::  i        !<
+    INTEGER(iwp) ::  ii       !<
+    INTEGER(iwp) ::  inc      !<
+    INTEGER(iwp) ::  is       !<
+    INTEGER(iwp) ::  j        !<
+    INTEGER(iwp) ::  jj       !<
+    INTEGER(iwp) ::  js       !<
+    INTEGER(iwp) ::  k        !<
+    INTEGER(iwp) ::  kk       !<
+    INTEGER(iwp) ::  n        !<
+    INTEGER(iwp) ::  pse      !<
+    INTEGER(iwp) ::  psi      !<
+    INTEGER(iwp) ::  rclass_l !<
+    INTEGER(iwp) ::  rclass_s !<
+
+    INTEGER(iwp), DIMENSION(prt_count(k,j,i)) ::  rclass_v !<
+
+    LOGICAL, SAVE ::  first_flag = .TRUE. !<
+
+    TYPE(particle_type) :: tmp_particle   !<
+
+    REAL(wp) ::  aa       !<
+    REAL(wp) ::  auxn     !< temporary variables
+    REAL(wp) ::  auxs     !< temporary variables
+    REAL(wp) ::  bb       !<
+    REAL(wp) ::  cc       !<
+    REAL(wp) ::  dd       !<
+    REAL(wp) ::  ddV      !<
+    REAL(wp) ::  delta_r  !<
+    REAL(wp) ::  delta_v  !<
+    REAL(wp) ::  epsilon  !<
+    REAL(wp) ::  gg       !<
+    REAL(wp) ::  mean_r   !<
+    REAL(wp) ::  ql_int   !<
+    REAL(wp) ::  ql_int_l !<
+    REAL(wp) ::  ql_int_u !<
+    REAL(wp) ::  r3       !<
+    REAL(wp) ::  sl_r3    !<
+    REAL(wp) ::  sl_r4    !<
+    REAL(wp) ::  sum1     !<
+    REAL(wp) ::  sum2     !<
+    REAL(wp) ::  sum3     !<
+    REAL(wp) ::  u_int    !<
+    REAL(wp) ::  u_int_l  !<
+    REAL(wp) ::  u_int_u  !<
+    REAL(wp) ::  v_int    !<
+    REAL(wp) ::  v_int_l  !<
+    REAL(wp) ::  v_int_u  !<
+    REAL(wp) ::  w_int    !<
+    REAL(wp) ::  w_int_l  !<
+    REAL(wp) ::  w_int_u  !<
+    REAL(wp) ::  x        !<
+    REAL(wp) ::  y        !<
+
+    REAL(wp), DIMENSION(:), ALLOCATABLE ::  rad    !<
+    REAL(wp), DIMENSION(:), ALLOCATABLE ::  weight !<
 
     REAL, DIMENSION(prt_count(k,j,i))    :: ck