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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/diffusion_s.f90 (modified) (9 diffs)

palm/trunk/SOURCE/diffusion_s.f90

@@ -1 @@
- MODULE diffusion_s_mod
-
+!> @file diffusion_s.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! ------------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -68 +67 @@
 ! Description:
 ! ------------
-! Diffusion term of scalar quantities (temperature and water content)
-!------------------------------------------------------------------------------!
+!> Diffusion term of scalar quantities (temperature and water content)
+!------------------------------------------------------------------------------!
+ MODULE diffusion_s_mod
+ 
 
     PRIVATE
@@ -87 +88 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points
+! Description:
+! ------------
+!> Call for all grid points
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_s( s, s_flux_b, s_flux_t, wall_s_flux )
@@ -108 +111 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i                 !: 
-       INTEGER(iwp) ::  j                 !: 
-       INTEGER(iwp) ::  k                 !: 
-       REAL(wp)     ::  wall_s_flux(0:4)  !: 
-       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b, s_flux_t !:
+       INTEGER(iwp) ::  i                 !< 
+       INTEGER(iwp) ::  j                 !< 
+       INTEGER(iwp) ::  k                 !< 
+       REAL(wp)     ::  wall_s_flux(0:4)  !< 
+       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b, s_flux_t !<
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s  !: 
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s  !< 
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !: 
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !< 
 #endif
 
@@ -212 +215 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points - accelerator version
+! Description:
+! ------------
+!> Call for all grid points - accelerator version
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_s_acc( s, s_flux_b, s_flux_t, wall_s_flux )
@@ -233 +238 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i                 !: 
-       INTEGER(iwp) ::  j                 !: 
-       INTEGER(iwp) ::  k                 !: 
-       REAL(wp)     ::  wall_s_flux(0:4)  !: 
-       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b !: 
-       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_t !: 
+       INTEGER(iwp) ::  i                 !< 
+       INTEGER(iwp) ::  j                 !< 
+       INTEGER(iwp) ::  k                 !< 
+       REAL(wp)     ::  wall_s_flux(0:4)  !< 
+       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b !< 
+       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_t !< 
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s  !:
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s  !<
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !:
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !<
 #endif
 
@@ -340 +345 @@
 
 !------------------------------------------------------------------------------!
-! Call for grid point i,j
+! Description:
+! ------------
+!> Call for grid point i,j
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_s_ij( i, j, s, s_flux_b, s_flux_t, wall_s_flux )
@@ -361 +368 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i                 !: 
-       INTEGER(iwp) ::  j                 !: 
-       INTEGER(iwp) ::  k                 !: 
-       REAL(wp)     ::  wall_s_flux(0:4)  !: 
-       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b  !: 
-       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_t  !: 
+       INTEGER(iwp) ::  i                 !< 
+       INTEGER(iwp) ::  j                 !< 
+       INTEGER(iwp) ::  k                 !< 
+       REAL(wp)     ::  wall_s_flux(0:4)  !< 
+       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_b  !< 
+       REAL(wp), DIMENSION(nysg:nyng,nxlg:nxrg) ::  s_flux_t  !< 
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s !: 
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  s !< 
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !: 
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  s  !< 
 #endif