Commit e7c71605 authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

Fix doxygen warnings and errors, especially in the new CO2 model.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@9153 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent aa733ee7
......@@ -462,7 +462,7 @@ void FVPressure2P2CAdaptive<TypeTag>::assemble(bool first)
//! Get flux at an interface between two cells
/** for first == true, the flux is calculated in traditional fractional-flow forn as in FVPressure2P.
* for first == false, the flux thorugh \f$ \gamma{ij} \f$ is calculated via a volume balance formulation
* for first == false, the flux through \f$ \gamma_{ij} \f$ is calculated via a volume balance formulation
* \f[ - A_{\gamma_{ij}} \cdot \mathbf{K} \cdot \mathbf{u} \cdot (\mathbf{n}_{\gamma_{ij}} \cdot \mathbf{u})
\sum_{\alpha} \varrho_{\alpha} \lambda_{\alpha} \sum_{\kappa} \frac{\partial v_{t}}{\partial C^{\kappa}} X^{\kappa}_{\alpha}
\left( \frac{p_{\alpha,j}^t - p^{t}_{\alpha,i}}{\Delta x} + \varrho_{\alpha} \mathbf{g}\right)
......
......@@ -121,8 +121,6 @@ public:
//! Constructs a VariableClass object
/**
* @param gridView a DUNE gridview object corresponding to diffusion and transport equation
* @param codim codimension of the entity of which data has to be strored
* @param initialVel initial value for the velocity (only necessary if only transport part is solved)
*/
VariableClass2P2CAdaptive(const GridView& gridView) :
ParentType(gridView), grid_(gridView.grid())
......
......@@ -379,7 +379,7 @@ public:
* \brief Returns the _mole_ (!) fraction of CO2 in the liquid
* phase at a given temperature, pressure and density of
* CO2.
* \param T the temperature [K]
* \param temperature the temperature [K]
* \param pg the gas phase pressure [Pa]
* \param rhoCO2 density of CO2
*/
......
......@@ -435,7 +435,7 @@ public:
* Molecular diffusion of a compoent \f$\kappa\f$ is caused by a
* gradient of the chemical potential and follows the law
*
* \f[ J = - D \grad mu_\kappa \f]
* \f[ J = - D \text{grad} mu_\kappa \f]
*
* where \f$\mu_\kappa\f$ is the component's chemical potential,
* \f$D\f$ is the diffusion coefficient and \f$J\f$ is the
......@@ -560,11 +560,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of a fluid phase.
* [J/kg]
*
* \param fluidState An abitrary fluid state
* \param phaseIdx The index of the fluid phase to consider
* \copydoc BaseFluidSystem::heatCapacity
*/
template <class FluidState>
static Scalar heatCapacity(const FluidState &fluidState,
......
......@@ -368,8 +368,8 @@ public:
* used for which equation on a given boundary segment.
*
* \param values The boundary types for the conservation equations
* \param intersection specifies the intersection at which boundary
* \param condition is to set
* \param is specifies the intersection at which boundary
* condition is to set
*/
......
......@@ -106,7 +106,7 @@ public:
/*!
* \brief The constructor
*
* \param gv The grid view
* \param gridView The grid view
*/
HeterogeneousSpatialParams(const GridView &gridView)
: ParentType(gridView)
......
......@@ -369,8 +369,8 @@ public:
* used for which equation on a given boundary segment.
*
* \param values The boundary types for the conservation equations
* \param intersection specifies the intersection at which boundary
* \param condition is to set
* \param is specifies the intersection at which boundary
* condition is to set
*/
......
......@@ -106,7 +106,7 @@ public:
/*!
* \brief The constructor
*
* \param gv The grid view
* \param gridView The grid view
*/
HeterogeneousSpatialParams(const GridView &gridView)
: ParentType(gridView)
......
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