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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

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

palm/trunk/SOURCE/buoyancy.f90

@@ -1 @@
- MODULE buoyancy_mod
-
+!> @file buoyancy.f90
 !--------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! ------------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -81 +80 @@
 ! Description:
 ! ------------
-! Buoyancy term of the third component of the equation of motion.
-! WARNING: humidity is not regarded when using a sloping surface!
-!------------------------------------------------------------------------------!
+!> Buoyancy term of the third component of the equation of motion.
+!> @attention Humidity is not regarded when using a sloping surface!
+!------------------------------------------------------------------------------!
+ MODULE buoyancy_mod
+ 
 
     PRIVATE
@@ -101 +102 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points
+! Description:
+! ------------
+!> Call for all grid points
 !------------------------------------------------------------------------------!
     SUBROUTINE buoyancy( var, wind_component )
@@ -123 +126 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !:
-       INTEGER(iwp) ::  j              !:
-       INTEGER(iwp) ::  k              !:
-       INTEGER(iwp) ::  wind_component !:
+       INTEGER(iwp) ::  i              !<
+       INTEGER(iwp) ::  j              !<
+       INTEGER(iwp) ::  k              !<
+       INTEGER(iwp) ::  wind_component !<
        
 #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
@@ -197 +200 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points - accelerator version
+! Description:
+! ------------
+!> Call for all grid points - accelerator version
 !------------------------------------------------------------------------------!
     SUBROUTINE buoyancy_acc( var, wind_component )
@@ -219 +224 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !:
-       INTEGER(iwp) ::  j              !:
-       INTEGER(iwp) ::  k              !:
-       INTEGER(iwp) ::  wind_component !:
+       INTEGER(iwp) ::  i              !<
+       INTEGER(iwp) ::  j              !<
+       INTEGER(iwp) ::  k              !<
+       INTEGER(iwp) ::  wind_component !<
        
 #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
@@ -297 +302 @@
 
 !------------------------------------------------------------------------------!
-! Call for grid point i,j
-! ATTENTION: PGI-compiler creates SIGFPE if opt>1 is used! Therefore, opt=1 is
-!            forced by compiler-directive.
+! Description:
+! ------------
+!> Call for grid point i,j
+!> @attention PGI-compiler creates SIGFPE if opt>1 is used! Therefore, opt=1 is
+!>            forced by compiler-directive.
 !------------------------------------------------------------------------------!
 !pgi$r opt=1
@@ -321 +328 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i              !:
-       INTEGER(iwp) ::  j              !:
-       INTEGER(iwp) ::  k              !:
-       INTEGER(iwp) ::  pr             !:
-       INTEGER(iwp) ::  wind_component !:
+       INTEGER(iwp) ::  i              !<
+       INTEGER(iwp) ::  j              !<
+       INTEGER(iwp) ::  k              !<
+       INTEGER(iwp) ::  pr             !<
+       INTEGER(iwp) ::  wind_component !<
        
 #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