Changeset 1682 for palm/trunk/SOURCE/diffusion_e.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_e.f90 (modified) (9 diffs)

palm/trunk/SOURCE/diffusion_e.f90

@@ -1 @@
- MODULE diffusion_e_mod
-
+!> @file diffusion_e.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -82 +81 @@
 ! Description:
 ! ------------
-! Diffusion- and dissipation terms for the TKE
+!> Diffusion- and dissipation terms for the TKE
 !------------------------------------------------------------------------------!
+ MODULE diffusion_e_mod
+ 
 
     PRIVATE
@@ -102 +103 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points
+! Description:
+! ------------
+!> Call for all grid points
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_e( var, var_reference )
@@ -127 +130 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !: 
-       INTEGER(iwp) ::  j              !: 
-       INTEGER(iwp) ::  k              !: 
-       REAL(wp)     ::  dvar_dz        !: 
-       REAL(wp)     ::  l_stable       !: 
-       REAL(wp)     ::  var_reference  !: 
+       INTEGER(iwp) ::  i              !< 
+       INTEGER(iwp) ::  j              !< 
+       INTEGER(iwp) ::  k              !< 
+       REAL(wp)     ::  dvar_dz        !< 
+       REAL(wp)     ::  l_stable       !< 
+       REAL(wp)     ::  var_reference  !< 
 
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !: 
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !< 
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  var  !: 
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  var  !< 
 #endif
-       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  dissipation  !:
-       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  l            !:
-       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  ll           !: 
+       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  dissipation  !<
+       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  l            !<
+       REAL(wp), DIMENSION(nzb+1:nzt,nys:nyn) ::  ll           !< 
  
 
@@ -307 +310 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points - accelerator version
+! Description:
+! ------------
+!> Call for all grid points - accelerator version
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_e_acc( var, var_reference )
@@ -332 +337 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !: 
-       INTEGER(iwp) ::  j              !: 
-       INTEGER(iwp) ::  k              !: 
-       REAL(wp)     ::  dissipation    !: 
-       REAL(wp)     ::  dvar_dz        !: 
-       REAL(wp)     ::  l              !: 
-       REAL(wp)     ::  ll             !: 
-       REAL(wp)     ::  l_stable       !: 
-       REAL(wp)     ::  var_reference  !: 
+       INTEGER(iwp) ::  i              !< 
+       INTEGER(iwp) ::  j              !< 
+       INTEGER(iwp) ::  k              !< 
+       REAL(wp)     ::  dissipation    !< 
+       REAL(wp)     ::  dvar_dz        !< 
+       REAL(wp)     ::  l              !< 
+       REAL(wp)     ::  ll             !< 
+       REAL(wp)     ::  l_stable       !< 
+       REAL(wp)     ::  var_reference  !< 
 
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !: 
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !< 
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  var  !: 
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  var  !< 
 #endif
 
@@ -504 +509 @@
 
 !------------------------------------------------------------------------------!
-! Call for grid point i,j
+! Description:
+! ------------
+!> Call for grid point i,j
 !------------------------------------------------------------------------------!
     SUBROUTINE diffusion_e_ij( i, j, var, var_reference )
@@ -528 +535 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !: 
-       INTEGER(iwp) ::  j              !: 
-       INTEGER(iwp) ::  k              !: 
-       REAL(wp)     ::  dvar_dz        !: 
-       REAL(wp)     ::  l_stable       !:
-       REAL(wp)     ::  var_reference  !:
+       INTEGER(iwp) ::  i              !< 
+       INTEGER(iwp) ::  j              !< 
+       INTEGER(iwp) ::  k              !< 
+       REAL(wp)     ::  dvar_dz        !< 
+       REAL(wp)     ::  l_stable       !<
+       REAL(wp)     ::  var_reference  !<
 
 #if defined( __nopointer )
-       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !:
+       REAL(wp), DIMENSION(nzb:nzt+1,nysg:nyng,nxlg:nxrg) ::  var  !<
 #else
-       REAL(wp), DIMENSION(:,:,:), POINTER ::  var     !:
+       REAL(wp), DIMENSION(:,:,:), POINTER ::  var     !<
 #endif
-       REAL(wp), DIMENSION(nzb+1:nzt) ::  dissipation  !:
-       REAL(wp), DIMENSION(nzb+1:nzt) ::  l            !:
-       REAL(wp), DIMENSION(nzb+1:nzt) ::  ll           !:
+       REAL(wp), DIMENSION(nzb+1:nzt) ::  dissipation  !<
+       REAL(wp), DIMENSION(nzb+1:nzt) ::  l            !<
+       REAL(wp), DIMENSION(nzb+1:nzt) ::  ll           !<