<p><b>dwj07@fsu.edu</b> 2011-09-30 11:04:51 -0600 (Fri, 30 Sep 2011)</p><p><br>
-- BRANCH COMMIT --<br>
<br>
Cleaning up doxygen comment flags for variables that are input/output variables.<br>
</p><hr noshade><pre><font color="gray">Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_restoring.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_restoring.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_restoring.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -42,9 +42,9 @@
!
!--------------------------------------------------------------------
- logical :: restoringOn
+ logical :: restoringOn !< Flag to turn on/off resotring
- real (kind=RKIND) :: temperatureTimeScale, salinityTimeScale
+ real (kind=RKIND) :: temperatureTimeScale, salinityTimeScale !< restoring timescales
!***********************************************************************
@@ -82,7 +82,8 @@
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracer quantities
- integer, intent(in) :: indexT, indexS
+ integer, intent(in) :: indexT !< Input: index for temperature
+ integer, intent(in) :: indexS !< Input: index for salinity
!-----------------------------------------------------------------
!
@@ -99,7 +100,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
!-----------------------------------------------------------------
!
@@ -111,14 +112,6 @@
real (kind=RKIND), dimension(:), pointer :: temperatureRestore, salinityRestore
- !-----------------------------------------------------------------
- !
- ! call relevant routines for computing tendencies
- ! note that the user can choose multiple options and the
- ! tendencies will be added together
- !
- !-----------------------------------------------------------------
-
err = 0
if(.not.restoringOn) return
@@ -154,31 +147,20 @@
!
! routine ocn_restoring_init
!
-!> \brief Initializes ocean tracer horizontal mixing quantities
+!> \brief Initializes ocean tracer restoring
!> \author Doug Jacobsen
!> \date 19 September 2011
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> horizontal velocity mixing in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> restoring in the ocean.
!
!-----------------------------------------------------------------------
-
subroutine ocn_restoring_init(err)!{{{
- !--------------------------------------------------------------------
+ integer, intent(out) :: err !< Output: error flag
- !-----------------------------------------------------------------
- !
- ! call individual init routines for each parameterization
- !
- !-----------------------------------------------------------------
-
- integer, intent(out) :: err
-
err = 0
restoringOn = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_hadv.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_hadv.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_hadv.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -93,7 +93,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -172,15 +172,13 @@
!
! routine ocn_thick_hadv_init
!
-!> \brief Initializes ocean forcings
+!> \brief Initializes ocean horizontal thickness advection
!> \author Doug Jacobsen
!> \date 16 September 2011
!> \version SVN:$Id$
!> \details
-!> This routine initializes quantities related to forcings
-!> in the ocean. Since a multiple forcings are available,
-!> this routine primarily calls the
-!> individual init routines for each forcing.
+!> This routine initializes quantities related to horizontal thickness
+!> advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -194,7 +192,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_vadv.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_vadv.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_thick_vadv.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -90,7 +90,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
!-----------------------------------------------------------------
!
@@ -127,15 +127,13 @@
!
! routine ocn_thick_vadv_init
!
-!> \brief Initializes ocean forcings
+!> \brief Initializes ocean thickness vertical advection
!> \author Doug Jacobsen
!> \date 16 September 2011
!> \version SVN:$Id$
!> \details
-!> This routine initializes quantities related to forcings
-!> in the ocean. Since a multiple forcings are available,
-!> this routine primarily calls the
-!> individual init routines for each forcing.
+!> This routine initializes quantities related to vertical advection of
+!> thickness in the ocean.
!
!-----------------------------------------------------------------------
@@ -149,7 +147,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -104,7 +104,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
!-----------------------------------------------------------------
!
@@ -158,7 +158,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
integer :: err1, err2, err3
@@ -177,3 +177,4 @@
end module ocn_tracer_hadv
!|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+! vim: foldmetho=marker
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv2.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv2.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv2.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -43,7 +43,7 @@
!
!--------------------------------------------------------------------
- logical :: hadv2On
+ logical :: hadv2On !< Flag to turn on/off 2nd order hadv
!***********************************************************************
@@ -53,17 +53,13 @@
!
! routine ocn_tracer_hadv2_tend
!
-!> \brief Computes tendency term for horizontal tracer advection
+!> \brief Computes tendency term for horizontal tracer advection 2nd order
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the horizontal advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 2nd order formulation.
!
!-----------------------------------------------------------------------
@@ -76,7 +72,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- u !< Input: velocity
+ u !< Input: tracer
real (kind=RKIND), dimension(:,:), intent(in) :: &
h_edge !< Input: thickness at edge
@@ -94,7 +90,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -102,7 +98,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
!-----------------------------------------------------------------
!
@@ -168,9 +164,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> horizontal velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 2nd order horizontal tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -184,7 +178,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
err = 0
hadv2On = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv3.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv3.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv3.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -43,8 +43,8 @@
!
!--------------------------------------------------------------------
- logical :: hadv3On
- real (kind=RKIND) :: coef_3rd_order
+ logical :: hadv3On !< Flag to turn on/off 3rd order hadv
+ real (kind=RKIND) :: coef_3rd_order !< Coefficient for 3rd order hadv
!***********************************************************************
@@ -54,17 +54,13 @@
!
! routine ocn_tracer_hadv3_tend
!
-!> \brief Computes tendency term for horizontal tracer advection
+!> \brief Computes tendency term for horizontal tracer advection 3rd order
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the horizontal advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 3rd order formulation.
!
!-----------------------------------------------------------------------
@@ -77,7 +73,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- u !< Input: velocity
+ u !< Input: tracer
real (kind=RKIND), dimension(:,:), intent(in) :: &
h_edge !< Input: thickness at edge
@@ -95,7 +91,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -103,7 +99,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -214,9 +210,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> horizontal velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 3rd order horizontal tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -230,7 +224,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
hadv3On = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv4.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv4.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hadv4.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -43,7 +43,7 @@
!
!--------------------------------------------------------------------
- logical :: hadv4On
+ logical :: hadv4On !< Flag to turning on/off 4th order hadv
!***********************************************************************
@@ -53,17 +53,13 @@
!
! routine ocn_tracer_hadv4_tend
!
-!> \brief Computes tendency term for horizontal tracer advection
+!> \brief Computes tendency term for horizontal tracer advection 4th order
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the horizontal advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 4th order formulation.
!
!-----------------------------------------------------------------------
@@ -76,7 +72,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- u !< Input: velocity
+ u !< Input: tracer
real (kind=RKIND), dimension(:,:), intent(in) :: &
h_edge !< Input: thickness at edge
@@ -94,7 +90,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -102,7 +98,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -201,10 +197,8 @@
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
-!> This routine initializes a variety of quantities related to
-!> horizontal velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> This routine initializes the 4th order formulation for
+!> horizontal tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -218,7 +212,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: Error flag
err = 0
hadv4On = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -101,7 +101,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -154,7 +154,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del2.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del2.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del2.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -100,7 +100,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -209,7 +209,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del4.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del4.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_hmix_del4.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -100,7 +100,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -241,7 +241,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Del4on = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -79,7 +79,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -94,7 +94,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -102,7 +102,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -143,7 +143,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
+!> vertical tracer advection in the ocean. Since a variety of
!> parameterizations are available, this routine primarily calls the
!> individual init routines for each parameterization.
!
@@ -159,7 +159,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -79,7 +79,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -94,7 +94,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -102,7 +102,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -143,7 +143,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
+!> vertical tracer advection in the ocean. Since a variety of
!> parameterizations are available, this routine primarily calls the
!> individual init routines for each parameterization.
!
@@ -159,7 +159,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline2.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline2.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline2.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -54,17 +54,13 @@
!
! routine ocn_tracer_vadv_spline2_tend
!
-!> \brief Computes tendency term for vertical tracer advection
+!> \brief Computes tendency term for vertical tracer advection 2nd order spline
!> \author Doug Jacobsen
!> \date 16 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 2nd order spline.
!
!-----------------------------------------------------------------------
@@ -77,7 +73,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -92,7 +88,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -100,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -181,9 +177,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 2nd order spline based vertical tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -197,7 +191,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline3.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline3.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_spline3.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -55,17 +55,13 @@
!
! routine ocn_tracer_vadv_spline3_tend
!
-!> \brief Computes tendency term for vertical tracer advection
+!> \brief Computes tendency term for vertical tracer advection 3rd order spline
!> \author Doug Jacobsen
!> \date 16 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 3rd order spline.
!
!-----------------------------------------------------------------------
@@ -78,7 +74,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -93,7 +89,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -101,7 +97,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -210,9 +206,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 3rd order spline based vertical tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -226,7 +220,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -62,8 +62,8 @@
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
-!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
+!> This routine computes the vertical advection tendency for tracers
+!> based on current state and user choices of stencil based advection parameterization.
!> Multiple parameterizations may be chosen and added together. These
!> tendencies are generally computed by calling the specific routine
!> for the chosen parameterization, so this routine is primarily a
@@ -80,7 +80,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -95,7 +95,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -103,7 +103,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -145,7 +145,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
+!> stencil based vertical tracer advection in the ocean. Since a variety of
!> parameterizations are available, this routine primarily calls the
!> individual init routines for each parameterization.
!
@@ -161,7 +161,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2, err3
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil2.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil2.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil2.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -54,17 +54,13 @@
!
! routine ocn_tracer_vadv_stencil2_tend
!
-!> \brief Computes tendency term for vertical tracer advection
+!> \brief Computes tendency term for vertical tracer advection 2nd order stencil
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 2nd order stencil.
!
!-----------------------------------------------------------------------
@@ -77,7 +73,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -92,7 +88,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -100,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -178,9 +174,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> a 2nd order stencil based vertical tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -194,7 +188,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2, err3
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil3.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil3.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil3.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -54,17 +54,13 @@
!
! routine ocn_tracer_vadv_stencil3_tend
!
-!> \brief Computes tendency term for vertical tracer advection
+!> \brief Computes tendency term for vertical tracer advection 3rd order stencil
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 3rd order stencil.
!
!-----------------------------------------------------------------------
@@ -77,7 +73,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -92,7 +88,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -100,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -201,9 +197,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 3rd order stencil based vertical tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -217,7 +211,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
stencil3On = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil4.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil4.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_tracer_vadv_stencil4.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -54,17 +54,13 @@
!
! routine ocn_tracer_vadv_stencil4_tend
!
-!> \brief Computes tendency term for vertical tracer advection
+!> \brief Computes tendency term for vertical tracer advection 4th order stencil
!> \author Phil Jones, Doug Jacobsen
!> \date 15 September 2011
!> \version SVN:$Id$
!> \details
!> This routine computes the vertical advection tendency for tracer
-!> based on current state and user choices of advection parameterization.
-!> Multiple parameterizations may be chosen and added together. These
-!> tendencies are generally computed by calling the specific routine
-!> for the chosen parameterization, so this routine is primarily a
-!> driver for managing these choices.
+!> based on current state using a 4th order stencil.
!
!-----------------------------------------------------------------------
@@ -77,7 +73,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- wTop !< Input: vertical velocity in top layer
+ wTop !< Input: vertical tracer in top layer
real (kind=RKIND), dimension(:,:,:), intent(in) :: &
tracers !< Input: tracers
@@ -92,7 +88,7 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:,:), intent(inout) :: &
- tend !< Input/Output: velocity tendency
+ tend !< Input/Output: tracer tendency
!-----------------------------------------------------------------
!
@@ -100,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -196,9 +192,7 @@
!> \version SVN:$Id$
!> \details
!> This routine initializes a variety of quantities related to
-!> vertical velocity advection in the ocean. Since a variety of
-!> parameterizations are available, this routine primarily calls the
-!> individual init routines for each parameterization.
+!> 4th order stencil based vertical tracer advection in the ocean.
!
!-----------------------------------------------------------------------
@@ -212,7 +206,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
stencil4On = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_coriolis.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_coriolis.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_coriolis.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -71,7 +71,13 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- pv_edge, h_edge, u, ke
+ pv_edge !< Input: Potential vorticity on edge
+ real (kind=RKIND), dimension(:,:), intent(in) :: &
+ h_edge !< Input: Thickness on edge
+ real (kind=RKIND), dimension(:,:), intent(in) :: &
+ u !< Input: Horizontal velocity
+ real (kind=RKIND), dimension(:,:), intent(in) :: &
+ ke !< Input: Kinetic Energy
type (mesh_type), intent(in) :: &
grid !< Input: grid information
@@ -169,7 +175,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -106,7 +106,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -159,7 +159,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_bottomdrag.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_bottomdrag.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_bottomdrag.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -99,7 +99,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -177,7 +177,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_windstress.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_windstress.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_forcing_windstress.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -96,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -169,7 +169,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
windStressOn = .true.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -101,7 +101,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -154,7 +154,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del2.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del2.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del2.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -64,11 +64,11 @@
!> \version SVN:$Id$
!> \details
!> This routine computes the horizontal mixing tendency for momentum
-!> based on a Laplacian form for the mixing, </font>
<font color="black">u_2 </font>
<font color="blue">abla^2 u
+!> based on a Laplacian form for the mixing, \f$</font>
<font color="black">u_2 </font>
<font color="red">abla^2 u\f$
!> This tendency takes the
-!> form </font>
<font color="black">u( </font>
<font color="black">abla divergence + k \times </font>
<font color="red">abla vorticity ),
-!> where </font>
<font color="red">u is a viscosity and k is the vertical unit vector.
-!> This form is strictly only valid for constant </font>
<font color="blue">u .
+!> form \f$</font>
<font color="black">u( </font>
<font color="black">abla divergence + k \times </font>
<font color="blue">abla vorticity )\f$,
+!> where \f$</font>
<font color="blue">u\f$ is a viscosity and \f$k\f$ is the vertical unit vector.
+!> This form is strictly only valid for constant \f$</font>
<font color="gray">u\f$ .
!
!-----------------------------------------------------------------------
@@ -105,7 +105,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -188,7 +188,7 @@
subroutine ocn_vel_hmix_del2_init(err)!{{{
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!--------------------------------------------------------------------
!
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del4.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del4.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_hmix_del4.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -66,11 +66,11 @@
!> \details
!> This routine computes the horizontal mixing tendency for momentum
!> based on a biharmonic form for the mixing. This mixing tendency
-!> takes the form -</font>
<font color="black">u_4 </font>
<font color="blue">abla^4 u
+!> takes the form \f$-</font>
<font color="black">u_4 </font>
<font color="red">abla^4 u\f$
!> but is computed as
-!> </font>
<font color="black">abla^2 u = </font>
<font color="black">abla divergence + k \times </font>
<font color="blue">abla vorticity
+!> \f$</font>
<font color="black">abla^2 u = </font>
<font color="black">abla divergence + k \times </font>
<font color="red">abla vorticity\f$
!> applied recursively.
-!> This formulation is only valid for constant </font>
<font color="blue">u_4 .
+!> This formulation is only valid for constant \f$</font>
<font color="gray">u_4\f$ .
!
!-----------------------------------------------------------------------
@@ -106,7 +106,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -265,7 +265,7 @@
subroutine ocn_vel_hmix_del4_init(err)!{{{
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!--------------------------------------------------------------------
!
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_vadv.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_vadv.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vel_vadv.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -73,7 +73,9 @@
!-----------------------------------------------------------------
real (kind=RKIND), dimension(:,:), intent(in) :: &
- u, wTop
+ u !< Input: Horizontal velocity
+ real (kind=RKIND), dimension(:,:), intent(in) :: &
+ wTop !< Input: Vertical velocity on top layer
type (mesh_type), intent(in) :: &
grid !< Input: grid information
@@ -172,7 +174,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
velVadvOn = .false.
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -104,7 +104,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -181,7 +181,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -285,7 +285,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -400,7 +400,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -510,7 +510,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -591,7 +591,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
integer :: err1, err2, err3
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_const.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_const.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_const.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -99,7 +99,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -171,9 +171,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge !< Output: vertical viscosity
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -227,9 +227,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell !< Output: Vertical diffusion
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -275,7 +275,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_rich.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_rich.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_rich.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -96,7 +96,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -196,9 +196,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge !< Output: vertical viscosity
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -300,9 +300,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell !< Output: vertical diffusions
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -393,11 +393,14 @@
type (mesh_type), intent(in) :: &
grid !< Input: grid information
- integer, intent(in) :: indexT, indexS
+ integer, intent(in) :: indexT !< Input: index for temperature
+ integer, intent(in) :: indexS !< Input: index for salinity
- real (kind=RKIND), dimension(:,:), intent(in) :: u, h, h_edge
+ real (kind=RKIND), dimension(:,:), intent(in) :: u !< Input: horizontal velocity
+ real (kind=RKIND), dimension(:,:), intent(in) :: h !< Input: thickness
+ real (kind=RKIND), dimension(:,:), intent(in) :: h_edge !< Input: thickness at edge
- real (kind=RKIND), dimension(:,:,:), intent(in) :: tracers
+ real (kind=RKIND), dimension(:,:,:), intent(in) :: tracers !< Input: tracers
!-----------------------------------------------------------------
!
@@ -411,10 +414,12 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(inout) :: rho, rhoDisplaced, &
- RiTopOfEdge, RiTopOfCell
+ real (kind=RKIND), dimension(:,:), intent(inout) :: rho !< Input/output: density
+ real (kind=RKIND), dimension(:,:), intent(inout) :: rhoDisplaced !< Input/output: displaced density
+ real (kind=RKIND), dimension(:,:), intent(inout) :: RiTopOfEdge !< Input/output: Richardson number top of cell
+ real (kind=RKIND), dimension(:,:), intent(inout) :: RiTopOfCell !< Input/output: Richardson number top of cell
- integer, intent(inout) :: err
+ integer, intent(inout) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -567,7 +572,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
Modified: branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_tanh.F
===================================================================
--- branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_tanh.F 2011-09-30 15:48:35 UTC (rev 1044)
+++ branches/ocean_projects/performance/src/core_ocean/mpas_ocn_vmix_coefs_tanh.F 2011-09-30 17:04:51 UTC (rev 1045)
@@ -93,7 +93,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -165,9 +165,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertViscTopOfEdge !< Output: Vertical viscosity
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -234,9 +234,9 @@
!
!-----------------------------------------------------------------
- real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell
+ real (kind=RKIND), dimension(:,:), intent(out) :: vertDiffTopOfCell !< Output: Vertical diffusion
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
!-----------------------------------------------------------------
!
@@ -293,7 +293,7 @@
!
!-----------------------------------------------------------------
- integer, intent(out) :: err
+ integer, intent(out) :: err !< Output: error flag
err = 0
</font>
</pre>