Commit 7677fe7c authored by Simon Scholz's avatar Simon Scholz
Browse files

[doxygen] fix doxygen in EOS

parent 1ffea349
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup EOS
* \brief Implements the Peng-Robinson equation of state for liquids
* and gases.
*
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup EOS
* \brief Implements the Peng-Robinson equation of state for a
* mixture.
*/
......@@ -79,16 +79,14 @@ public:
*
* The fugacity coefficient \f$\phi_i\f$ of a component \f$i\f$ is
* defined as
* \f[
f_i = \phi_i x_i \;,
\f]
* \f[f_i = \phi_i x_i \;,\f]
* where \f$f_i\f$ is the component's fugacity and \f$x_i\f$ is
* the component's mole fraction.
*
* See:
*
* R. Reid, et al. (1987, pp. 42-44, 143-145) \cite reid1987
*/
* R. Reid, et al. (1987, pp. 42-44, 143-145) \cite reid1987
*/
template <class FluidState, class Params>
static Scalar computeFugacityCoefficient(const FluidState &fs,
const Params &params,
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup EOS
* \brief Base class for Peng-Robinson parameters of a
* single-component fluid or a mixture
*
......@@ -75,6 +75,7 @@ public:
/*!
* \brief Set the attractive parameter 'a' of the Peng-Robinson
* fluid.
* \param value value of the attractive parameter
*/
void setA(Scalar value)
{ a_ = value; }
......@@ -82,6 +83,7 @@ public:
/*!
* \brief Set the repulsive parameter 'b' of the Peng-Robinson
* fluid.
* \param value value of the repulsive parameter
*/
void setB(Scalar value)
{ b_ = value; }
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup EOS
* \brief The mixing rule for the oil and the gas phases of the SPE5 problem.
*
* This problem comprises \f$H_2O\f$, \f$C_1\f$, \f$C_3\f$, \f$C_6\f$,
......@@ -138,6 +138,7 @@ public:
*
* The updatePure() method needs to be called _before_ calling
* this method!
* \param fs the thermodynamic state of the fluids
*/
template <class FluidState>
void updateMix(const FluidState &fs)
......@@ -187,6 +188,8 @@ public:
*
* The updatePure() method needs to be called _before_ calling
* this method!
* \param fs the thermodynamic state of the fluids
* \param compIdx the component index
*/
template <class FluidState>
void updateSingleMoleFraction(const FluidState &fs,
......@@ -197,12 +200,14 @@ public:
/*!
* \brief Return the Peng-Robinson parameters of a pure substance,
* \param compIdx the component index
*/
const PureParams &pureParams(int compIdx) const
{ return pureParams_[compIdx]; }
/*!
* \brief Returns the Peng-Robinson parameters for a pure component.
* \param compIdx the component index
*/
const PureParams &operator[](int compIdx) const
{
......
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