Commit 7018ea7d authored by Kilian Weishaupt's avatar Kilian Weishaupt
Browse files

[docu] fixed doxygen related issues concerning the

description of variables


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15511 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent f6763353
...@@ -90,7 +90,7 @@ public: ...@@ -90,7 +90,7 @@ public:
/*! Constructs a DiffusivePart object /*! Constructs a DiffusivePart object
* *
* \param A problem class object * \param problem problem class object
*/ */
DiffusivePart(Problem& problem) DiffusivePart(Problem& problem)
{} {}
......
...@@ -108,6 +108,7 @@ public: ...@@ -108,6 +108,7 @@ public:
typedef CompositionalFluidState<Scalar, FluidSystem> FluidState; typedef CompositionalFluidState<Scalar, FluidSystem> FluidState;
/*! /*!
* \copydoc ImplicitVolumeVariables::update * \copydoc ImplicitVolumeVariables::update
* \param primaryVariables The primary Variables
*/ */
void update(const PrimaryVariables &primaryVariables, void update(const PrimaryVariables &primaryVariables,
const Problem &problem, const Problem &problem,
...@@ -174,6 +175,7 @@ public: ...@@ -174,6 +175,7 @@ public:
/*! /*!
* \copydoc ImplicitModel::completeFluidState * \copydoc ImplicitModel::completeFluidState
* \param isOldSol Specifies whether this is the previous solution or the current one * \param isOldSol Specifies whether this is the previous solution or the current one
* \param primaryVariables The primary Variables
*/ */
static void completeFluidState(const PrimaryVariables& primaryVariables, static void completeFluidState(const PrimaryVariables& primaryVariables,
const Problem& problem, const Problem& problem,
......
...@@ -330,7 +330,7 @@ public: ...@@ -330,7 +330,7 @@ public:
* the adaption container in order to be mapped on a new grid. * the adaption container in order to be mapped on a new grid.
* *
* \param adaptedValues Container for model-specific values to be adapted * \param adaptedValues Container for model-specific values to be adapted
* \param element The element to be stored * \param u The variables to be stored
*/ */
static void storeAdaptionValues(AdaptedValues& adaptedValues, const PrimaryVariables& u) static void storeAdaptionValues(AdaptedValues& adaptedValues, const PrimaryVariables& u)
{ {
...@@ -344,7 +344,6 @@ public: ...@@ -344,7 +344,6 @@ public:
* *
* \param adaptedValues Container for model-specific values to be adapted * \param adaptedValues Container for model-specific values to be adapted
* \param adaptedValuesFather Values to be adapted of father cell * \param adaptedValuesFather Values to be adapted of father cell
* \param fatherElement The element of the father
*/ */
static void storeAdaptionValues(AdaptedValues& adaptedValues, static void storeAdaptionValues(AdaptedValues& adaptedValues,
AdaptedValues& adaptedValuesFather) AdaptedValues& adaptedValuesFather)
...@@ -366,7 +365,7 @@ public: ...@@ -366,7 +365,7 @@ public:
* decoupled models. * decoupled models.
* *
* \param adaptedValues Container for model-specific values to be adapted * \param adaptedValues Container for model-specific values to be adapted
* \param element The element where things are stored. * \param u The variables to be stored
*/ */
static void setAdaptionValues(AdaptedValues& adaptedValues, PrimaryVariables& u) static void setAdaptionValues(AdaptedValues& adaptedValues, PrimaryVariables& u)
{ {
......
...@@ -87,7 +87,6 @@ public: ...@@ -87,7 +87,6 @@ public:
* Default implementation * Default implementation
* *
* \param problem The problem object * \param problem The problem object
* \param adaptionIndicator Indicator whether a be adapted
*/ */
ImplicitGridAdaptIndicatorDefault(Problem& problem) ImplicitGridAdaptIndicatorDefault(Problem& problem)
{} {}
......
...@@ -163,7 +163,7 @@ public: ...@@ -163,7 +163,7 @@ public:
/*! /*!
* \brief The capillary pressure-saturation curve copied from MUFTE/pml/constrel3p3cni.c * \brief The capillary pressure-saturation curve copied from MUFTE/pml/constrel3p3cni.c
* \param params Array of parameters * \param params Array of parameters
* \param st sum of wetting (liquid) phase saturations * \param St sum of wetting (liquid) phase saturations
*/ */
static Scalar pcgn(const Params &params, Scalar St) static Scalar pcgn(const Params &params, Scalar St)
{ {
......
...@@ -144,7 +144,7 @@ public: ...@@ -144,7 +144,7 @@ public:
* used for which equation on a given boundary segment. * used for which equation on a given boundary segment.
* *
* \param values The boundary types for the conservation equations * \param values The boundary types for the conservation equations
* \param vertex The vertex for which the boundary type is set * \param globalPos The global position
*/ */
void boundaryTypesAtPos(BoundaryTypes &values, void boundaryTypesAtPos(BoundaryTypes &values,
const GlobalPosition &globalPos) const const GlobalPosition &globalPos) const
......
...@@ -227,7 +227,7 @@ public: ...@@ -227,7 +227,7 @@ public:
* used for which equation on a given boundary segment * used for which equation on a given boundary segment
* *
* \param values Stores the value of the boundary type * \param values Stores the value of the boundary type
* \param globalPos The global position * \param intersection The intersection
*/ */
void boundaryTypes(BoundaryTypes &values, void boundaryTypes(BoundaryTypes &values,
const Intersection &intersection) const const Intersection &intersection) const
......
...@@ -148,7 +148,6 @@ public: ...@@ -148,7 +148,6 @@ public:
/*! /*!
* \brief Define the minimum porosity \f$[-]\f$ after salt precipitation * \brief Define the minimum porosity \f$[-]\f$ after salt precipitation
* *
* \param elemVolVars The data defined on the sub-control volume
* \param element The finite element * \param element The finite element
* \param fvGeometry The finite volume geometry * \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where * \param scvIdx The local index of the sub-control volume where
...@@ -164,7 +163,6 @@ public: ...@@ -164,7 +163,6 @@ public:
/*! /*!
* \brief Define the minimum porosity \f$[-]\f$ after clogging caused by mineralization * \brief Define the minimum porosity \f$[-]\f$ after clogging caused by mineralization
* *
* \param elemVolVars The data defined on the sub-control volume
* \param element The finite element * \param element The finite element
* \param fvGeometry The finite volume geometry * \param fvGeometry The finite volume geometry
* \param scvIdx The local index of the sub-control volume where * \param scvIdx The local index of the sub-control volume where
......
...@@ -130,7 +130,6 @@ public: ...@@ -130,7 +130,6 @@ public:
/*! /*!
* \brief Reads layer information from the grid * \brief Reads layer information from the grid
* *
* \param gridPtr The grid pointer
*/ */
void setParams() void setParams()
{ {
......
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