Commit cf6f6a14 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[docu] generalized the docu/ function description


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12665 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent b6242059
......@@ -257,7 +257,7 @@ public:
* are specific to the fully-implicit method.
*
* \param values The neumann values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^{\textrm{dim}-1} \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param intersection The intersection between element and boundary
......@@ -290,7 +290,7 @@ public:
* boundary segment.
*
* \param values The neumann values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^{\textrm{dim}-1} \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param intersection The intersection between element and boundary
......@@ -316,7 +316,7 @@ public:
* boundary segment.
*
* \param values The neumann values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^2 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^{\textrm{dim}-1} \cdot s )] \f$
* \param globalPos The position of the boundary face's integration point in global coordinates
*
* For this method, the \a values parameter stores the mass flux
......@@ -342,7 +342,7 @@ public:
* are specific to the fully-implicit method.
*
* \param values The source and sink values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^\textrm{dim} \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param scvIdx The local subcontrolvolume index
......@@ -367,7 +367,7 @@ public:
* sub-control-volume.
*
* \param values The source and sink values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^\textrm{dim} \cdot s )] \f$
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param scvIdx The local subcontrolvolume index
......@@ -390,7 +390,7 @@ public:
* sub-control-volume.
*
* \param values The source and sink values for the conservation equations in units of
* \f$ [ \textnormal{unit of conserved quantity} / (m^3 \cdot s )] \f$
* \f$ [ \textnormal{unit of conserved quantity} / (m^\textrm{dim} \cdot s )] \f$
* \param globalPos The position of the center of the finite volume
* for which the source term ought to be
* specified in global coordinates
......
......@@ -128,6 +128,9 @@ public:
coarseMaterialParams_.setLambda(2.0);
}
/*!
* \brief The destructor
*/
~InjectionSpatialParams()
{}
......@@ -167,7 +170,8 @@ public:
/*!
* \brief Returns the parameter object for the Brooks-Corey material law
* \brief Returns the parameter object for the capillary-pressure/
* saturation material law
*
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
......@@ -204,7 +208,6 @@ public:
* (1 - porosity(element, fvGeometry, scvIdx));
}
/*!
* \brief Returns the thermal conductivity \f$[W/m^2]\f$ of the solid
*
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment