<p><b>duda</b> 2013-03-29 16:56:03 -0600 (Fri, 29 Mar 2013)</p><p>BRANCH COMMIT<br>
<br>
Add comments to mpas_constants module to match trunk.<br>
<br>
No change to results.<br>
<br>
<br>
M src/framework/mpas_constants.F<br>
</p><hr noshade><pre><font color="gray">Modified: branches/atmos_physics/src/framework/mpas_constants.F
===================================================================
--- branches/atmos_physics/src/framework/mpas_constants.F        2013-03-29 17:53:40 UTC (rev 2683)
+++ branches/atmos_physics/src/framework/mpas_constants.F        2013-03-29 22:56:03 UTC (rev 2684)
@@ -1,3 +1,17 @@
+!***********************************************************************
+!
+! mpas_constants
+!
+!> \brief MPAS Constant Module
+!> \author Michael Duda
+!> \date 03/27/13
+!> \version SVN:$Id$
+!> \details
+!> This module provides various constants that can be used in different parts of MPAS.
+!> They may or may not be a physical quantity.
+!
+!-----------------------------------------------------------------------
+
module mpas_constants
use mpas_kind_types
@@ -2,17 +16,30 @@
- real (kind=RKIND), parameter :: pii = 3.141592653589793
- real (kind=RKIND), parameter :: a = 6371229.0
- real (kind=RKIND), parameter :: omega = 7.29212e-5
- real (kind=RKIND), parameter :: gravity = 9.80616
- real (kind=RKIND), parameter :: rgas = 287.
- real (kind=RKIND), parameter :: rv = 461.6
- real (kind=RKIND), parameter :: rvord = rv/rgas
- real (kind=RKIND), parameter :: cp = 1003.
- real (kind=RKIND), parameter :: cv = cp - rgas
- real (kind=RKIND), parameter :: cvpm = -cv/cp
- real (kind=RKIND), parameter :: prandtl = 1.0
+ real (kind=RKIND), parameter :: pii = 3.141592653589793 !< Constant: Pi
+ real (kind=RKIND), parameter :: a = 6371229.0 !< Constant: Spherical Earth radius [m]
+ real (kind=RKIND), parameter :: omega = 7.29212e-5 !< Constant: Angular rotation rate of the Earth [s-1]
+ real (kind=RKIND), parameter :: gravity = 9.80616 !< Constant: Acceleration due to gravity [m s-2]
+ real (kind=RKIND), parameter :: rgas = 287.0 !< Constant: Gas constant for dry air [J kg-1 K-1]
+ real (kind=RKIND), parameter :: rv = 461.6 !< Constant: Gas constant for water vapor [J kg-1 K-1]
+ real (kind=RKIND), parameter :: rvord = rv/rgas !
+ real (kind=RKIND), parameter :: cp = 1003.0 !< Constant: Specific heat of dry air at constant pressure [J kg-1 K-1]
+ real (kind=RKIND), parameter :: cv = cp - rgas !< Constant: Specific heat of dry air at constant volume [J kg-1 K-1]
+ real (kind=RKIND), parameter :: cvpm = -cv/cp !
+ real (kind=RKIND), parameter :: prandtl = 1.0 !< Constant: Prandtl number
contains
+
+!***********************************************************************
+!
+! routine dummy
+!
+!> \brief MPAS Dummy Routine
+!> \author Michael Duda
+!> \date 03/27/13
+!> \version SVN:$Id$
+!> \details
+!> This is a dummy routine that doesn't do anything.
+!
+!-----------------------------------------------------------------------
subroutine dummy()
</font>
</pre>