diff --git a/test/boxmodels/2p/lensproblem.hh b/test/boxmodels/2p/lensproblem.hh
index 0c1ece20446654c4fcc33247e6c280e2399b5646..dfb92bc49d3fc7674fdc7ae277c62ade192313a8 100644
--- a/test/boxmodels/2p/lensproblem.hh
+++ b/test/boxmodels/2p/lensproblem.hh
@@ -15,6 +15,13 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Soil contamination problem where DNAPL infiltrates a fully
+ * water saturated medium.
+ */
+
#ifndef DUMUX_LENSPROBLEM_HH
#define DUMUX_LENSPROBLEM_HH
@@ -116,7 +123,7 @@ SET_BOOL_PROP(LensProblem, EnableGravity, true);
/*!
* \ingroup TwoPBoxProblems
- * \brief Soil decontamination problem where DNAPL infiltrates a fully
+ * \brief Soil contamination problem where DNAPL infiltrates a fully
* water saturated medium.
*
* The domain is sized 6m times 4m and features a rectangular lens
@@ -196,6 +203,14 @@ class LensProblem : public TwoPProblem<TypeTag>
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
+ /*!
+ * \brief The constructor
+ *
+ * \param timeManager The time manager
+ * \param gridView The grid view
+ * \param lensLowerLeft Global position of the lenses lower left corner
+ * \param lensUpperRight Global position of the lenses upper right corner
+ */
LensProblem(TimeManager &timeManager,
const GridView &gridView,
const GlobalPosition &lensLowerLeft,
@@ -236,6 +251,10 @@ public:
/*!
* \brief Returns the temperature within the domain.
*
+ * \param element The element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index (SCV index)
+ *
* This problem assumes a temperature of 10 degrees Celsius.
*/
Scalar temperature(const Element &element,
@@ -255,6 +274,13 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
+ *
+ * \param values The boundary types for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
*/
void boundaryTypes(BoundaryTypes &values,
const Element &element,
@@ -280,6 +306,13 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
+ * \param values The dirichlet values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores primary variables.
*/
void dirichlet(PrimaryVariables &values,
@@ -323,6 +356,13 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
+ * \param values The neumann values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores the mass flux
* in normal direction of each phase. Negative values mean influx.
*/
@@ -352,6 +392,10 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
+ * \param values The source and sink values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ *
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
* that mass is created, negative ones mean that it vanishes.
@@ -367,6 +411,11 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
+ * \param values The initial values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index
+ *
* For this method, the \a values parameter stores primary
* variables.
*/
diff --git a/test/boxmodels/2p2c/injectionproblem.hh b/test/boxmodels/2p2c/injectionproblem.hh
index df5ac69d2923c99ee0a12c16fd98580686cf2c23..1b346e12f5151da137c0663a58ea1e726f02658b 100644
--- a/test/boxmodels/2p2c/injectionproblem.hh
+++ b/test/boxmodels/2p2c/injectionproblem.hh
@@ -15,12 +15,12 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
-/**
- * @file
- * \ingroup TwoPTwoCBoxProblems
- * @brief Definition of a problem, where air is injected under a low permeable layer
- * @author Klaus Mosthaf, Andreas Lauser, Bernd Flemisch
+/*!
+ * \file
+ *
+ * \brief Definition of a problem, where air is injected under a low permeable layer.
*/
+
#ifndef DUMUX_INJECTIONPROBLEM_HH
#define DUMUX_INJECTIONPROBLEM_HH
@@ -151,6 +151,12 @@ class InjectionProblem : public TwoPTwoCProblem<TypeTag>
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
+ /*!
+ * \brief The constructor
+ *
+ * \param timeManager The time manager
+ * \param gridView The grid view
+ */
InjectionProblem(TimeManager &timeManager, const GridView &gridView)
: ParentType(timeManager, gridView)
{
@@ -192,6 +198,10 @@ public:
/*!
* \brief Returns the temperature within the domain.
*
+ * \param element The element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index (SCV index)
+ *
* This problem assumes a temperature of 10 degrees Celsius.
*/
Scalar temperature(const Element &element,
@@ -211,6 +221,13 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
+ *
+ * \param values The boundary types for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
*/
void boundaryTypes(BoundaryTypes &values,
const Element &element,
@@ -231,6 +248,13 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
+ * \param values The dirichlet values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores primary variables.
*/
void dirichlet(PrimaryVariables &values,
@@ -249,9 +273,15 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
+ * \param values The neumann values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores the mass flux
- * in normal direction of each component. Negative values mean
- * influx.
+ * in normal direction of each phase. Negative values mean influx.
*/
void neumann(PrimaryVariables &values,
const Element &element,
@@ -279,10 +309,13 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
+ * \param values The source and sink values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ *
* For this method, the \a values parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
+ * generated or annihilate per volume unit. Positive values mean
+ * that mass is created, negative ones mean that it vanishes.
*/
void source(PrimaryVariables &values,
const Element &element,
@@ -295,6 +328,11 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
+ * \param values The initial values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index
+ *
* For this method, the \a values parameter stores primary
* variables.
*/
@@ -310,6 +348,10 @@ public:
/*!
* \brief Return the initial phase state inside a control volume.
+ *
+ * \param vert The vertex
+ * \param globalIdx The index of the global vertex
+ * \param globalPos The global position
*/
int initialPhasePresence(const Vertex &vert,
int &globalIdx,
diff --git a/test/boxmodels/2p2cni/waterairproblem.hh b/test/boxmodels/2p2cni/waterairproblem.hh
index 3e6ec4f7931dee22f282d65c1b048b3f5b367199..9f43629d4d0a66f718aa261abaf16755637bd055 100644
--- a/test/boxmodels/2p2cni/waterairproblem.hh
+++ b/test/boxmodels/2p2cni/waterairproblem.hh
@@ -14,6 +14,12 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+
+/*!
+ * \file
+ *
+ * \brief TwoPTwoCNIBoxProblems Non-isothermal two-phase two-component box problems.
+ */
#ifndef DUMUX_WATERAIRPROBLEM_HH
#define DUMUX_WATERAIRPROBLEM_HH
@@ -165,6 +171,12 @@ class WaterAirProblem : public TwoPTwoCNIProblem<TypeTag>
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
+ /*!
+ * \brief The constructor
+ *
+ * \param timeManager The time manager
+ * \param gridView The grid view
+ */
WaterAirProblem(TimeManager &timeManager, const GridView &gridView)
: ParentType(timeManager, gridView)
{
@@ -188,6 +200,10 @@ public:
/*!
* \brief Returns the temperature within the domain.
*
+ * \param element The element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index (SCV index)
+ *
* This problem assumes a temperature of 10 degrees Celsius.
*/
Scalar temperature(const Element &element,
@@ -208,6 +224,13 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
+ *
+ * \param values The boundary types for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
*/
void boundaryTypes(BoundaryTypes &values,
const Element &element,
@@ -232,6 +255,13 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
+ * \param values The dirichlet values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores primary variables.
*/
void dirichlet(PrimaryVariables &values,
@@ -253,9 +283,15 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
+ * \param values The neumann values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores the mass flux
- * in normal direction of each component. Negative values mean
- * influx.
+ * in normal direction of each phase. Negative values mean influx.
*/
void neumann(PrimaryVariables &values,
const Element &element,
@@ -286,10 +322,13 @@ public:
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
+ * \param values The source and sink values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ *
* For this method, the \a values parameter stores the rate mass
- * of a component is generated or annihilate per volume
- * unit. Positive values mean that mass is created, negative ones
- * mean that it vanishes.
+ * generated or annihilate per volume unit. Positive values mean
+ * that mass is created, negative ones mean that it vanishes.
*/
void source(PrimaryVariables &values,
const Element &element,
@@ -302,6 +341,11 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
+ * \param values The initial values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index
+ *
* For this method, the \a values parameter stores primary
* variables.
*/
@@ -322,6 +366,10 @@ public:
/*!
* \brief Return the initial phase state inside a control volume.
+ *
+ * \param vert The vertex
+ * \param globalIdx The index of the global vertex
+ * \param globalPos The global position
*/
int initialPhasePresence(const Vertex &vert,
int &globalIdx,
diff --git a/test/boxmodels/2pni/injectionproblem2pni.hh b/test/boxmodels/2pni/injectionproblem2pni.hh
index 843e85f97db42804f439947cd7660fad2fb1618f..181b5609c3cfec3c013ca171ca304729e79b21de 100644
--- a/test/boxmodels/2pni/injectionproblem2pni.hh
+++ b/test/boxmodels/2pni/injectionproblem2pni.hh
@@ -14,6 +14,14 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Nonisothermal gas injection problem where a gas (e.g. air) is injected into a fully
+ * water saturated medium. During buoyancy driven upward migration the gas
+ * passes a high temperature area.
+ */
+
#ifndef DUMUX_INJECTIONPROBLEM2PNI_HH
#define DUMUX_INJECTIONPROBLEM2PNI_HH
@@ -192,6 +200,12 @@ class InjectionProblem2PNI
typedef Dune::FieldVector<Scalar, dimWorld> GlobalPosition;
public:
+ /*!
+ * \brief The constructor
+ *
+ * \param timeManager The time manager
+ * \param gridView The grid view
+ */
InjectionProblem2PNI(TimeManager &timeManager, const GridView &gridView)
: ParentType(timeManager, gridView)
{
@@ -212,6 +226,24 @@ public:
const char *name() const
{ return "injection2pni"; }
+#if ISOTHERMAL
+ /*!
+ * \brief Returns the temperature within the domain.
+ *
+ * \param element The element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index (SCV index)
+ *
+ * This problem assumes a temperature of 10 degrees Celsius.
+ */
+ Scalar temperature(const Element &element,
+ const FVElementGeometry &fvElemGeom,
+ int scvIdx) const
+ {
+ return 273.15 + 30; // [K]
+ };
+#endif
+
// \}
/*!
@@ -222,6 +254,13 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
+ *
+ * \param values The boundary types for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
*/
void boundaryTypes(BoundaryTypes &values,
const Element &element,
@@ -248,6 +287,13 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
+ * \param values The dirichlet values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores primary variables.
*/
void dirichlet(PrimaryVariables &values,
@@ -271,6 +317,13 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
+ * \param values The neumann values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param is The intersection between element and boundary
+ * \param scvIdx The local vertex index
+ * \param boundaryFaceIdx The index of the boundary face
+ *
* For this method, the \a values parameter stores the mass flux
* in normal direction of each phase. Negative values mean influx.
*/
@@ -292,29 +345,20 @@ public:
// \}
+
/*!
* \name Volume terms
*/
// \{
-#if ISOTHERMAL
- /*!
- * \brief Returns the temperature within the domain.
- *
- * This problem assumes a temperature of 30 degrees Celsius.
- */
- Scalar temperature(const Element &element,
- const FVElementGeometry &fvElemGeom,
- int scvIdx) const
- {
- return 273.15 + 30; // [K]
- };
-#endif
-
/*!
* \brief Evaluate the source term for all phases within a given
* sub-control-volume.
*
+ * \param values The source and sink values for the conservation equations
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ *
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
* that mass is created, negative ones mean that it vanishes.
@@ -330,6 +374,11 @@ public:
/*!
* \brief Evaluate the initial value for a control volume.
*
+ * \param values The initial values for the primary variables
+ * \param element The finite element
+ * \param fvElemGeom The finite-volume geometry in the box scheme
+ * \param scvIdx The local vertex index
+ *
* For this method, the \a values parameter stores primary
* variables.
*/