From 68aaa70e56601e35e2e2ae22826139aaa304a8fd Mon Sep 17 00:00:00 2001
From: Alexander Kissinger <alexander.kissinger@iws.uni-stuttgart.de>
Date: Tue, 5 May 2015 06:34:38 +0000
Subject: [PATCH] Reviewed the units of the functions (see FS#249) in
dumux/matrial within the folders:
- binarycoefficients
- constraintsolver
- eos
- Units were added where required
- All units were checked that they are expressed in latex
- No additional doxygen errors or wanrings
Work done by Scholz
Reviewed and committed by Alexk
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@14706 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../binarycoefficients/air_mesitylene.hh | 10 +-
.../material/binarycoefficients/air_xylene.hh | 10 +-
.../material/binarycoefficients/brine_co2.hh | 100 +++++++++---------
dumux/material/binarycoefficients/h2o_air.hh | 5 +-
.../binarycoefficients/h2o_mesitylene.hh | 12 ++-
dumux/material/binarycoefficients/h2o_n2.hh | 5 +-
.../material/binarycoefficients/h2o_xylene.hh | 11 +-
.../material/binarycoefficients/henryiapws.hh | 8 +-
.../compositionfromfugacities.hh | 12 ++-
.../constraintsolvers/immiscibleflash.hh | 7 ++
dumux/material/constraintsolvers/ncpflash.hh | 10 +-
dumux/material/eos/pengrobinson.hh | 18 ++--
dumux/material/eos/pengrobinsonmixture.hh | 15 ++-
.../material/eos/pengrobinsonparamsmixture.hh | 5 +-
14 files changed, 149 insertions(+), 79 deletions(-)
diff --git a/dumux/material/binarycoefficients/air_mesitylene.hh b/dumux/material/binarycoefficients/air_mesitylene.hh
index 89b44d28ea..1cb4ee9b72 100644
--- a/dumux/material/binarycoefficients/air_mesitylene.hh
+++ b/dumux/material/binarycoefficients/air_mesitylene.hh
@@ -34,6 +34,8 @@ namespace BinaryCoeff
/*!
* \brief Binary coefficients for water and mesitylene.
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ *
*/
class Air_Mesitylene
{
@@ -48,10 +50,12 @@ public:
}
/*!
- * \brief Binary diffusion coefficent [m^2/s] for air and mesitylene.
+ * \brief Binary diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for air and mesitylene.
* I used the method according to Wilke and Lee
* see Handbook of chem. property's Estimation Methods
* W.J. Lyman, W.F. Reehl, D.H. Rosenblatt
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure in \f$\mathrm{[Pa]}\f$
*
*/
template <class Scalar>
@@ -90,7 +94,9 @@ public:
}
/*!
- * \brief Diffusion coefficent [m^2/s] for molecular mesitylene in liquid water.
+ * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular mesitylene in liquid water.
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure in \f$\mathrm{[Pa]}\f$
*
* \todo
*/
diff --git a/dumux/material/binarycoefficients/air_xylene.hh b/dumux/material/binarycoefficients/air_xylene.hh
index 549791ca37..0f33563708 100644
--- a/dumux/material/binarycoefficients/air_xylene.hh
+++ b/dumux/material/binarycoefficients/air_xylene.hh
@@ -34,6 +34,8 @@ namespace BinaryCoeff
/*!
* \brief Binary coefficients for water and xylene.
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ *
*/
class Air_Xylene
{
@@ -48,10 +50,12 @@ public:
}
/*!
- * \brief Binary diffusion coefficent [m^2/s] for air and xylene.
+ * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for air and xylene.
* method according to Wilke and Lee
* see Handbook of chem. property's Estimation Methods
* W.J. Lyman, W.F. Reehl, D.H. Rosenblatt
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure in \f$\mathrm{[Pa]}\f$
*
*/
template <class Scalar>
@@ -90,7 +94,9 @@ public:
}
/*!
- * \brief Diffusion coefficent [m^2/s] for molecular xylene in liquid water.
+ * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular xylene in liquid water.
+ * \param temperature temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure in \f$\mathrm{[Pa]}\f$
*
* \todo
*/
diff --git a/dumux/material/binarycoefficients/brine_co2.hh b/dumux/material/binarycoefficients/brine_co2.hh
index 63990cecd8..7df1432031 100644
--- a/dumux/material/binarycoefficients/brine_co2.hh
+++ b/dumux/material/binarycoefficients/brine_co2.hh
@@ -45,12 +45,12 @@ class Brine_CO2 {
public:
/*!
- * \brief Binary diffusion coefficent [m^2/s] of water in the CO2 phase.
+ * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ of water in the CO2 phase.
*
* According to "Diffusion of Water in Liquid and Supercritical Carbon
* Dioxide: An NMR Study", Bin Xu et al., 2002.
- * \param temperature the temperature [K]
- * \param pressure the phase pressure [Pa]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasDiffCoeff(Scalar temperature, Scalar pressure) {
//Diffusion coefficient of water in the CO2 phase
@@ -65,10 +65,10 @@ public:
;
/*!
- * \brief Binary diffusion coefficent [m^2/s] of CO2 in the brine phase.
+ * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ of CO2 in the brine phase.
*
- * \param temperature the temperature [K]
- * \param pressure the phase pressure [Pa]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure) {
//Diffusion coefficient of CO2 in the brine phase
@@ -78,7 +78,7 @@ public:
/*!
* \brief Returns the _mol_ (!) fraction of CO2 in the liquid
- * phase and the mol_ (!) fraction of H2O in the gas phase
+ * phase and the _mol_ (!) fraction of H2O in the gas phase
* for a given temperature, pressure, CO2 density and brine
* salinity.
*
@@ -86,12 +86,12 @@ public:
* applying the activity coefficient expression of "Duan and Sun 2003"
* and the correlations for pure water given in "Spycher, Pruess and Ennis-King 2003"
*
- * \param temperature the temperature [K]
- * \param pg the gas phase pressure [Pa]
- * \param salinity the salinity [kg NaCl / kg solution]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
+ * \param salinity the salinity \f$\mathrm{[kg \ NaCl / kg \ solution]}\f$
* \param knownPhaseIdx indicates which phases are present
- * \param xlCO2 mole fraction of CO2 in brine [mol/mol]
- * \param ygH2O mole fraction of water in the gas phase [mol/mol]
+ * \param xlCO2 mole fraction of CO2 in brine \f$\mathrm{[mol/mol]}\f$
+ * \param ygH2O mole fraction of water in the gas phase \f$\mathrm{[mol/mol]}\f$
*/
static void calculateMoleFractions(const Scalar temperature,
@@ -139,8 +139,8 @@ public:
* \brief Returns the fugacity coefficient of the CO2 component in a water-CO2 mixture
* (given in Spycher, Pruess and Ennis-King (2003))
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar fugacityCoefficientCO2(Scalar T, Scalar pg) {
@@ -165,8 +165,8 @@ public:
* \brief Returns the fugacity coefficient of the H2O component in a water-CO2 mixture
* (given in Spycher, Pruess and Ennis-King (2003))
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar fugacityCoefficientH2O(Scalar T, Scalar pg) {
@@ -189,9 +189,9 @@ public:
private:
/*!
- * \brief Returns the molality of NaCl (mol NaCl / kg water) for a given mole fraction
+ * \brief Returns the molality of NaCl \f$\mathrm{[mol \ NaCl / kg \ water]}\f$ for a given mole fraction
*
- * \param salinity the salinity [kg NaCl / kg solution]
+ * \param salinity the salinity \f$\mathrm{[kg \ NaCl / kg \ solution]}\f$
*/
static Scalar salinityToMolFrac_(Scalar salinity) {
@@ -205,9 +205,9 @@ private:
}
/*!
- * \brief Returns the molality of NaCl (mol NaCl / kg water) for a given mole fraction (mol NaCl / mol solution)
+ * \brief Returns the molality of NaCl \f$\mathrm{(mol \ NaCl / kg \ water)}\f$ for a given mole fraction \f$\mathrm{(mol \ NaCl / mol\ solution)}\f$
*
- * \param x_NaCl mole fraction of NaCL in brine [mol/mol]
+ * \param x_NaCl mole fraction of NaCL in brine \f$\mathrm{[mol/mol]}\f$
*/
static Scalar molFracToMolality_(Scalar x_NaCl) {
@@ -218,11 +218,11 @@ private:
}
/*!
- * \brief Returns the equilibrium molality of CO2 (mol CO2 / kg water) for a
+ * \brief Returns the equilibrium molality of CO2 \f$\mathrm{(mol \ CO2 / kg \ water)}\f$ for a
* CO2-water mixture at a given pressure and temperature
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar molalityCO2inPureWater_(Scalar temperature, Scalar pg) {
Scalar A = computeA_(temperature, pg); // according to Spycher, Pruess and Ennis-King (2003)
@@ -238,9 +238,9 @@ private:
* molal description. According to "Duan and Sun 2003"
* given in "Spycher and Pruess 2005"
*
- * \param temperature the temperature [K]
- * \param pg the gas phase pressure [Pa]
- * \param molalityNaCl molality of NaCl (mol NaCl / kg water)
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
+ * \param molalityNaCl molality of NaCl \f$\mathrm{(mol \ NaCl / kg \ water)}\f$
*/
static Scalar activityCoefficient_(Scalar temperature, Scalar pg,
Scalar molalityNaCl) {
@@ -257,8 +257,8 @@ private:
* them mutual solubility in the water-CO2 system.
* Given in Spycher, Pruess and Ennis-King (2003)
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeA_(Scalar T, Scalar pg) {
Scalar deltaP = pg / 1e5 - 1; // pressure range [bar] from p0 = 1bar to pg[bar]
@@ -277,8 +277,8 @@ private:
* the mutual solubility in the water-CO2 system.
* Given in Spycher, Pruess and Ennis-King (2003)
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeB_(Scalar T, Scalar pg) {
Scalar deltaP = pg / 1e5 - 1; // pressure range [bar] from p0 = 1bar to pg[bar]
@@ -296,8 +296,8 @@ private:
* \brief Returns the parameter lambda, which is needed for the
* calculation of the CO2 activity coefficient in the brine-CO2 system.
* Given in Spycher and Pruess (2005)
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeLambda_(Scalar T, Scalar pg) {
Scalar lambda;
@@ -315,8 +315,8 @@ private:
* \brief Returns the parameter xi, which is needed for the
* calculation of the CO2 activity coefficient in the brine-CO2 system.
* Given in Spycher and Pruess (2005)
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeXi_(Scalar T, Scalar pg) {
Scalar xi;
@@ -333,7 +333,7 @@ private:
* \brief Returns the equilibrium constant for CO2, which is needed for the
* calculation of the mutual solubility in the water-CO2 system
* Given in Spycher, Pruess and Ennis-King (2003)
- * \param T the temperature [K]
+ * \param T the temperature \f$\mathrm{[K]}\f$
*/
static Scalar equilibriumConstantCO2_(Scalar T) {
Scalar TinC = T - 273.15; //temperature in °C
@@ -347,7 +347,7 @@ private:
* \brief Returns the equilibrium constant for H2O, which is needed for the
* calculation of the mutual solubility in the water-CO2 system
* Given in Spycher, Pruess and Ennis-King (2003)
- * \param T the temperature [K]
+ * \param T the temperature \f$\mathrm{[K]}\f$
*/
static Scalar equilibriumConstantH2O_(Scalar T) {
Scalar TinC = T - 273.15; //temperature in °C
@@ -379,8 +379,8 @@ public:
* \brief Returns the _mole_ (!) fraction of CO2 in the liquid
* phase at a given temperature, pressure and density of
* CO2.
- * \param temperature the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
* \param rhoCO2 density of CO2
*/
static Scalar moleFracCO2InBrine(Scalar temperature, Scalar pg, Scalar rhoCO2)
@@ -427,9 +427,9 @@ public:
private:
/*!
- * \brief computation of mu_{CO2}^{l(0)}/RT
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \brief computation of \f$\mathrm{[mu_{CO2}^{l(0)}/RT]}\f$
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeA_(Scalar T, Scalar pg)
{
@@ -465,8 +465,8 @@ private:
/*!
* \brief computation of B
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeB_(Scalar T, Scalar pg)
{
@@ -490,8 +490,8 @@ private:
/*!
* \brief computation of C
*
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param T the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar computeC_(Scalar T, Scalar pg)
{
@@ -511,8 +511,8 @@ private:
/*!
* \brief computation of partial pressure CO2
*
- * \param temperature the temperature [K]
- * \param pg the gas phase pressure [Pa]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar partialPressureCO2_(Scalar temperature, Scalar pg)
{
@@ -526,9 +526,9 @@ private:
/*!
* \brief The fugacity coefficent of CO2 for a CO2-H2O mixture.
*
- * \param temperature the temperature [K]
- * \param pg the gas phase pressure [Pa]
- * \param rhoCO2 the density of CO2 for the critical volume [kg/m^3]
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
+ * \param rhoCO2 the density of CO2 for the critical volume \f$\mathrm{[kg/m^3]\f$
*/
static Scalar fugacityCoeffCO2_(Scalar temperature,
diff --git a/dumux/material/binarycoefficients/h2o_air.hh b/dumux/material/binarycoefficients/h2o_air.hh
index fb363e24a0..4e9f77ff6c 100644
--- a/dumux/material/binarycoefficients/h2o_air.hh
+++ b/dumux/material/binarycoefficients/h2o_air.hh
@@ -39,7 +39,7 @@ class H2O_Air
public:
/*!
* \brief Henry coefficent \f$\mathrm{[N/m^2]}\f$ for air in liquid water.
- *
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*
* Henry coefficent See:
* Stefan Finsterle, 1993
@@ -85,6 +85,9 @@ public:
* moment the diffusion coefficient of the air's main component nitrogen!!
* \brief Diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for molecular nitrogen in liquid water.
*
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
+ *
* The empirical equations for estimating the diffusion coefficient in
* infinite solution which are presented in Reid, 1987 all show a
* linear dependency on temperature. We thus simply scale the
diff --git a/dumux/material/binarycoefficients/h2o_mesitylene.hh b/dumux/material/binarycoefficients/h2o_mesitylene.hh
index c893921a02..16108f8268 100644
--- a/dumux/material/binarycoefficients/h2o_mesitylene.hh
+++ b/dumux/material/binarycoefficients/h2o_mesitylene.hh
@@ -39,8 +39,8 @@ class H2O_Mesitylene
{
public:
/*!
- * \brief Henry coefficent \f$[N/m^2]\f$ for mesitylene in liquid water.
- *
+ * \brief Henry coefficent \f$\mathrm{[N/m^2]}\f$ for mesitylene in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
* See:
*
* Sanders1999 Henry collection
@@ -57,7 +57,9 @@ public:
}
/*!
- * \brief Binary diffusion coefficent [m^2/s] for molecular water and mesitylene.
+ * \brief Binary diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for molecular water and mesitylene.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*
*/
template <class Scalar>
@@ -98,7 +100,9 @@ public:
}
/*!
- * \brief Diffusion coefficent [m^2/s] for mesitylene in liquid water.
+ * \brief Diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for mesitylene in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*
* \todo
*/
diff --git a/dumux/material/binarycoefficients/h2o_n2.hh b/dumux/material/binarycoefficients/h2o_n2.hh
index 8fe8f41771..0ff69f474b 100644
--- a/dumux/material/binarycoefficients/h2o_n2.hh
+++ b/dumux/material/binarycoefficients/h2o_n2.hh
@@ -44,8 +44,7 @@ class H2O_N2
public:
/*!
* \brief Henry coefficent \f$\mathrm{[N/m^2]}\f$ for molecular nitrogen in liquid water.
- *
- * \copydetails Dumux::henryIAPWS
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
template <class Scalar>
static Scalar henry(Scalar temperature)
@@ -81,6 +80,8 @@ public:
/*!
* \brief Diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for molecular nitrogen in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*
* The empirical equations for estimating the diffusion coefficient in
* infinite solution which are presented in Reid, 1987 all show a
diff --git a/dumux/material/binarycoefficients/h2o_xylene.hh b/dumux/material/binarycoefficients/h2o_xylene.hh
index 4956a05dd6..8efd678a26 100644
--- a/dumux/material/binarycoefficients/h2o_xylene.hh
+++ b/dumux/material/binarycoefficients/h2o_xylene.hh
@@ -39,7 +39,8 @@ class H2O_Xylene
{
public:
/*!
- * \brief Henry coefficent \f$[N/m^2]\f$ for xylene in liquid water.
+ * \brief Henry coefficent \f$\mathrm{[N/m^2]}\f$ for xylene in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*
* See:
*
@@ -58,7 +59,9 @@ public:
}
/*!
- * \brief Binary diffusion coefficent [m^2/s] for molecular water and xylene.
+ * \brief Binary diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for molecular water and xylene.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*
*/
template <class Scalar>
@@ -99,7 +102,9 @@ public:
}
/*!
- * \brief Diffusion coefficent [m^2/s] for xylene in liquid water.
+ * \brief Diffusion coefficent \f$\mathrm{[m^2/s]}\f$ for xylene in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*
* \todo
*/
diff --git a/dumux/material/binarycoefficients/henryiapws.hh b/dumux/material/binarycoefficients/henryiapws.hh
index 4e39749077..30e96e0c08 100644
--- a/dumux/material/binarycoefficients/henryiapws.hh
+++ b/dumux/material/binarycoefficients/henryiapws.hh
@@ -32,12 +32,18 @@ namespace Dumux
* \ingroup Binarycoefficients
* \brief The Henry constants in liquid water using the IAPWS 2004
* formulation.
+ * \param E Correlation parameter
+ * \param F Correlation parameter
+ * \param G Correlation parameter
+ * \param H Correlation parameter
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*
- * This function calculates \f$K_D\f$, see:
+ * This function calculates \f$\mathrm{K_D}\f$, see:
*
* IAPWS: "Guideline on the Henry's Constant and Vapor-Liquid
* Distribution Constant for Gases in H2O and D2O at High
* Temperatures"
+ * Equation (5)
* http://www.iapws.org/relguide/HenGuide.pdf
*
* Range of validity: T = {278.12 ; 636.46}
diff --git a/dumux/material/constraintsolvers/compositionfromfugacities.hh b/dumux/material/constraintsolvers/compositionfromfugacities.hh
index e8dc0a08eb..81c4cef720 100644
--- a/dumux/material/constraintsolvers/compositionfromfugacities.hh
+++ b/dumux/material/constraintsolvers/compositionfromfugacities.hh
@@ -48,7 +48,11 @@ public:
typedef Dune::FieldVector<Scalar, numComponents> ComponentVector;
/*!
- * \brief Guess an initial value for the composition of the phase.
+ * \brief Guess an initial value for the composition of the phase.
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param phaseIdx The phase index
+ * \param fugVec fugacity vector of the component
*/
template <class FluidState>
static void guessInitial(FluidState &fluidState,
@@ -70,7 +74,11 @@ public:
/*!
* \brief Calculates the chemical equilibrium from the component
- * fugacities in a phase.
+ * fugacities in a phase.
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param phaseIdx The phase index
+ * \param targetFug target fugacity
*
* The phase's fugacities must already be set.
*/
diff --git a/dumux/material/constraintsolvers/immiscibleflash.hh b/dumux/material/constraintsolvers/immiscibleflash.hh
index 036f2b21c6..0d15711409 100644
--- a/dumux/material/constraintsolvers/immiscibleflash.hh
+++ b/dumux/material/constraintsolvers/immiscibleflash.hh
@@ -80,6 +80,9 @@ public:
/*!
* \brief Guess initial values for all quantities.
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param globalMolarities
*/
template <class FluidState>
static void guessInitial(FluidState &fluidState,
@@ -103,6 +106,10 @@ public:
/*!
* \brief Calculates the chemical equilibrium from the component
* fugacities in a phase.
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param globalMolarities
+ * \param matParams The material law object
*
* The phase's fugacities must already be set.
*/
diff --git a/dumux/material/constraintsolvers/ncpflash.hh b/dumux/material/constraintsolvers/ncpflash.hh
index 15358ab120..647d9de071 100644
--- a/dumux/material/constraintsolvers/ncpflash.hh
+++ b/dumux/material/constraintsolvers/ncpflash.hh
@@ -91,6 +91,10 @@ public:
/*!
* \brief Guess initial values for all quantities.
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param globalMolarities
+ *
*/
template <class FluidState>
static void guessInitial(FluidState &fluidState,
@@ -129,7 +133,11 @@ public:
/*!
* \brief Calculates the chemical equilibrium from the component
* fugacities in a phase.
- *
+ * \param fluidState Thermodynamic state of the fluids
+ * \param paramCache Container for cache parameters
+ * \param globalMolarities
+ * \param matParams The material law object
+ *
* The phase's fugacities must already be set.
*/
template <class MaterialLaw, class FluidState>
diff --git a/dumux/material/eos/pengrobinson.hh b/dumux/material/eos/pengrobinson.hh
index 8ee54eac78..bd2b8e01f9 100644
--- a/dumux/material/eos/pengrobinson.hh
+++ b/dumux/material/eos/pengrobinson.hh
@@ -91,9 +91,11 @@ public:
};
/*!
- * \brief Predicts the vapor pressure for the temperature given in
+ * \brief Predicts the vapor pressure \f$\mathrm{[Pa]}\f$ for the temperature given in
* setTP().
- *
+ * \param T temperature in \f$\mathrm{[K]}\f$
+ * \param params Parameters
+ *
* Initially, the vapor pressure is roughly estimated by using the
* Ambrose-Walton method, then the Newton method is used to make
* difference between the gas and liquid phase fugacity zero.
@@ -137,8 +139,12 @@ public:
}
/*!
- * \brief Computes molar volumes where the Peng-Robinson EOS is
- * true.
+ * \brief Computes molar volumes \f$\mathrm{[m^3 / mol]}\f$ where the Peng-Robinson EOS is
+ * true.
+ * \param fs Thermodynamic state of the fluids
+ * \param params Parameters
+ * \param phaseIdx The phase index
+ * \param isGasPhase Specifies the phase state
*/
template <class FluidState, class Params>
static Scalar computeMolarVolume(const FluidState &fs,
@@ -217,7 +223,7 @@ public:
}
/*!
- * \brief Returns the fugacity coefficient for a given pressure
+ * \brief Returns the fugacity coefficient \f$\mathrm{[-]}\f$ for a given pressure
* and molar volume.
*
* This is the same value as computeFugacity() because the mole
@@ -249,7 +255,7 @@ public:
}
/*!
- * \brief Returns the fugacity coefficient for a given pressure
+ * \brief Returns the fugacity coefficient \f$\mathrm{[-]}\f$ for a given pressure
* and molar volume.
*
* This is the fugacity coefficient times the pressure. The mole
diff --git a/dumux/material/eos/pengrobinsonmixture.hh b/dumux/material/eos/pengrobinsonmixture.hh
index 0df4681054..86ea880d9f 100644
--- a/dumux/material/eos/pengrobinsonmixture.hh
+++ b/dumux/material/eos/pengrobinsonmixture.hh
@@ -51,9 +51,12 @@ class PengRobinsonMixture
public:
/*!
- * \brief Computes molar volumes where the Peng-Robinson EOS is
+ * \brief Computes molar volumes \f$\mathrm{[m^3 / mol]}\f$ where the Peng-Robinson EOS is
* true.
- *
+ * \param Vm Molar Volume \f$\mathrm{[m^3 / mol]}\f$
+ * \param fs Thermodynamic state of the fluids
+ * \param params Parameters
+ * \param phaseIdx The phase index
* \return Number of solutions.
*/
template <class MutableParams, class FluidState>
@@ -66,9 +69,13 @@ public:
}
/*!
- * \brief Returns the fugacity coefficient of an individual
+ * \brief Returns the fugacity coefficient \f$\mathrm{[-]}\f$ of an individual
* component in the phase.
- *
+ * \param fs Thermodynamic state of the fluids
+ * \param params Parameters
+ * \param phaseIdx The phase index
+ * \param compIdx The index of the component
+ *
* The fugacity coefficient \f$\phi_i\f$ of a component \f$i\f$ is
* defined as
* \f[
diff --git a/dumux/material/eos/pengrobinsonparamsmixture.hh b/dumux/material/eos/pengrobinsonparamsmixture.hh
index 6926d4bf63..b650f63117 100644
--- a/dumux/material/eos/pengrobinsonparamsmixture.hh
+++ b/dumux/material/eos/pengrobinsonparamsmixture.hh
@@ -75,6 +75,8 @@ class PengRobinsonParamsMixture
public:
/*!
* \brief Update Peng-Robinson parameters for the pure components.
+ * \param fluidState Thermodynamic state of the fluids
+ *
*/
template <class FluidState>
void updatePure(const FluidState &fluidState)
@@ -85,7 +87,8 @@ public:
/*!
* \brief Peng-Robinson parameters for the pure components.
- *
+ * \param temperature Temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure in \f$\mathrm{[Pa]}\f$
* This method is given by the SPE5 paper.
*/
void updatePure(Scalar temperature, Scalar pressure)
--
GitLab