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

Timestamp:

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

Author:

knoop

Message:

Code annotations made doxygen readable

File:

• palm/trunk/SOURCE/eqn_state_seawater.f90 (modified) (10 diffs)

palm/trunk/SOURCE/eqn_state_seawater.f90

@@ -1 @@
- MODULE eqn_state_seawater_mod
-
+!> @file eqn_state_seawater.f90
 !------------------------------------------------------------------------------!
 ! This file is part of PALM.
@@ -20 +19 @@
 ! Current revisions:
 ! -----------------
-! 
+! Code annotations made doxygen readable 
 ! 
 ! Former revisions:
@@ -46 +45 @@
 ! Description:
 ! ------------
-! Equation of state for seawater as a function of potential temperature,
-! salinity, and pressure.
-! For coefficients see Jackett et al., 2006: J. Atm. Ocean Tech.
-! eqn_state_seawater calculates the potential density referred at hyp(0).
-! eqn_state_seawater_func calculates density.
-!------------------------------------------------------------------------------!
+!> Equation of state for seawater as a function of potential temperature,
+!> salinity, and pressure.
+!> For coefficients see Jackett et al., 2006: J. Atm. Ocean Tech.
+!> eqn_state_seawater calculates the potential density referred at hyp(0).
+!> eqn_state_seawater_func calculates density.
+!------------------------------------------------------------------------------!
+ MODULE eqn_state_seawater_mod
+ 
     
     USE kinds
@@ -67 +68 @@
                              9.8920219266399117D-8,  4.6996642771754730D-6,    &
                             -2.5862187075154352D-8, -3.2921414007960662D-12 /)
-                          !:
+                          !<
 
     REAL(wp), DIMENSION(13), PARAMETER ::  den =                               &
@@ -77 +78 @@
                              6.7103246285651894D-6, -2.4461698007024582D-17,   &
                             -9.1534417604289062D-18 /)
-                          !:
+                          !<
 
     INTERFACE eqn_state_seawater
@@ -92 +93 @@
 
 !------------------------------------------------------------------------------!
-! Call for all grid points
+! Description:
+! ------------
+!> Call for all grid points
 !------------------------------------------------------------------------------!
     SUBROUTINE eqn_state_seawater
@@ -103 +106 @@
        IMPLICIT NONE
 
-       INTEGER(iwp) ::  i  !:
-       INTEGER(iwp) ::  j  !:
-       INTEGER(iwp) ::  k  !:
-
-       REAL(wp) ::  pden  !:
-       REAL(wp) ::  pnom  !:
-       REAL(wp) ::  p1    !:
-       REAL(wp) ::  p2    !:
-       REAL(wp) ::  p3    !:
-       REAL(wp) ::  pt1   !:
-       REAL(wp) ::  pt2   !:
-       REAL(wp) ::  pt3   !:
-       REAL(wp) ::  pt4   !:
-       REAL(wp) ::  sa1   !:
-       REAL(wp) ::  sa15  !:
-       REAL(wp) ::  sa2   !:
+       INTEGER(iwp) ::  i  !<
+       INTEGER(iwp) ::  j  !<
+       INTEGER(iwp) ::  k  !<
+
+       REAL(wp) ::  pden  !<
+       REAL(wp) ::  pnom  !<
+       REAL(wp) ::  p1    !<
+       REAL(wp) ::  p2    !<
+       REAL(wp) ::  p3    !<
+       REAL(wp) ::  pt1   !<
+       REAL(wp) ::  pt2   !<
+       REAL(wp) ::  pt3   !<
+       REAL(wp) ::  pt4   !<
+       REAL(wp) ::  sa1   !<
+       REAL(wp) ::  sa15  !<
+       REAL(wp) ::  sa2   !<
        
                        
@@ -180 +183 @@
 
 !------------------------------------------------------------------------------!
-! Call for grid point i,j
+! Description:
+! ------------
+!> Call for grid point i,j
 !------------------------------------------------------------------------------!
     SUBROUTINE eqn_state_seawater_ij( i, j )
@@ -251 +256 @@
 
 !------------------------------------------------------------------------------!
-! Equation of state as a function
+! Description:
+! ------------
+!> Equation of state as a function
 !------------------------------------------------------------------------------!
     REAL(wp) FUNCTION eqn_state_seawater_func( p, pt, sa )
@@ -257 +264 @@
        IMPLICIT NONE
 
-       REAL(wp) ::  p      !:
-       REAL(wp) ::  p1     !:
-       REAL(wp) ::  p2     !:
-       REAL(wp) ::  p3     !:
-       REAL(wp) ::  pt     !:
-       REAL(wp) ::  pt1    !:
-       REAL(wp) ::  pt2    !:
-       REAL(wp) ::  pt3    !:
-       REAL(wp) ::  pt4    !:
-       REAL(wp) ::  sa     !:
-       REAL(wp) ::  sa15   !:
-       REAL(wp) ::  sa2    !:
+       REAL(wp) ::  p      !<
+       REAL(wp) ::  p1     !<
+       REAL(wp) ::  p2     !<
+       REAL(wp) ::  p3     !<
+       REAL(wp) ::  pt     !<
+       REAL(wp) ::  pt1    !<
+       REAL(wp) ::  pt2    !<
+       REAL(wp) ::  pt3    !<
+       REAL(wp) ::  pt4    !<
+       REAL(wp) ::  sa     !<
+       REAL(wp) ::  sa15   !<
+       REAL(wp) ::  sa2    !<
 
 !