Changeset 1682 for palm/trunk/SOURCE/lpm_init.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_init.f90 (modified) (8 diffs)

palm/trunk/SOURCE/lpm_init.f90

@@ -1 @@
- MODULE lpm_init_mod
-
+!> @file lpm_init.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 !
 ! Former revisions:
@@ -82 +81 @@
 ! Description:
 ! ------------
-! This routine initializes a set of particles and their attributes (position,
-! radius, ..) which are used by the Lagrangian particle model (see lpm).
+!> This routine initializes a set of particles and their attributes (position,
+!> radius, ..) which are used by the Lagrangian particle model (see lpm).
 !------------------------------------------------------------------------------!
+ MODULE lpm_init_mod
+ 
 
     USE arrays_3d,                                                             &
@@ -145 +146 @@
     PRIVATE
 
-    INTEGER(iwp), PARAMETER         :: PHASE_INIT    = 1  !:
-    INTEGER(iwp), PARAMETER, PUBLIC :: PHASE_RELEASE = 2  !:
+    INTEGER(iwp), PARAMETER         :: PHASE_INIT    = 1  !<
+    INTEGER(iwp), PARAMETER, PUBLIC :: PHASE_RELEASE = 2  !<
 
     INTERFACE lpm_init
@@ -160 +161 @@
 CONTAINS
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
  SUBROUTINE lpm_init
 
@@ -167 +173 @@
     IMPLICIT NONE
 
-    INTEGER(iwp) ::  i                           !:
-    INTEGER(iwp) ::  ip                          !:
-    INTEGER(iwp) ::  j                           !:
-    INTEGER(iwp) ::  jp                          !:
-    INTEGER(iwp) ::  k                           !:
-    INTEGER(iwp) ::  kp                          !:
-    INTEGER(iwp) ::  n                           !:
-    INTEGER(iwp) ::  nn                          !:
+    INTEGER(iwp) ::  i                           !<
+    INTEGER(iwp) ::  ip                          !<
+    INTEGER(iwp) ::  j                           !<
+    INTEGER(iwp) ::  jp                          !<
+    INTEGER(iwp) ::  k                           !<
+    INTEGER(iwp) ::  kp                          !<
+    INTEGER(iwp) ::  n                           !<
+    INTEGER(iwp) ::  nn                          !<
 
 #if defined( __parallel )
-    INTEGER(iwp), DIMENSION(3) ::  blocklengths  !:
-    INTEGER(iwp), DIMENSION(3) ::  displacements !:
-    INTEGER(iwp), DIMENSION(3) ::  types         !:
+    INTEGER(iwp), DIMENSION(3) ::  blocklengths  !<
+    INTEGER(iwp), DIMENSION(3) ::  displacements !<
+    INTEGER(iwp), DIMENSION(3) ::  types         !<
 #endif
-    LOGICAL ::  uniform_particles_l              !:
-
-    REAL(wp) ::  height_int                      !:
-    REAL(wp) ::  height_p                        !:
-    REAL(wp) ::  z_p                             !:
-    REAL(wp) ::  z0_av_local                     !:
+    LOGICAL ::  uniform_particles_l              !<
+
+    REAL(wp) ::  height_int                      !<
+    REAL(wp) ::  height_p                        !<
+    REAL(wp) ::  z_p                             !<
+    REAL(wp) ::  z0_av_local                     !<
 
 #if defined( __parallel )
@@ -592 +598 @@
  END SUBROUTINE lpm_init
 
+!------------------------------------------------------------------------------!
+! Description:
+! ------------
+!> @todo Missing subroutine description.
+!------------------------------------------------------------------------------!
  SUBROUTINE lpm_create_particle (phase)
 
@@ -602 +613 @@
     IMPLICIT  NONE
 
-    INTEGER(iwp)               ::  alloc_size  !:
-    INTEGER(iwp)               ::  i           !:
-    INTEGER(iwp)               ::  ip          !:
-    INTEGER(iwp)               ::  j           !:
-    INTEGER(iwp)               ::  jp          !:
-    INTEGER(iwp)               ::  kp          !:
-    INTEGER(iwp)               ::  loop_stride !:
-    INTEGER(iwp)               ::  n           !:
-    INTEGER(iwp)               ::  new_size    !:
-    INTEGER(iwp)               ::  nn          !:
-
-    INTEGER(iwp), INTENT(IN)   ::  phase       !:
-
-    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_count !:
-    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_start !:
-
-    LOGICAL                    ::  first_stride !:
-
-    REAL(wp)                   ::  pos_x !:
-    REAL(wp)                   ::  pos_y !:
-    REAL(wp)                   ::  pos_z !:
-
-    TYPE(particle_type),TARGET ::  tmp_particle !:
+    INTEGER(iwp)               ::  alloc_size  !<
+    INTEGER(iwp)               ::  i           !<
+    INTEGER(iwp)               ::  ip          !<
+    INTEGER(iwp)               ::  j           !<
+    INTEGER(iwp)               ::  jp          !<
+    INTEGER(iwp)               ::  kp          !<
+    INTEGER(iwp)               ::  loop_stride !<
+    INTEGER(iwp)               ::  n           !<
+    INTEGER(iwp)               ::  new_size    !<
+    INTEGER(iwp)               ::  nn          !<
+
+    INTEGER(iwp), INTENT(IN)   ::  phase       !<
+
+    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_count !<
+    INTEGER(iwp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  local_start !<
+
+    LOGICAL                    ::  first_stride !<
+
+    REAL(wp)                   ::  pos_x !<
+    REAL(wp)                   ::  pos_y !<
+    REAL(wp)                   ::  pos_z !<
+
+    TYPE(particle_type),TARGET ::  tmp_particle !<
 
 !