Commit 9bef89ce authored by Vishal Jambhekar's avatar Vishal Jambhekar
Browse files

Doxygen corrections


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7755 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 582e4913
......@@ -86,7 +86,7 @@ public:
* pure mesitylene at a given temperature according to
* Antoine after Betz 1997, see Gmehling et al 1980
*
* \param T temperature of component in \f$\mathrm{[K]}\f$
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar vaporPressure(Scalar temperature)
{
......@@ -103,7 +103,7 @@ public:
/*!
* \brief Specific enthalpy of liquid mesitylene \f$\mathrm{[J/kg]}\f$.
*
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidEnthalpy(Scalar temperature, Scalar pressure)
......@@ -252,7 +252,7 @@ protected:
/*!
* \brief Specific heat cap of liquid mesitylene \f$\mathrm{[J/kg]}\f$.
*
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar spHeatCapLiquidPhase_(Scalar temperature)
{
......
......@@ -85,7 +85,7 @@ public:
* \brief The saturation vapor pressure in \f$\mathrm{[Pa]}\f$ of pure xylene
* at a given temperature according to Antoine after Betz 1997 -> Gmehling et al 1980
*
* \param T temperature of component in \f$\mathrm{[K]}\f$
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar vaporPressure(Scalar temperature)
......@@ -159,7 +159,7 @@ public:
/*!
* \brief latent heat of vaporization for xylene \f$\mathrm{[J/kg]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar heatVap(Scalar temp, Scalar pressure)
......@@ -210,7 +210,7 @@ public:
* \brief The molar density of pure xylene at a given pressure and temperature
* \f$\mathrm{[mol/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar molarLiquidDensity(Scalar temp, Scalar pressure)
......@@ -261,7 +261,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of xylene vapor
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
* \param regularize defines, if the functions is regularized or not, set to true by default
*/
......@@ -286,7 +286,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of pure xylene.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param temp temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidViscosity(Scalar temp, Scalar pressure)
......
......@@ -101,7 +101,8 @@ public:
* - if the setViscosity parameter is true, also dynamic viscosities of *all* phases
* - if the setEnthalpy parameter is true, also specific enthalpies and internal energies of *all* phases
*
* \param mutParams The mutable parameters object which ought to be set
* \param fluidState Thermodynamic state of the fluids
* \param paramCache Container for cache parameters
* \param refPhaseIdx The phase index of the reference phase
* \param setViscosity Specify whether the dynamic viscosity of
* each phase should also be set.
......
......@@ -249,7 +249,10 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.)
*
* \param The mobile saturation of all phases. (Sw used)
* \param Sn saturation of the NAPL phase.
* \param Sg saturation of the gas phase.
* \param saturation saturation of the water phase.
* \param params Array of parameters.
*/
static Scalar krw(const Params &params, Scalar saturation, Scalar Sn, Scalar Sg)
{
......@@ -277,7 +280,10 @@ public:
* Journal of Contaminant Hydrology 66 (2003), 261-285
*
*
* \param The mobile saturation of all phases. (Sw and Sn used)
* \param Sw saturation of the water phase.
* \param Sg saturation of the gas phase.
* \param saturation saturation of the NAPL phase.
* \param params Array of parameters.
*/
static Scalar krn(const Params &params, Scalar Sw, Scalar saturation, Scalar Sg)
{
......@@ -318,7 +324,10 @@ public:
* (see p61. in "Comparison of the Three-Phase Oil Relative Permeability Models"
* MOJDEH DELSHAD and GARY A. POPE, Transport in Porous Media 4 (1989), 59-83.)
*
* \param The mobile saturation of all phases. (Sg used)
* \param Sw saturation of the water phase.
* \param Sn saturation of the NAPL phase.
* \param saturation saturation of the gas phase.
* \param params Array of parameters.
*/
static Scalar krg(const Params &params, Scalar Sw, Scalar Sn, Scalar saturation)
{
......@@ -344,8 +353,11 @@ public:
/*!
* \brief The relative permeability for a phase.
*
* \param Phase indicator, The saturation of all phases.
* \param Sw saturation of the water phase.
* \param Sg saturation of the gas phase.
* \param Sn saturation of the NAPL phase.
* \param params Array of parameters.
* \param phase indicator, The saturation of all phases.
*/
static Scalar kr(const Params &params, const int phase, const Scalar Sw, const Scalar Sn, const Scalar Sg)
{
......
......@@ -361,6 +361,7 @@ public:
*
*
* \param fluidState An abitrary fluid state
* \param paramCache Container for cache parameters
* \param phaseIdx The index of the fluid phase to consider
*/
template <class FluidState>
......@@ -465,6 +466,7 @@ public:
* \f$i\f$ and \f$j\f$ in this phase.
*
* \param fluidState An abitrary fluid state
* \param paramCache Container for cache parameters
* \param phaseIdx The index of the fluid phase to consider
* \param compIIdx The index of the first component to consider
* \param compJIdx The index of the second component to consider
......
......@@ -107,7 +107,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, EnableGravity, false);
* gradient of 1e5Pa/m. The nitrogen is transported with the water flow
* and leaves the domain at the right boundary
* where an outflow boundary condition is applied.
* This problem uses the \ref OnePTwoCModel.
* This problem uses the \ref OnePTwoCBoxModel.
*
* To run the simulation execute the following line in shell:
* <tt>./test_1p2c -parameterFile ./test_1p2c.input</tt>
......
......@@ -193,8 +193,6 @@ public:
*
* \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)
......
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