Commit 4a7fb791 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

cleaned up documentation

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4672 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 5e2dd340
......@@ -2,10 +2,13 @@
# please us '+=' to add file/directories to the lists
INTERNAL_DOCS = NO
EXCLUDE_PATTERNS = */.svn/*
PREDEFINED += "NEW_PROP_TAG(name)=Property tag name" \
"NEW_TYPE_TAG(name)=Type tag name" \
"NEW_TYPE_TAG(name)=Type tag name"
INPUT += @top_srcdir@/dumux
INPUT += @top_srcdir@/test
INPUT += @top_srcdir@/tutorial
INPUT += @srcdir@/mainpage \
@top_srcdir@/dumux \
@top_srcdir@/test \
@top_srcdir@/tutorial
EXTRA_PACKAGES += amsmath,amssymb
......@@ -138,7 +138,7 @@ public:
}
/*!
* \copydoc spatialParameters()
* \brief Returns the spatial parameters object.
*/
const SpatialParameters &spatialParameters() const
{
......
......@@ -141,7 +141,7 @@ public:
}
/*!
* \copydoc spatialParameters()
* \brief Returns the spatial parameters object.
*/
const SpatialParameters &spatialParameters() const
{
......
......@@ -103,7 +103,7 @@ public:
{ return spatialParameters_; }
/*!
* \copydoc spatialParameters()
* \brief Returns the spatial parameters object.
*/
const SpatialParameters &spatialParameters() const
{ return spatialParameters_; }
......
......@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief A test problem for the one-phase box model
*/
#ifndef DUMUX_1PTEST_PROBLEM_HH
#define DUMUX_1PTEST_PROBLEM_HH
......
......@@ -86,7 +86,7 @@ public:
* \brief Update the spatial parameters with the flow solution
* after a timestep.
*
* \TODO call interface
* \param globalSolution the global solution vector
*/
void update(const SolutionVector &globalSolution)
{
......@@ -97,7 +97,7 @@ public:
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
* \param scvfIdx The index sub-control volume face where the
* \param scvIdx The index of the sub-control volume
*/
const Scalar intrinsicPermeability(const Element &element,
const FVElementGeometry &fvElemGeom,
......
......@@ -385,6 +385,7 @@ public:
* \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
* \param scvIdx The local vertex index
*
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
......@@ -392,8 +393,8 @@ public:
*/
void source(PrimaryVariables &values,
const Element &element,
const FVElementGeometry &,
int subControlVolumeIdx) const
const FVElementGeometry &fvElemGeom,
int scvIdx) const
{
values = Scalar(0.0);
}
......
......@@ -106,7 +106,7 @@ SET_BOOL_PROP(InjectionProblem, EnablePartialReassemble, true);
* Air enters a water-filled aquifer, which is situated 800m below sea level, at the right boundary
* (\f$ 5m<y<15m\f$) and migrates upwards due to buoyancy. It accumulates and
* partially enters the lower permeable aquitard.
* This problem uses the \ref TwoPTwoCBoxModel.
* This problem uses the \ref TwoPTwoCModel.
*/
template <class TypeTag = TTAG(InjectionProblem) >
class InjectionProblem : public TwoPTwoCProblem<TypeTag>
......@@ -294,6 +294,7 @@ public:
* \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
* \param scvIdx The local vertex index
*
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
......
......@@ -128,8 +128,7 @@ public:
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
* \param scvfIdx The index sub-control volume face where the
* intrinsic velocity ought to be calculated.
* \param scvIdx The index of the sub-control volume
*/
const Scalar intrinsicPermeability(const Element &element,
const FVElementGeometry &fvElemGeom,
......@@ -144,7 +143,6 @@ public:
/*!
* \brief Define the porosity \f$[-]\f$ of the spatial parameters
*
* \param vDat The data defined on the sub-control volume
* \param element The finite element
* \param fvElemGeom The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
......@@ -166,8 +164,7 @@ public:
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
* \param scvfIdx The index sub-control volume face where the
* intrinsic velocity ought to be calculated.
* \param scvIdx The index of the sub-control volume
*/
const MaterialLawParams& materialLawParams(const Element &element,
const FVElementGeometry &fvElemGeom,
......
......@@ -302,6 +302,7 @@ public:
* \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
* \param scvIdx The local vertex index
*
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
......
......@@ -127,8 +127,7 @@ public:
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
* \param scvfIdx The index sub-control volume face where the
* intrinsic velocity ought to be calculated.
* \param scvIdx The index of the sub-control volume
*/
const Scalar intrinsicPermeability(const Element &element,
const FVElementGeometry &fvElemGeom,
......@@ -143,7 +142,6 @@ public:
/*!
* \brief Define the porosity \f$[-]\f$ of the spatial parameters
*
* \param vDat The data defined on the sub-control volume
* \param element The finite element
* \param fvElemGeom The finite volume geometry
* \param scvIdx The local index of the sub-control volume where
......@@ -166,8 +164,7 @@ public:
*
* \param element The current finite element
* \param fvElemGeom The current finite volume geometry of the element
* \param scvfIdx The index sub-control volume face where the
* intrinsic velocity ought to be calculated.
* \param scvIdx The index of the sub-control volume
*/
const MaterialLawParams& materialLawParams(const Element &element,
const FVElementGeometry &fvElemGeom,
......
......@@ -340,6 +340,7 @@ public:
* \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
* \param scvIdx The local vertex index
*
* For this method, the \a values parameter stores the rate mass
* generated or annihilate per volume unit. Positive values mean
......@@ -347,8 +348,8 @@ public:
*/
void source(PrimaryVariables &values,
const Element &element,
const FVElementGeometry &,
int subControlVolumeIdx) const
const FVElementGeometry &fvElemGeom,
int scvIdx) const
{
values = Scalar(0.0);
}
......
......@@ -262,6 +262,7 @@ public:
* For this method, the \a values parameter stores the mass flux
* in normal direction of each phase. Negative values mean influx.
*
* \param values The neumann values for the conservation equations
* \param element The DUNE Codim<0> entity which intersects with
* the finite volume in question
* \param fvElemGeom The finite volume geometry of the element
......
......@@ -165,7 +165,8 @@ public:
* This method is not actually required by the Richards model, but provided
* for the convenience of the RichardsLensProblem
*
* \param globalPos A global coordinate vector
* \param lensLowerLeft the lower left corner of the lens
* \param lensUpperRight the upper right corner of the lens
*/
void setLensCoords(const GlobalPosition& lensLowerLeft,
const GlobalPosition& lensUpperRight)
......
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