From 2cd1a1227e1a8b58d5118e3e8b22b6a8f1d3e8e7 Mon Sep 17 00:00:00 2001
From: Simon Scholz <simon.scholz@iws.uni-stuttgart.de>
Date: Mon, 18 Dec 2017 18:21:25 +0100
Subject: [PATCH] [1p][sequential] fix doxygen to correct format in all 1p
sequential files, not everything properly documented yet
---
.../1p/sequential/celldata.hh | 14 ++++++------
.../diffusion/cellcentered/pressure.hh | 9 ++++----
.../cellcentered/pressureproperties.hh | 7 +-----
.../cellcentered/pressurevelocity.hh | 13 ++++++-----
.../pressurevelocityproperties.hh | 6 +----
.../diffusion/cellcentered/velocity.hh | 9 ++++----
.../1p/sequential/diffusion/problem.hh | 10 +++++----
.../1p/sequential/diffusion/properties.hh | 5 +----
.../1p/sequential/fluxdata.hh | 22 +++++++++++--------
.../porousmediumflow/1p/sequential/indices.hh | 6 ++---
.../1p/sequential/properties.hh | 12 +++++-----
11 files changed, 54 insertions(+), 59 deletions(-)
diff --git a/dumux/porousmediumflow/1p/sequential/celldata.hh b/dumux/porousmediumflow/1p/sequential/celldata.hh
index f43cefc08f..ddf7d54319 100644
--- a/dumux/porousmediumflow/1p/sequential/celldata.hh
+++ b/dumux/porousmediumflow/1p/sequential/celldata.hh
@@ -22,9 +22,10 @@
#include "properties.hh"
#include "fluxdata.hh"
-/**
+/*!
* \file
- * \brief Class including data of one grid cell
+ * \ingroup SequentialOnePModel
+ * \brief Class including data of one grid cell.
*/
namespace Dumux
@@ -33,11 +34,10 @@ template<class TypeTag>
class FluxData1P;
/*!
- * \ingroup OnePhase
- */
-//! Class including data of one grid cell.
-/*! The variables of one-phase flow, which are the pressure as well as additional data assigned to
- *! cell-cell interfaces, so-called flux-data, are stored.
+ * \ingroup SequentialOnePModel
+ * Class including data of one grid cell.
+ * The variables of one-phase flow, which are the pressure as well as additional data assigned to
+ * cell-cell interfaces, so-called flux-data, are stored.
*
* \tparam TypeTag The problem TypeTag
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
index 753b81367d..2426d68bb0 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
@@ -26,15 +26,16 @@
/**
* \file
- * \brief Single Phase Finite Volume Model
+ * \ingroup SequentialOnePModel
+ * \brief Sequential OneP Model solving the equations for pressure and velocity seperately.
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single Phase Finite Volume Model
-/*! This model solves equations of the form
+/*! \ingroup SequentialOnePModel
+ * \brief Sequential OneP Model solving the equations for pressure and velocity seperately.
+ * This model solves equations of the form
* \f[
* \text{div}\, \boldsymbol v = q.
* \f]
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
index f905a8b35f..c5fe24e973 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
@@ -16,14 +16,9 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
-
-/*!
- * \ingroup FV1p
- * \ingroup Properties
- */
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for finite volume pressure models
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
index a7b910dad2..16c4d8081e 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
@@ -25,17 +25,18 @@
#include <dumux/porousmediumflow/1p/sequential/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/velocity.hh>
-/**
+/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Single Phase Finite Volume Model
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single Phase Finite Volume Model
-/*! This model solves equations of the form
+/*! \ingroup SequentialOnePModel
+ * \brief Single Phase Finite Volume Model
+ * This model solves equations of the form
* \f[
* \textbf{div}\, \boldsymbol v = q.
* \f]
@@ -93,8 +94,8 @@ public:
velocity_.addOutputVtkFields(writer);
}
- //! Constructs a FVPressure1P object
- /**
+ /*! Constructs a FVPressure1P object
+ *
* \param problem A problem class object
*/
FVPressureVelocity1P(Problem& problem) :
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
index eaba8ee5fe..2c65f64449 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
@@ -17,13 +17,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
-/*!
- * \ingroup FV1p
- * \ingroup Properties
- */
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for finite volume pressure models
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
index 994b7b2eee..6a805b55e1 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
@@ -21,17 +21,18 @@
#include<dumux/porousmediumflow/1p/sequential/properties.hh>
-/**
+/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Single phase finite volume velocity reconstruction
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single phase finite volume velocity reconstruction
-/*! Calculates velocities from a known pressure field applying a finite volume discretization.
+/*! \ingroup SequentialOnePModel
+ * \brief Single phase finite volume velocity reconstruction
+ * Calculates velocities from a known pressure field applying a finite volume discretization.
* The pressure has to be given as piecewise constant cell values.
* The velocity is calculated following Darcy's law as
* \f[
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh b/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
index ebc0d58246..796dc316ec 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Base class for all single phase diffusion problem
*/
#ifndef DUMUX_DIFFUSIONPROBLEM_1P_HH
@@ -35,9 +36,7 @@ namespace Properties
SET_TYPE_PROP(PressureOneP, Model, typename GET_PROP_TYPE(TypeTag, PressureModel));
}
/*!
- * \ingroup Pressure1P
- * \ingroup IMPETproblems
- *
+ * \ingroup SequentialOnePModel
* \brief Base class for all single phase diffusion problem
*
* \tparam TypeTag The Type Tag
@@ -81,6 +80,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief Constructs a DiffusionProblem1P object
*
@@ -96,6 +96,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief The constructor
*
@@ -109,6 +110,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief The constructor
*
@@ -233,7 +235,7 @@ private:
Implementation &asImp_()
{ return *static_cast<Implementation *>(this); }
- //! \copydoc IMPETProblem::asImp_()
+ //! \copydoc SequentialOnePModel::asImp_()
const Implementation &asImp_() const
{ return *static_cast<const Implementation *>(this); }
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
index 992674d10b..102324f37e 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
@@ -22,12 +22,9 @@
#include <dumux/porousmediumflow/sequential/pressureproperties.hh>
#include <dumux/porousmediumflow/1p/sequential/properties.hh>
-/*!
- * \ingroup Pressure1p
- * \ingroup IMPETProperties
- */
/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Specifies the properties for 1p pressure models
*/
namespace Dumux
diff --git a/dumux/porousmediumflow/1p/sequential/fluxdata.hh b/dumux/porousmediumflow/1p/sequential/fluxdata.hh
index 6ac753247d..dc8b9883a6 100644
--- a/dumux/porousmediumflow/1p/sequential/fluxdata.hh
+++ b/dumux/porousmediumflow/1p/sequential/fluxdata.hh
@@ -21,22 +21,22 @@
#include "properties.hh"
-/**
+/*!
* \file
- * \brief Class storing data assigned to a cell-cell interfaces, so-called flux-data
+ * \ingroup SequentialOnePModel
+ * \brief Class storing data assigned to a cell-cell interfaces, so-called flux-data.
*/
namespace Dumux
{
/*!
- * \ingroup OnePhase
+ * \ingroup SequentialOnePModel
+ * Class storing data assigned to a cell-cell interfaces, so-called flux-data.
+ * Stores velocities and potentials at cell-cell interfaces.
+ * Further it provides methods which interpret stored phase potentials for upwind decisions.
+ *
+ * \tparam TypeTag The problem TypeTag
*/
-//! Class storing data assigned to a cell-cell interfaces, so-called flux-data.
-/*! Stores velocities and potentials at cell-cell interfaces.
- * Further it provides methods which interpret stored phase potentials for upwind decisions.
-*
-* \tparam TypeTag The problem TypeTag
-*/
template<class TypeTag>
class FluxData1P
{
@@ -81,6 +81,7 @@ public:
{
return velocity_[indexInInside];
}
+
/*! \brief Returns the velocity vector at a cell-cell interface
*
* \param indexInInside Index of the cell-cell interface in this cell
@@ -89,6 +90,7 @@ public:
{
return velocity_[indexInInside];
}
+
/*! \brief Sets the velocity vector at a cell-cell interface
*
* \param indexInInside Index of the cell-cell interface in this cell
@@ -98,6 +100,7 @@ public:
{
velocity_[indexInInside] = velocity;
}
+
//!Resets velocities and potentials
void resetVelocity()
{
@@ -141,6 +144,7 @@ public:
*
* \param indexInInside Index of the cell-cell interface in this cell
*/
+
bool isUpwindCell(int indexInInside)
{
return (potential_[indexInInside] >= 0.);
diff --git a/dumux/porousmediumflow/1p/sequential/indices.hh b/dumux/porousmediumflow/1p/sequential/indices.hh
index a66924104e..515ae78aef 100644
--- a/dumux/porousmediumflow/1p/sequential/indices.hh
+++ b/dumux/porousmediumflow/1p/sequential/indices.hh
@@ -19,7 +19,7 @@
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the indices required for the sequential one-phase model.
*/
#ifndef DUMUX_SEQUENTIAL_1P_INDICES_HH
@@ -28,7 +28,7 @@
namespace Dumux
{
/*!
- * \ingroup OnePhase
+ * \ingroup SequentialOnePModel
*/
// \{
@@ -37,7 +37,7 @@ namespace Dumux
*/
struct SequentialOnePCommonIndices
{
- static const int pressureEqIdx = 0;//!< Index of the pressure equation
+ static const int pressureEqIdx = 0; //!< Index of the pressure equation
};
// \}
diff --git a/dumux/porousmediumflow/1p/sequential/properties.hh b/dumux/porousmediumflow/1p/sequential/properties.hh
index 9e9569817a..3a31c9de05 100644
--- a/dumux/porousmediumflow/1p/sequential/properties.hh
+++ b/dumux/porousmediumflow/1p/sequential/properties.hh
@@ -18,10 +18,8 @@
*****************************************************************************/
/*!
- * \ingroup OnePhase
- * \ingroup IMPETProperties
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for the single phase sequential model.
*/
@@ -58,10 +56,10 @@ NEW_TYPE_TAG(SequentialOneP, INHERITS_FROM(SequentialModel));
// Property tags
//////////////////////////////////////////////////////////////////
-NEW_PROP_TAG( SpatialParams ); //!< The type of the spatial parameters object
-NEW_PROP_TAG( Fluid ); //!< The fluid for one-phase models
-NEW_PROP_TAG( Indices ); //!< Set of indices for the one-phase model
-NEW_PROP_TAG( CellData ); //!< The cell data storage class
+NEW_PROP_TAG( SpatialParams ); //!< The type of the spatial parameters object
+NEW_PROP_TAG( Fluid ); //!< The fluid for one-phase models
+NEW_PROP_TAG( Indices ); //!< Set of indices for the one-phase model
+NEW_PROP_TAG( CellData ); //!< The cell data storage class
}
}
--
GitLab