diff --git a/dumux/material/binarycoefficients/CMakeLists.txt b/dumux/material/binarycoefficients/CMakeLists.txt
index 1dd91a40f617cab8d754dbe4565ec32de2f3b3fc..488f6622147c34981571697a46f8ae203b9baafd 100644
--- a/dumux/material/binarycoefficients/CMakeLists.txt
+++ b/dumux/material/binarycoefficients/CMakeLists.txt
@@ -7,6 +7,8 @@ brine_air.hh
brine_co2.hh
fullermethod.hh
h2o_air.hh
+h2o_constant.hh
+h2o_heavyoil.hh
h2o_mesitylene.hh
h2o_n2.hh
h2o_o2.hh
diff --git a/dumux/material/binarycoefficients/air_mesitylene.hh b/dumux/material/binarycoefficients/air_mesitylene.hh
index ef1fb32aeff3038d9f4a6446d2b4afc9ed3a216e..9c32d8f23f817882165f50da156d5b9169221cf8 100644
--- a/dumux/material/binarycoefficients/air_mesitylene.hh
+++ b/dumux/material/binarycoefficients/air_mesitylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for air and mesitylene.
*/
#ifndef DUMUX_BINARY_COEFF_AIR_MESITYLENE_HH
@@ -33,15 +33,15 @@ namespace BinaryCoeff
{
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and mesitylene.
- * \param temperature temperature in \f$\mathrm{[K]}\f$
- *
*/
class Air_Mesitylene
{
public:
/*!
- *
+ * \brief Henry coefficient \f$\mathrm{[Pa]}\f$ for mesitylene in air.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
template <class Scalar>
static Scalar henry(Scalar temperature)
diff --git a/dumux/material/binarycoefficients/air_xylene.hh b/dumux/material/binarycoefficients/air_xylene.hh
index 811a89fc7dbb4d795d030528232f56a995c94d20..79cdae79e1feda8053e05a2c8ebbbebb57da2453 100644
--- a/dumux/material/binarycoefficients/air_xylene.hh
+++ b/dumux/material/binarycoefficients/air_xylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for air and xylene.
*/
#ifndef DUMUX_BINARY_COEFF_AIR_XYLENE_HH
@@ -33,15 +33,15 @@ namespace BinaryCoeff
{
/*!
- * \brief Binary coefficients for water and xylene.
- * \param temperature temperature in \f$\mathrm{[K]}\f$
- *
+ * \ingroup Binarycoefficients
+ * \brief Binary coefficients for air and xylene.
*/
class Air_Xylene
{
public:
/*!
- *
+ * \brief Henry coefficient \f$\mathrm{[Pa]}\f$ for mesitylene in air.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
template <class Scalar>
static Scalar henry(Scalar temperature)
diff --git a/dumux/material/binarycoefficients/brine_air.hh b/dumux/material/binarycoefficients/brine_air.hh
index 3222c8df63e4a632ce0b46ef3ccfb8a32d2cf439..600642a38a50dacc95198aeb8fe186d8d82f96a2 100644
--- a/dumux/material/binarycoefficients/brine_air.hh
+++ b/dumux/material/binarycoefficients/brine_air.hh
@@ -18,9 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Binarycoefficients
- * \brief Binary coefficients for Air and brine.
+ * \brief Binary coefficients for Brine and Air.
*/
#ifndef DUMUX_BINARY_COEFF_BRINE_Air_HH
#define DUMUX_BINARY_COEFF_BRINE_Air_HH
@@ -33,7 +32,8 @@
namespace Dumux {
namespace BinaryCoeff {
/*!
- * \brief Binary coefficients for brine and Air.
+ * \ingroup Binarycoefficients
+ * \brief Binary coefficients for Brine and Air.
*/
template<class Scalar, class Air, bool verbose = true>
class Brine_Air {
@@ -41,12 +41,12 @@ class Brine_Air {
// using Air = Dumux::Air<Scalar>;
using Brine = Dumux::Brine<Scalar,H2O>;
using IdealGas = Dumux::IdealGas<Scalar>;
- static const int lPhaseIdx = 0; // index of the liquid phase
- static const int gPhaseIdx = 1; // index of the gas phase
+ static const int wPhaseIdx = 0; // index of the liquid phase
+ static const int nPhaseIdx = 1; // index of the gas phase
public:
/*!
- * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ of water in the Air phase.
+ * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ of water in the Air phase.
*
* According to B. Xu et al. (2003) \cite xu2003 <BR>
* \param temperature the temperature \f$\mathrm{[K]}\f$
@@ -65,24 +65,24 @@ public:
;
/*!
- * Lacking better data on water-air diffusion in liquids, we use at the
- * moment the diffusion coefficient of the air's main component nitrogen!!
- * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular nitrogen in liquid water.
- *
- * 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
- * experimentally obtained diffusion coefficient of Ferrell and
- * Himmelblau by the temperature.
- * \param temperature The temperature \f$\mathrm{[K]}\f$
- * \param pressure The pressure \f$\mathrm{[Pa]}\f$
- *
- * See:
- *
- * R. Reid et al. (1987, pp. 599) \cite reid1987 <BR>
- *
- * R. Ferrell, D. Himmelblau (1967, pp. 111-115) \cite ferrell1967
- */
+ * Lacking better data on water-air diffusion in liquids, we use at the
+ * moment the diffusion coefficient of the air's main component nitrogen!!
+ * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular nitrogen in liquid water.
+ *
+ * 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
+ * experimentally obtained diffusion coefficient of Ferrell and
+ * Himmelblau by the temperature.
+ * \param temperature The temperature \f$\mathrm{[K]}\f$
+ * \param pressure The pressure \f$\mathrm{[Pa]}\f$
+ *
+ * See:
+ *
+ * R. Reid et al. (1987, pp. 599) \cite reid1987 <BR>
+ *
+ * R. Ferrell, D. Himmelblau (1967, pp. 111-115) \cite ferrell1967
+ */
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure) {
//Diffusion coefficient of Air in the H2O phase
const Scalar Texp = 273.15 + 25; // [K]
@@ -94,7 +94,7 @@ public:
* \brief Returns the _mol_ (!) fraction of Air in the liquid
* phase and the mol_ (!) fraction of H2O in the gas phase
* for a given temperature, pressure, Air density and brine
- * XlNaCl.
+ * XwNaCl.
*
* Implemented according to Spycher and Pruess (2005) \cite spycher2005 <BR>
* applying the activity coefficient expression of Duan and Sun (2003) \cite duan2003 <BR>
@@ -102,52 +102,52 @@ public:
*
* \param temperature the temperature \f$\mathrm{[K]}\f$
* \param pg the gas phase pressure \f$\mathrm{[Pa]}\f$
- * \param XlNaCl the XlNaCl \f$\mathrm{[kg NaCl / kg solution]}\f$
+ * \param XwNaCl the XwNaCl \f$\mathrm{[kg NaCl / kg solution]}\f$
* \param knownPhaseIdx indicates which phases are present
- * \param xlAir mole fraction of Air in brine \f$\mathrm{[mol/mol]}\f$
- * \param ygH2O mole fraction of water in the gas phase \f$\mathrm{[mol/mol]}\f$
- * \param xlNaCl the xlNaCl
+ * \param xwAir mole fraction of Air in brine \f$\mathrm{[mol/mol]}\f$
+ * \param xnH2O mole fraction of water in the gas phase \f$\mathrm{[mol/mol]}\f$
+ * \param xwNaCl the xwNaCl
*/
static void calculateMoleFractions(const Scalar temperature,
const Scalar pg,
- const Scalar XlNaCl,
+ const Scalar XwNaCl,
const int knownPhaseIdx,
- Scalar &xlAir,
- Scalar &ygH2O,
- Scalar &xlNaCl) {
+ Scalar &xwAir,
+ Scalar &xnH2O,
+ Scalar &xwNaCl) {
DUNE_THROW(Dune::InvalidStateException, "Function: " << "calculateMoleFractions" << " is invalid.");
// Scalar A = computeA_(temperature, pg);
//
-// /* XlNaCl: conversion from mass fraction to mol fraction */
-// xlNaCl = massTomoleFrac_(XlNaCl);
+// /* XwNaCl: conversion from mass fraction to mol fraction */
+// xwNaCl = massTomoleFrac_(XwNaCl);
//
// // if both phases are present the mole fractions in each phase can be calculate
// // with the mutual solubility function
// if (knownPhaseIdx < 0) {
-// Scalar molalityNaCl = molFracToMolality_(xlNaCl); // molality of NaCl //CHANGED
+// Scalar molalityNaCl = molFracToMolality_(xwNaCl); // molality of NaCl //CHANGED
// Scalar m0_Air = molalityAirinPureWater_(temperature, pg); // molality of Air in pure water
// Scalar gammaStar = activityCoefficient_(temperature, pg, molalityNaCl);// activity coefficient of Air in brine
// Scalar m_Air = m0_Air / gammaStar; // molality of Air in brine
-// xlAir = m_Air / (molalityNaCl + 55.508 + m_Air); // mole fraction of Air in brine
-// ygH2O = A * (1 - xlAir - xlNaCl); // mole fraction of water in the gas phase
+// xwAir = m_Air / (molalityNaCl + 55.508 + m_Air); // mole fraction of Air in brine
+// xnH2O = A * (1 - xwAir - xwNaCl); // mole fraction of water in the gas phase
// }
//
// // if only liquid phase is present the mole fraction of Air in brine is given and
// // and the virtual equilibrium mole fraction of water in the non-existing gas phase can be estimated
// // with the mutual solubility function
-// if (knownPhaseIdx == lPhaseIdx) {
-//// ygH2O = A * (1 - xlAir - xlNaCl);
-// DUNE_THROW(Dune::InvalidStateException, "phase index: " << "lPhaseIdx" << " is invalid.");
+// if (knownPhaseIdx == wPhaseIdx) {
+//// xnH2O = A * (1 - xwAir - xwNaCl);
+// DUNE_THROW(Dune::InvalidStateException, "phase index: " << "wPhaseIdx" << " is invalid.");
//
// }
//
// // if only gas phase is present the mole fraction of water in the gas phase is given and
// // and the virtual equilibrium mole fraction of Air in the non-existing liquid phase can be estimated
// // with the mutual solubility function
-// if (knownPhaseIdx == gPhaseIdx) {
+// if (knownPhaseIdx == nPhaseIdx) {
// //y_H2o = fluidstate.
-//// xlAir = 1 - xlNaCl - ygH2O / A;
-// DUNE_THROW(Dune::InvalidStateException, "phase index: " << "gPhaseIdx" << " is invalid.");
+//// xwAir = 1 - xwNaCl - xnH2O / A;
+// DUNE_THROW(Dune::InvalidStateException, "phase index: " << "nPhaseIdx" << " is invalid.");
// }
}
@@ -212,12 +212,12 @@ public:
/*!
* \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 XlNaCl mole fraction of NaCL in brine \f$\mathrm{[mol/mol]}\f$
+ * \param XwNaCl mole fraction of NaCL in brine \f$\mathrm{[mol/mol]}\f$
*/
- static Scalar molalityNaCl(Scalar XlNaCl) {
+ static Scalar molalityNaCl(Scalar XwNaCl) {
// conversion from mol fraction to molality
- const Scalar mol_NaCl = XlNaCl / 58.4428e-3;
+ const Scalar mol_NaCl = XwNaCl / 58.4428e-3;
return mol_NaCl;
}
@@ -226,19 +226,19 @@ private:
/*!
* \brief Returns the molality of NaCl \f$\mathrm{(mol NaCl / kg water)}\f$ for a given mole fraction
*
- * \param XlNaCl the XlNaCl \f$\mathrm{[kg NaCl / kg solution]}\f$
+ * \param XwNaCl the XwNaCl \f$\mathrm{[kg NaCl / kg solution]}\f$
*/
- static Scalar massTomoleFrac_(Scalar XlNaCl) {
+ static Scalar massTomoleFrac_(Scalar XwNaCl) {
DUNE_THROW(Dune::InvalidStateException, "Function: " << "massTomoleFrac_" << " is invalid.");
// const Scalar Mw = H2O::molarMass(); /* molecular weight of water [kg/mol] */
// const Scalar Ms = 58.8e-3; /* molecular weight of NaCl [kg/mol] */
//
-// const Scalar X_NaCl = XlNaCl;
-// /* XlNaCl: conversion from mass fraction to mol fraction */
-// const Scalar xlNaCl = -Mw * X_NaCl / ((Ms - Mw) * X_NaCl - Ms);
-// return xlNaCl;
+// const Scalar X_NaCl = XwNaCl;
+// /* XwNaCl: conversion from mass fraction to mol fraction */
+// const Scalar xwNaCl = -Mw * X_NaCl / ((Ms - Mw) * X_NaCl - Ms);
+// return xwNaCl;
}
/*!
@@ -431,12 +431,12 @@ public:
const Scalar Mw = H2O::molarMass(); /* molecular weight of water [kg/mol] */
const Scalar Ms = 58.8e-3; /* molecular weight of NaCl [kg/mol] */
- const Scalar X_NaCl = Brine::XlNaCl;
- /* XlNaCl: conversion from mass fraction to mole fraction */
- const Scalar xlNaCl = -Mw * X_NaCl / ((Ms - Mw) * X_NaCl - Ms);
+ const Scalar X_NaCl = Brine::XwNaCl;
+ /* XwNaCl: conversion from mass fraction to mole fraction */
+ const Scalar xwNaCl = -Mw * X_NaCl / ((Ms - Mw) * X_NaCl - Ms);
- // XlNaCl: conversion from mole fraction to molality
- const Scalar mol_NaCl = -55.56 * xlNaCl / (xlNaCl - 1);
+ // XwNaCl: conversion from mole fraction to molality
+ const Scalar mol_NaCl = -55.56 * xwNaCl / (xwNaCl - 1);
const Scalar A = computeA_(temperature, pg); /* mu_{Air}^{l(0)}/RT */
const Scalar B = computeB_(temperature, pg); /* lambda_{Air-Na+} */
@@ -459,10 +459,10 @@ public:
private:
/*!
- * \brief computation of mu_{Air}^{l(0)}/RT
- * \param T the temperature [K]
- * \param pg the gas phase pressure [Pa]
- */
+ * \brief computation of mu_{Air}^{l(0)}/RT
+ * \param T the temperature [K]
+ * \param pg the gas phase pressure [Pa]
+ */
static Scalar computeA_(Scalar T, Scalar pg)
{
static const Scalar c[10] = {
@@ -564,7 +564,6 @@ private:
* \param pg the gas phase pressure [Pa]
* \param rhoAir the density of Air for the critical volume [kg/m^3]
*/
-
static Scalar fugacityCoeffAir_(Scalar temperature,
Scalar pg,
Scalar rhoAir)
diff --git a/dumux/material/binarycoefficients/brine_co2.hh b/dumux/material/binarycoefficients/brine_co2.hh
index add4d655c04496cae78e6de2f533275b7a831185..2ccd73f9e56a9382beca6090b328311bb83417f1 100644
--- a/dumux/material/binarycoefficients/brine_co2.hh
+++ b/dumux/material/binarycoefficients/brine_co2.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Binarycoefficients
* \brief Binary coefficients for CO2 and brine.
*/
@@ -33,6 +32,7 @@
namespace Dumux {
namespace BinaryCoeff {
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for brine and CO2.
*/
template<class Scalar, class CO2Tables, bool verbose = true>
@@ -92,7 +92,6 @@ public:
* \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,
const Scalar pg,
const Scalar salinity,
@@ -442,10 +441,10 @@ public:
private:
/*!
- * \brief computation of \f$\mathrm{[mu_{CO2}^{l(0)}/RT]}\f$
+ * \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)
{
static const Scalar c[10] = {
@@ -504,6 +503,7 @@ private:
c9*pg_bar/(630.0-T) +
c11*T*log(pg_bar);
}
+
/*!
* \brief computation of C
*
@@ -525,6 +525,7 @@ private:
c8*pg_bar/T +
c9*pg_bar/(630.0-T);
}
+
/*!
* \brief computation of partial pressure CO2
*
@@ -547,7 +548,6 @@ private:
* \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,
Scalar pg,
Scalar rhoCO2)
diff --git a/dumux/material/binarycoefficients/fullermethod.hh b/dumux/material/binarycoefficients/fullermethod.hh
index 27646cc341a45c08a5112e4020d71da0e808fb97..222b9921742fbc8bc9ce4cf87b22b99d1d421155 100644
--- a/dumux/material/binarycoefficients/fullermethod.hh
+++ b/dumux/material/binarycoefficients/fullermethod.hh
@@ -18,7 +18,9 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup Binarycoefficients
* \brief Various relations for molecular diffusion coefficients.
+ * \copydetails fullerMethod
*/
#ifndef DUMUX_FULLERMETHOD_HH
#define DUMUX_FULLERMETHOD_HH
@@ -30,7 +32,6 @@ namespace Dumux
namespace BinaryCoeff
{
/*!
- * \ingroup Binarycoefficients
* \brief Estimate binary diffusion coefficients \f$\mathrm{[m^2/s]}\f$ in gases according to
* the method by Fuller.
*
diff --git a/dumux/material/binarycoefficients/h2o_air.hh b/dumux/material/binarycoefficients/h2o_air.hh
index ef688f0e28e52a244c9893c77544544d3acb511d..57269cda07007d230fe80c3f032c8438b062fffe 100644
--- a/dumux/material/binarycoefficients/h2o_air.hh
+++ b/dumux/material/binarycoefficients/h2o_air.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief Binary coefficients for water and nitrogen.
+ * \ingroup Binarycoefficients
+ * \brief Binary coefficients for water and air.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_AIR_HH
#define DUMUX_BINARY_COEFF_H2O_AIR_HH
@@ -34,7 +34,7 @@ namespace BinaryCoeff
/*!
* \ingroup Binarycoefficients
- * \brief Binary coefficients for water and nitrogen.
+ * \brief Binary coefficients for water and air.
*/
class H2O_Air
{
diff --git a/dumux/material/binarycoefficients/h2o_constant.hh b/dumux/material/binarycoefficients/h2o_constant.hh
index b686fe58857c18d014071994f30dec0039de6c73..dd95b09d558a38eefd26b671e33d8b740358ed5f 100644
--- a/dumux/material/binarycoefficients/h2o_constant.hh
+++ b/dumux/material/binarycoefficients/h2o_constant.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and a "constant" component.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_CONSTANT_HH
@@ -37,6 +37,7 @@ namespace BinaryCoeff
{
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and another component.
* \todo All other binary coefficient could be generalized like this
*/
@@ -58,12 +59,10 @@ class H2O_Component<Scalar, Components::Constant<id, Scalar>>
{
public:
/*!
- * \brief Henry coefficent \f$N/m^2\f$ for heavy oil in liquid water.
- *
- * See:
+ * \brief Henry coefficent \f$N/m^2\f$ for the constant component in liquid water.
*
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
-
static Scalar henryCompInWater(Scalar temperature)
{
static const Scalar h = getParamFromGroup<Scalar>(std::to_string(id), "Component.HenryComponentInWater", 1.0);
@@ -71,12 +70,10 @@ public:
}
/*!
- * \brief Henry coefficent \f$N/m^2\f$ for water in liquid heavy oil.
- *
- * See:
+ * \brief Henry coefficent \f$N/m^2\f$ for water in the constant component.
*
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
-
static Scalar henryWaterInComp(Scalar temperature)
{
static const Scalar h = getParamFromGroup<Scalar>(std::to_string(id), "Component.HenryWaterInComponent", 1.0);
@@ -85,8 +82,9 @@ public:
/*!
- * \brief Binary diffusion coefficent \f$m^2/s\f$ for molecular water and heavy oil.
- *
+ * \brief Binary diffusion coefficent \f$m^2/s\f$ for molecular water and the constant component.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasDiffCoeff(Scalar temperature, Scalar pressure)
{
@@ -95,9 +93,9 @@ public:
}
/*!
- * \brief Diffusion coefficent \f$m^2/s\f$ for tce in liquid water.
- *
- * \todo
+ * \brief Diffusion coefficent \f$m^2/s\f$ for the constant component in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/binarycoefficients/h2o_heavyoil.hh b/dumux/material/binarycoefficients/h2o_heavyoil.hh
index cead97c2f5147da6159fed9bb45bf574bd07a896..86d494be7cf184d283c8091f2713f2cd53a7c729 100644
--- a/dumux/material/binarycoefficients/h2o_heavyoil.hh
+++ b/dumux/material/binarycoefficients/h2o_heavyoil.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief Binary coefficients for water and tce.
+ * \ingroup Binarycoefficients
+ * \brief Binary coefficients for water and heavy oil.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_HEAVYOIL_HH
#define DUMUX_BINARY_COEFF_H2O_HEAVYOIL_HH
@@ -33,6 +33,7 @@ namespace BinaryCoeff
{
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and heavy oil as in SAGD processes
*/
class H2O_HeavyOil
@@ -40,11 +41,8 @@ class H2O_HeavyOil
public:
/*!
* \brief Henry coefficient \f$[N/m^2]\f$ for heavy oil in liquid water.
- *
- * See:
- *
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
-
template <class Scalar>
static Scalar henryOilInWater(Scalar temperature)
{
@@ -56,11 +54,8 @@ public:
/*!
* \brief Henry coefficient \f$[N/m^2]\f$ for water in liquid heavy oil.
- *
- * See:
- *
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
*/
-
template <class Scalar>
static Scalar henryWaterInOil(Scalar temperature)
{
@@ -71,7 +66,8 @@ public:
/*!
* \brief Binary diffusion coefficient [m^2/s] for molecular water and heavy oil.
- *
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
template <class Scalar>
static Scalar gasDiffCoeff(Scalar temperature, Scalar pressure)
@@ -80,9 +76,9 @@ public:
}
/*!
- * \brief Diffusion coefficient [m^2/s] for tce in liquid water.
- *
- * \todo
+ * \brief Diffusion coefficient [m^2/s] for heavy oil in liquid water.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*/
template <class Scalar>
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
diff --git a/dumux/material/binarycoefficients/h2o_mesitylene.hh b/dumux/material/binarycoefficients/h2o_mesitylene.hh
index b19a70bcc7f4cc4254a01c9956140b0876baf8a2..747598a0021095c29043c2d1cb67cd448a5851ad 100644
--- a/dumux/material/binarycoefficients/h2o_mesitylene.hh
+++ b/dumux/material/binarycoefficients/h2o_mesitylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and mesitylene.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_MESITYLENE_HH
@@ -33,6 +33,7 @@ namespace BinaryCoeff
{
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and mesitylene.
*/
class H2O_Mesitylene
@@ -42,8 +43,7 @@ public:
* \brief Henry coefficient \f$\mathrm{[Pa]}\f$ for mesitylene in liquid water.
* \param temperature the temperature \f$\mathrm{[K]}\f$
* See:
- *
- * R. Sander (1999) \cite sander1999
+ * R. Sander (1999) \cite sander1999
*/
template <class Scalar>
static Scalar henry(Scalar temperature)
@@ -60,7 +60,6 @@ public:
* \brief Binary diffusion coefficient \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>
static Scalar gasDiffCoeff(Scalar temperature, Scalar pressure)
diff --git a/dumux/material/binarycoefficients/h2o_n2.hh b/dumux/material/binarycoefficients/h2o_n2.hh
index b1e2128f953fd949a22af78cdc72bc06cfc60eb7..17ac08e6b60e9b521ef2249a20296389b2a590d0 100644
--- a/dumux/material/binarycoefficients/h2o_n2.hh
+++ b/dumux/material/binarycoefficients/h2o_n2.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and nitrogen.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_N2_HH
diff --git a/dumux/material/binarycoefficients/h2o_o2.hh b/dumux/material/binarycoefficients/h2o_o2.hh
index f5022d0f2042025ece57c916d72b3bf28e114852..0602ef6a40cb191917d21245c8eee9ce4b6dbb26 100644
--- a/dumux/material/binarycoefficients/h2o_o2.hh
+++ b/dumux/material/binarycoefficients/h2o_o2.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and oxygen.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_O2_HH
@@ -58,7 +58,7 @@ public:
}
/*!
- * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular water and nitrogen.
+ * \brief Binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular water and oxygen.
*
* Uses fullerMethod to determine the diffusion of water in nitrogen.
* \param temperature the temperature \f$\mathrm{[K]}\f$
@@ -79,7 +79,7 @@ public:
}
/*!
- * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular nitrogen in liquid water.
+ * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular oxygen in liquid water.
* \param temperature the temperature \f$\mathrm{[K]}\f$
* \param pressure the phase pressure \f$\mathrm{[Pa]}\f$
*
diff --git a/dumux/material/binarycoefficients/h2o_xylene.hh b/dumux/material/binarycoefficients/h2o_xylene.hh
index 4c0c13561885314fea0601130b48f692c6396d04..3ab32237d0dcdeb363f9f8b256e4af30a0247421 100644
--- a/dumux/material/binarycoefficients/h2o_xylene.hh
+++ b/dumux/material/binarycoefficients/h2o_xylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and xylene.
*/
#ifndef DUMUX_BINARY_COEFF_H2O_XYLENE_HH
@@ -33,6 +33,7 @@ namespace BinaryCoeff
{
/*!
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for water and xylene.
*/
class H2O_Xylene
@@ -46,7 +47,6 @@ public:
*
* Sander (1999) \cite sander1999
*/
-
template <class Scalar>
static Scalar henry(Scalar temperature)
{
diff --git a/dumux/material/binarycoefficients/henryiapws.hh b/dumux/material/binarycoefficients/henryiapws.hh
index 7aff4c840d891b4b05faf3a6640129dad0191aef..855b67dc0a4152e460b7249fa51dc628bb1880c2 100644
--- a/dumux/material/binarycoefficients/henryiapws.hh
+++ b/dumux/material/binarycoefficients/henryiapws.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief The IAPWS formulation of Henry coefficients in water.
*/
#ifndef DUMUX_HENRY_IAPWS_HH
@@ -29,7 +29,6 @@
namespace Dumux
{
/*!
- * \ingroup Binarycoefficients
* \brief The Henry constants in liquid water using the IAPWS 2004
* formulation.
* \param E Correlation parameter
diff --git a/dumux/material/binarycoefficients/n2_o2.hh b/dumux/material/binarycoefficients/n2_o2.hh
index 5baae1d2d26af35e8f2eff5be31c6181f11be7aa..16216c1f73486856db9842102fce6d52042611f6 100644
--- a/dumux/material/binarycoefficients/n2_o2.hh
+++ b/dumux/material/binarycoefficients/n2_o2.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Binarycoefficients
* \brief Binary coefficients for nitrogen and oxygen.
*/
#ifndef DUMUX_BINARY_COEFF_N2_O2_HH
diff --git a/dumux/material/chemistry/electrochemistry/electrochemistry.hh b/dumux/material/chemistry/electrochemistry/electrochemistry.hh
index 3e64759209026665a2bbfd3cea486fc06f2aa8ae..35d8f78aeb865ea8915ab81c0b68e6c054d82723 100644
--- a/dumux/material/chemistry/electrochemistry/electrochemistry.hh
+++ b/dumux/material/chemistry/electrochemistry/electrochemistry.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Chemistry
* \brief Electrochemical model for a fuel cell application.
*/
#ifndef DUMUX_ELECTROCHEMISTRY_HH
@@ -36,14 +36,13 @@ namespace Dumux
{
/*!
- * \brief
- * The type of electrochemistry models implemented here (Ochs (2008) \cite ochs2008 or Acosta et al. (2006) \cite A3:acosta:2006 )
+ * \ingroup Chemistry
+ * \brief The type of electrochemistry models implemented here (Ochs (2008) \cite ochs2008 or Acosta et al. (2006) \cite A3:acosta:2006 )
*/
enum ElectroChemistryModel { Ochs, Acosta };
/*!
- * \brief
- * This class calculates source terms and current densities for fuel cells
+ * \brief This class calculates source terms and current densities for fuel cells
* with the electrochemical models suggested by Ochs (2008) \cite ochs2008 or Acosta et al. (2006) \cite A3:acosta:2006
*/
template <class TypeTag, ElectroChemistryModel electroChemistryModel>
@@ -96,13 +95,13 @@ class ElectroChemistry
public:
/*!
- * \brief Calculates reaction sources with an electrochemical model approach.
- *
- * \param values The primary variable vector
- * \param currentDensity The current density
- *
- * For this method, the \a values parameter stores source values
- */
+ * \brief Calculates reaction sources with an electrochemical model approach.
+ *
+ * \param values The primary variable vector
+ * \param currentDensity The current density
+ *
+ * For this method, the \a values parameter stores source values
+ */
static void reactionSource(SourceValues &values,
Scalar currentDensity)
{
@@ -128,9 +127,10 @@ public:
}
/*!
- * \brief Newton solver for calculation of the current density.
- * \returns The current density in A/m^2
- */
+ * \brief Newton solver for calculation of the current density.
+ * \param volVars The volume variables
+ * \returns The current density in A/m^2
+ */
static Scalar calculateCurrentDensity(const VolumeVariables &volVars)
{
static Scalar maxIter = getParamFromGroup<Scalar>(GET_PROP_VALUE(TypeTag, ModelParameterGroup), "ElectroChemistry.MaxIterations");
@@ -198,8 +198,10 @@ public:
private:
/*!
- * \brief Calculation of the activation losses
- */
+ * \brief Calculation of the activation losses
+ * \param volVars The volume variables
+ * \param currentDensity The current density
+ */
static Scalar calculateActivationLosses_(const VolumeVariables &volVars, const Scalar currentDensity)
{
static Scalar refO2PartialPressure = getParamFromGroup<Scalar>(GET_PROP_VALUE(TypeTag, ModelParameterGroup), "ElectroChemistry.RefO2PartialPressure");
@@ -237,8 +239,9 @@ private:
/*!
- * \brief Calculation of concentration losses.
- */
+ * \brief Calculation of concentration losses.
+ * \param volVars The volume variables
+ */
static Scalar calculateConcentrationLosses_(const VolumeVariables &volVars)
{
static Scalar pO2Inlet = getParamFromGroup<Scalar>(GET_PROP_VALUE(TypeTag, ModelParameterGroup), "ElectroChemistry.pO2Inlet");
@@ -267,8 +270,9 @@ private:
/*!
- * \brief Calculation of the exchange current density.
- */
+ * \brief Calculation of the exchange current density.
+ * \param volVars The volume variables
+ */
static Scalar exchangeCurrentDensity_(const VolumeVariables &volVars)
{
using std::exp;
diff --git a/dumux/material/chemistry/electrochemistry/electrochemistryni.hh b/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
index e3b60fe6576d66196eab1a2b681fb69579aa61bf..907fd1b67122089a23ff2c1e9bb4bbdb9f4c13fd 100644
--- a/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
+++ b/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
@@ -18,10 +18,9 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Chemistry
* \brief Electrochemical model for a fuel cell application.
*/
-
#ifndef DUMUX_ELECTROCHEMISTRY_NI_HH
#define DUMUX_ELECTROCHEMISTRY_NI_HH
@@ -33,11 +32,11 @@ namespace Dumux
{
/*!
-* \brief
-* Class calculating source terms and current densities for fuel cells
-* with the electrochemical models suggested by Ochs (2008) \cite ochs2008 or Acosta (2006) \cite A3:acosta:2006
-* for the non-isothermal case
-*/
+ * \ingroup Chemistry
+ * \brief Class calculating source terms and current densities for fuel cells
+ * with the electrochemical models suggested by Ochs (2008) \cite ochs2008 or Acosta (2006) \cite A3:acosta:2006
+ * for the non-isothermal case.
+ */
template <class TypeTag, ElectroChemistryModel electroChemistryModel>
class ElectroChemistryNI : public ElectroChemistry<TypeTag, electroChemistryModel>
{
@@ -73,13 +72,13 @@ class ElectroChemistryNI : public ElectroChemistry<TypeTag, electroChemistryMode
public:
/*!
- * \brief Calculates reaction sources with an electrochemical model approach.
- *
- * \param values The primary variable vector
- * \param currentDensity The current density
- *
- * For this method, the \a values parameter stores source values
- */
+ * \brief Calculates reaction sources with an electrochemical model approach.
+ *
+ * \param values The primary variable vector
+ * \param currentDensity The current density
+ *
+ * For this method, the \a values parameter stores source values
+ */
static void reactionSource(SourceValues &values,
Scalar currentDensity)
{
diff --git a/dumux/material/components/CMakeLists.txt b/dumux/material/components/CMakeLists.txt
index 7716160c7c5902cb32517bbbe69e4aa8f540f777..6427f4bda3e49102b4a1bed1ba71e6f935e90add 100644
--- a/dumux/material/components/CMakeLists.txt
+++ b/dumux/material/components/CMakeLists.txt
@@ -5,14 +5,18 @@ install(FILES
air.hh
benzene.hh
brine.hh
+CaO.hh
+CaO2H2.hh
ch4.hh
co2.hh
-co2tables.inc
co2tablereader.hh
+co2tables.inc
component.hh
+constant.hh
dnapl.hh
h2.hh
h2o.hh
+heavyoil.hh
lnapl.hh
mesitylene.hh
n2.hh
diff --git a/dumux/material/components/CaO.hh b/dumux/material/components/CaO.hh
index 6ae7bbda2c4f4ffbb7340f48c52d4ca08f1afa61..ab6cf89c520ee3582c9a3af6fd82970916b2f676 100644
--- a/dumux/material/components/CaO.hh
+++ b/dumux/material/components/CaO.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure Calcium-Oxide \f$CaO\f$.
*/
#ifndef DUMUX_CAO_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the CaO properties
*/
template <class Scalar>
diff --git a/dumux/material/components/CaO2H2.hh b/dumux/material/components/CaO2H2.hh
index 423ce4de32709c4927b479af49a37068c843fab4..cc484ca1019ca8d549f5e37909f953772145bafc 100644
--- a/dumux/material/components/CaO2H2.hh
+++ b/dumux/material/components/CaO2H2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure Calciumhydroxide \f$CaO2H2\f$.
*/
#ifndef DUMUX_CAO2H2_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the CaO2H2 properties
*/
template <class Scalar>
diff --git a/dumux/material/components/air.hh b/dumux/material/components/air.hh
index 17b41f670298c846f78571ac8198a70e0dcfd002..a22328a918a8985f70f6cb866cea6bb04ef36f53 100644
--- a/dumux/material/components/air.hh
+++ b/dumux/material/components/air.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A simple class for the air fluid properties
*/
#ifndef DUMUX_AIR_HH
@@ -34,7 +32,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A class for the air fluid properties
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/benzene.hh b/dumux/material/components/benzene.hh
index 645dc1eb79a20631faf9f6887c7263016c727d2b..4aa834036b376fcb1e95a89f46f0bb35b0fa643e 100644
--- a/dumux/material/components/benzene.hh
+++ b/dumux/material/components/benzene.hh
@@ -32,7 +32,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A simple benzene component (LNAPL).
*
* \tparam Scalar The type used for scalar values
@@ -124,7 +123,7 @@ public:
}
/*!
- * \brief The density of steam at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
+ * \brief The density of benzene steam at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -148,7 +147,7 @@ public:
}
/*!
- * \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of steam.
+ * \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of benzene steam.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh
index b4103b5c9227e8c4e6352da3e890aa39d19f763c..73c9926423fd73c36e13a65f06b3cb88f435cfb7 100644
--- a/dumux/material/components/brine.hh
+++ b/dumux/material/components/brine.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A class for the brine fluid properties,.
*/
#ifndef DUMUX_BRINE_HH
@@ -37,9 +35,7 @@
namespace Dumux
{
/*!
- *
* \ingroup Components
- *
* \brief A class for the brine fluid properties.
*
* \tparam Scalar The type used for scalar values
@@ -125,9 +121,9 @@ public:
* \param salinity The mass fraction of salt
*
* Equations given in:
- * - Palliser & McKibbin (1998) \cite palliser1998 <BR>
- * - Michaelides (1981) \cite michaelides1981 <BR>
- * - Daubert & Danner (1989) \cite daubert1989
+ * - Palliser & McKibbin (1998) \cite palliser1998 <BR>
+ * - Michaelides (1981) \cite michaelides1981 <BR>
+ * - Daubert & Danner (1989) \cite daubert1989
*
*/
static const Scalar liquidEnthalpy(Scalar T,
@@ -179,7 +175,7 @@ public:
}
/*!
- * \brief Specific isobaric heat capacity of liquid water \f$\mathrm{[J/kg]}\f$.
+ * \brief Specific isobaric heat capacity of brine \f$\mathrm{[J/kg]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -317,7 +313,7 @@ public:
{ return H2O::gasPressure(temperature, density); }
/*!
- * \brief The pressure of liquid water in \f$\mathrm{[Pa]}\f$ at a given density and
+ * \brief The pressure of brine in \f$\mathrm{[Pa]}\f$ at a given density and
* temperature.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
diff --git a/dumux/material/components/ch4.hh b/dumux/material/components/ch4.hh
index dcf1b2d65849c24d6b059d97e49b6183e289488b..81b8e275d777181d1e8c4ea1a988ba6224a87d82 100644
--- a/dumux/material/components/ch4.hh
+++ b/dumux/material/components/ch4.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of methane \f$CH_4\f$.
*/
#ifndef DUMUX_CH4_HH
@@ -37,9 +35,7 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Properties of pure molecular methane \f$CH_4\f$.
- *
* \tparam Scalar The type used for scalar values
*/
template <class Scalar>
@@ -227,7 +223,7 @@ public:
2.16178*exp(- 2.43787*Tstar);
Scalar mu = 40.785*Fc*sqrt(M*temperature)/(pow(Vc, 2./3)*Omega_v);
- // convertion from micro poise to Pa s
+ // conversion from micro poise to Pa s
return mu/1e6 / 10;
}
};
diff --git a/dumux/material/components/co2.hh b/dumux/material/components/co2.hh
index 39bdfd6cbdd554eea8318b4bdac8e05e54089732..02b340a4dc7828c98f833ba7ea592e110b29b930 100644
--- a/dumux/material/components/co2.hh
+++ b/dumux/material/components/co2.hh
@@ -19,7 +19,6 @@
/*!
* \file
* \ingroup Components
- *
* \brief A class for the CO2 fluid properties
*/
#ifndef DUMUX_CO2_HH
@@ -119,7 +118,7 @@ public:
/*!
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure CO2
* at a given temperature.
- *
+ * \param T the temperature \f$\mathrm{[K]}\f$
* See:
*
* R. Span and W. Wagner (1996, pp. 1509-1596) \cite span1996
@@ -147,6 +146,8 @@ public:
/*!
* \brief Specific enthalpy of gaseous CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
@@ -163,6 +164,8 @@ public:
/*!
* \brief Specific enthalpy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidEnthalpy(Scalar temperature,
Scalar pressure)
@@ -179,6 +182,8 @@ public:
/*!
* \brief Specific internal energy of CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
@@ -191,6 +196,8 @@ public:
/*!
* \brief Specific internal energy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidInternalEnergy(Scalar temperature,
Scalar pressure)
@@ -203,7 +210,9 @@ public:
/*!
* \brief The density of CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
- */
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
+ */
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
if ((temperature < criticalTemperature() || pressure < criticalPressure()) && !warningThrown)
@@ -218,6 +227,8 @@ public:
/*!
* \brief The density of pure CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
+ * \param temperature the temperature \f$\mathrm{[K]}\f$
+ * \param pressure the pressure \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/co2tablereader.hh b/dumux/material/components/co2tablereader.hh
index 7ae96b9f6ef51b0826875edd3f1b0f3da26b15e2..dfabfb4d82904fc9a9eac98e470ee2e6b52e1db8 100644
--- a/dumux/material/components/co2tablereader.hh
+++ b/dumux/material/components/co2tablereader.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Components
* \brief A generic template for tabulated material laws that depend
* on two parameters.
*/
@@ -30,6 +30,7 @@
namespace Dumux {
/*!
+ * \ingroup Components
* \brief A generic template for tabulated material laws that depend
* on two parameters.
*/
diff --git a/dumux/material/components/component.hh b/dumux/material/components/component.hh
index 8958e76cc6f252ce3ca4d2dce846f9501e84917e..a8e9a82bb47948ab6410f6c9d6c36cb8a2c79610 100644
--- a/dumux/material/components/component.hh
+++ b/dumux/material/components/component.hh
@@ -19,7 +19,6 @@
/*!
* \file
- *
* \ingroup Components
* \brief Abstract base class of a pure chemical species.
*/
diff --git a/dumux/material/components/constant.hh b/dumux/material/components/constant.hh
index a96705977dd981a3f9dcb115ddbb918308eb84a3..878255a52dbf47a2017f79f17115c0dc4d8b7635 100644
--- a/dumux/material/components/constant.hh
+++ b/dumux/material/components/constant.hh
@@ -33,7 +33,6 @@ namespace Components {
/*!
* \ingroup Components
- *
* \brief A component which returns run time specified values
* for all fluid properties.
*
@@ -59,7 +58,7 @@ public:
{ return false; }
/*!
- * \brief Returns true if the gas phase viscostiy is constant
+ * \brief Returns true if the gas phase viscosity is constant
*/
static constexpr bool gasViscosityIsConstant()
{ return true; }
@@ -77,7 +76,7 @@ public:
{ return false; }
/*!
- * \brief Returns true if the liquid phase viscostiy is constant
+ * \brief Returns true if the liquid phase viscosity is constant
*/
static constexpr bool liquidViscosityIsConstant()
{ return true; }
diff --git a/dumux/material/components/h2.hh b/dumux/material/components/h2.hh
index f3b3792f8113fc841f36eb0ceddc4c465b082946..5b705b67ed7df2109433a3f71ef18ee9282d138d 100644
--- a/dumux/material/components/h2.hh
+++ b/dumux/material/components/h2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular hydrogen \f$H_2\f$.
*/
#ifndef DUMUX_H2_HH
@@ -37,7 +35,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Properties of pure molecular hydrogen \f$H_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -161,6 +158,8 @@ public:
*
* This is equivalent to the partial derivative of the specific
* enthalpy to the temperature.
+ * \param T temperature of component in \f$\mathrm{[K]}\f$
+ * \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*
* See: R. Reid, et al. (1987, pp 154, 657, 665) \cite reid1987
*/
@@ -184,7 +183,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of \f$H_2\f$ at a given pressure and temperature.
*
- *\param temperature 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$
*
* See:
diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh
index acf9c76d58b658abf5eb0990ec98d1905eada017..c92a63868e675253da219cd48eaaec6472811763 100644
--- a/dumux/material/components/h2o.hh
+++ b/dumux/material/components/h2o.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure water \f$H_2O\f$.
*/
#ifndef DUMUX_H2O_HH
@@ -44,9 +42,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief Material properties of pure water \f$H_2O\f$.
- *
* \tparam Scalar The type used for scalar values
*
* See:
@@ -351,7 +347,7 @@ public:
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
* 1997 for the Thermodynamic Properties of Water and Steam",
* http://www.iapws.org/relguide/IF97-Rev.pdf \cite IAPWS1997
- */
+ */
static Scalar gasInternalEnergy(Scalar temperature, Scalar pressure)
{
Region2::checkValidityRange(temperature, pressure, "Internal energy");
@@ -446,7 +442,7 @@ public:
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
* 1997 for the Thermodynamic Properties of Water and Steam",
* http://www.iapws.org/relguide/IF97-Rev.pdf \cite IAPWS1997
- */
+ */
static Scalar gasHeatCapacityConstVolume(Scalar temperature, Scalar pressure)
{
Region2::checkValidityRange(temperature, pressure, "Heat capacity for a constant volume");
diff --git a/dumux/material/components/heavyoil.hh b/dumux/material/components/heavyoil.hh
index d759f0de704a4e237a13e68d3a29a68fa81b9397..c866c8e6535b3f7e264f0eb550952decffd4716c 100644
--- a/dumux/material/components/heavyoil.hh
+++ b/dumux/material/components/heavyoil.hh
@@ -18,10 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
- * \brief Properties of heavyoil.
+ * \brief Properties of the component heavyoil.
*
*/
#ifndef DUMUX_HEAVYOIL_HH
@@ -35,7 +33,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- * \brief heavyoil
+ * \brief Properties of the component heavyoil
*
* \tparam Scalar The type used for scalar values
*/
@@ -220,8 +218,6 @@ public:
/*!
* \brief The saturation vapor pressure in \f$\mathrm{[Pa]}\f$ of
*
- *
- *
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar vaporPressure(Scalar temperature)
@@ -330,7 +326,7 @@ public:
}
/*!
- * \brief
+ * \brief The (ideal) gas density of heavyoil vapor at a given temperature and pressure \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/iapws/common.hh b/dumux/material/components/iapws/common.hh
index 24406440fab76abaddca9bc5c2e903ef3705e182..19349c8eda636360eaa1a3a50b74a72a3afde988 100644
--- a/dumux/material/components/iapws/common.hh
+++ b/dumux/material/components/iapws/common.hh
@@ -18,12 +18,9 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup IAPWS
- *
* \brief Implements relations common for all regions of the IAPWS '97
* formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -46,7 +43,6 @@ namespace IAPWS
/*!
*
* \ingroup IAPWS
- *
* \brief Implements relations which are common for all regions of the IAPWS '97
* formulation.
*
@@ -152,18 +148,18 @@ public:
}
/*!
- * \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ water (IAPWS) .
- *
- * Implementation taken from:
- * freesteam - IAPWS-IF97 steam tables library
- * copyright (C) 2004-2009 John Pye
- *
- * Appendix B: Recommended Interpolating equation for Industrial Use
- * see http://www.iapws.org/relguide/thcond.pdf
- *
- * \param T absolute temperature in \f$\mathrm{[K]}\f$
- * \param rho density of water in \f$\mathrm{[kg/m^3]}\f$
- */
+ * \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ water (IAPWS) .
+ *
+ * Implementation taken from:
+ * freesteam - IAPWS-IF97 steam tables library
+ * copyright (C) 2004-2009 John Pye
+ *
+ * Appendix B: Recommended Interpolating equation for Industrial Use
+ * see http://www.iapws.org/relguide/thcond.pdf
+ *
+ * \param T absolute temperature in \f$\mathrm{[K]}\f$
+ * \param rho density of water in \f$\mathrm{[kg/m^3]}\f$
+ */
static Scalar thermalConductivityIAPWS(const Scalar T, const Scalar rho)
{
Scalar thcond_tstar = 647.26 ;
diff --git a/dumux/material/components/iapws/region1.hh b/dumux/material/components/iapws/region1.hh
index eefff15ef6b318d27b7ce8f35b0061b5e03e8926..bdc4f9960565f2365cb3dd262dc52e502a4276d1 100644
--- a/dumux/material/components/iapws/region1.hh
+++ b/dumux/material/components/iapws/region1.hh
@@ -18,11 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- *\ingroup IAPWS
- *
+ * \ingroup IAPWS
* \brief Implements the equations for region 1 of the IAPWS '97 formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -42,11 +39,8 @@ namespace IAPWS
{
/*!
* \ingroup IAPWS
- *
* \brief Implements the equations for region 1 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
diff --git a/dumux/material/components/iapws/region2.hh b/dumux/material/components/iapws/region2.hh
index a7bfe45cfa39d94fb3ed3031cbe7f7c827645e71..33c50889caa448daa5efe9607edcabcae2637115 100644
--- a/dumux/material/components/iapws/region2.hh
+++ b/dumux/material/components/iapws/region2.hh
@@ -19,11 +19,8 @@
/*!
* \file
- *
* \ingroup IAPWS
- *
* \brief Implements the equations for region 2 of the IAPWS '97 formulation.
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
@@ -42,13 +39,9 @@ namespace Dumux
namespace IAPWS
{
/*!
- *
* \ingroup IAPWS
- *
* \brief Implements the equations for region 2 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
- *
* See:
*
* IAPWS: "Revised Release on the IAPWS Industrial Formulation
diff --git a/dumux/material/components/iapws/region4.hh b/dumux/material/components/iapws/region4.hh
index e3496ed8af951808da6fec4fff7a0c658c8fe8f5..ca5fdb6b6cde522bca9859d8d655ec6a8102d53f 100644
--- a/dumux/material/components/iapws/region4.hh
+++ b/dumux/material/components/iapws/region4.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
- *\ingroup IAPWS
- *
+ * \ingroup IAPWS
* \brief Implements the equations for region 4 of the IAPWS '97 formulation.
*
* See:
@@ -42,9 +40,7 @@ namespace IAPWS
/*!
* \ingroup IAPWS
- *
* \brief Implements the equations for region 4 of the IAPWS '97 formulation.
- *
* \tparam Scalar The type used for scalar values
*
* See:
diff --git a/dumux/material/components/lnapl.hh b/dumux/material/components/lnapl.hh
index eb7b3416e905e8369669ad293c0d28dcb73cb011..67d1be4302b1fe59664abf8c0ee827dc63ec6c34 100644
--- a/dumux/material/components/lnapl.hh
+++ b/dumux/material/components/lnapl.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *\ingroup Components
+ * \ingroup Components
* \brief A simple implementation of a LNAPL.
*/
#ifndef DUMUX_LNAPL_HH
@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A simple implementation of a LNAPL, e.g. a kind of oil
*
* \tparam Scalar The type used for scalar values
@@ -54,7 +53,7 @@ public:
{ return false; }
/*!
- * \brief Rough estimate of the density of oil \f$\mathrm{[kg/m^3]}\f$.
+ * \brief Rough estimate of the liquid density of oil \f$\mathrm{[kg/m^3]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
@@ -65,7 +64,7 @@ public:
}
/*!
- * \brief Rough estimate of the viscosity of oil in \f$\mathrm{[Pa*s]}\f$.
+ * \brief Rough estimate of the liquid viscosity of oil in \f$\mathrm{[Pa*s]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
diff --git a/dumux/material/components/mesitylene.hh b/dumux/material/components/mesitylene.hh
index 73af118f97947c29c97ca22146430c0ff404036e..524b754cd12b572aacb5e441f5c3d916c0ced1f6 100644
--- a/dumux/material/components/mesitylene.hh
+++ b/dumux/material/components/mesitylene.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of mesitylene.
*
*/
diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh
index 28a3f4b57b1468bbdd710b7af97a194bf7044124..c137c6f29bfdb90dafc8ccf24cc645ec01c1c0c2 100644
--- a/dumux/material/components/n2.hh
+++ b/dumux/material/components/n2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*/
#ifndef DUMUX_N2_HH
@@ -36,8 +34,7 @@ namespace Dumux
{
/*!
- * \ingroup Components
- *
+ * \ingroup Componentss
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -88,7 +85,7 @@ public:
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure molecular nitrogen
* at a given temperature.
*
- *\param T temperature of component in \f$\mathrm{[K]}\f$
+ * \param T temperature of component in \f$\mathrm{[K]}\f$
*
* Taken from:
*
diff --git a/dumux/material/components/nacl.hh b/dumux/material/components/nacl.hh
index 6f6acdfa468d45f7b3ccb96bc9285c4b6b259729..66d3c241632c3196b61eee883c88db60f4d3c424 100644
--- a/dumux/material/components/nacl.hh
+++ b/dumux/material/components/nacl.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Material properties of pure salt \f$NaCl\f$.
*/
#ifndef DUMUX_NACL_HH
@@ -36,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup Components
* \brief A class for the NaCl properties
*/
template <class Scalar>
@@ -60,6 +59,8 @@ public:
/*!
* \brief The diffusion Coefficient \f$\mathrm{[m^2/s]}\f$ of NaCl in water.
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/o2.hh b/dumux/material/components/o2.hh
index af9d3273da7ca629bc389aacc9382a91c49787bf..8d2d5955973b3fc108a51f825b54af99505a056b 100644
--- a/dumux/material/components/o2.hh
+++ b/dumux/material/components/o2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of pure molecular oxygen \f$O_2\f$.
*/
#ifndef DUMUX_O2_HH
@@ -37,7 +35,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Properties of pure molecular oxygen \f$O_2\f$.
*
* \tparam Scalar The type used for scalar values
@@ -173,6 +170,8 @@ public:
*
* This is equivalent to the partial derivative of the specific
* enthalpy to the temperature.
+ * \param T absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*
* See: R. Reid, et al. (1987, pp 154, 657, 665) \cite reid1987
*/
diff --git a/dumux/material/components/simpleco2.hh b/dumux/material/components/simpleco2.hh
index 083e81a281e316d55793b4c2d4adfbbf9a73058a..90c533a7e98e209bd0a734f4d170b800d3775442 100644
--- a/dumux/material/components/simpleco2.hh
+++ b/dumux/material/components/simpleco2.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief A simple class for the \f$CO_2\f$ fluid properties
*/
#ifndef DUMUX_SIMPLE_CO2_HH
@@ -36,7 +34,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A class for the \f$CO_2\f$ fluid properties
*
* \tparam Scalar The type used for scalar values
@@ -136,7 +133,7 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
- */
+ */
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
// Assume an ideal gas
@@ -164,7 +161,7 @@ public:
/*!
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of \f$CO_2\f$ at a given pressure and temperature.
*
- *\param temperature 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$
*
* See:
diff --git a/dumux/material/components/simpleh2o.hh b/dumux/material/components/simpleh2o.hh
index 6cbd4b28079c700ba2eb54c975f3aaeaf09f35d8..00851dccdaf7aaac1e4ec7f6e057fa827b2ff2b8 100644
--- a/dumux/material/components/simpleh2o.hh
+++ b/dumux/material/components/simpleh2o.hh
@@ -35,7 +35,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A much simpler (and thus potentially less buggy) version of
* pure water.
*
@@ -288,26 +287,32 @@ public:
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 281.15K (8°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidHeatCapacity(Scalar temperature, Scalar pressure)
{
return 4.2e3;
}
- /*!
+ /*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of water.
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 372.76K (99.6°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidThermalConductivity(Scalar temperature, Scalar pressure)
{
return 0.679;
}
- /*!
+ /*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of steam.
* source: http://webbook.nist.gov/cgi/fluid.cgi?ID=C7732185&Action=Page
* @ T= 372.76K (99.6°C) , p=0.1MPa)
+ * \param temperature absolute temperature in \f$\mathrm{[K]}\f$
+ * \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar gasThermalConductivity(Scalar temperature, Scalar pressure)
{
diff --git a/dumux/material/components/tabulatedcomponent.hh b/dumux/material/components/tabulatedcomponent.hh
index e8fea2d548bb00df383bdc87df2859559a0cfece..feeb2c47d976854c464fa21ca800120713be43e2 100644
--- a/dumux/material/components/tabulatedcomponent.hh
+++ b/dumux/material/components/tabulatedcomponent.hh
@@ -40,7 +40,6 @@ namespace Dumux
/*!
* \ingroup Components
- *
* \brief Tabulates all thermodynamic properties of a given
* untabulated chemical species.
*
diff --git a/dumux/material/components/unit.hh b/dumux/material/components/unit.hh
index 807653b60843b9dc0bbbffc70e6c85fc1ae2e2d4..ee7fa7484fdbc499eeb59b7e6f6321ee5895f3c9 100644
--- a/dumux/material/components/unit.hh
+++ b/dumux/material/components/unit.hh
@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup Components
- *
* \brief A component using a value of one for all fluid properties.
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/xylene.hh b/dumux/material/components/xylene.hh
index 4b2f245cf11b27b151d76da22b4302b221f23349..ce5a7a9af44deb60fd4bed64da317ecd666c4dae 100644
--- a/dumux/material/components/xylene.hh
+++ b/dumux/material/components/xylene.hh
@@ -18,9 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup Components
- *
* \brief Properties of xylene.
*/
#ifndef DUMUX_XYLENE_HH
@@ -36,7 +34,7 @@ namespace Dumux
{
/*!
* \ingroup Components
- * \brief xylene
+ * \brief Properties of xylene.
*
* \tparam Scalar The type used for scalar values
*/
@@ -98,7 +96,6 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
-
static Scalar vaporPressure(Scalar temperature)
{
const Scalar A = 7.00909;
@@ -254,7 +251,7 @@ public:
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
- */
+ */
static Scalar molarGasDensity(Scalar temperature, Scalar pressure)
{
return (gasDensity(temperature, pressure) / molarMass());
diff --git a/dumux/material/constants.hh b/dumux/material/constants.hh
index c28bebc1023bbaa0ca2cc593af12acfc8cee3545..a5510e2bbc46fc96a482d464d25ab69e778c8b6e 100644
--- a/dumux/material/constants.hh
+++ b/dumux/material/constants.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Material
* \brief A central place for various physical constants occuring in
* some equations.
*/
@@ -31,6 +31,7 @@ namespace Dumux
{
/*!
+ * \ingroup Material
* \brief A central place for various physical constants occuring in
* some equations.
*/
diff --git a/dumux/material/constraintsolvers/CMakeLists.txt b/dumux/material/constraintsolvers/CMakeLists.txt
index 43ee21f29aefb8c75a3f915af2f01e166d7428d4..e7d03978dc5c728598345b011390f2f0f7e1c35f 100644
--- a/dumux/material/constraintsolvers/CMakeLists.txt
+++ b/dumux/material/constraintsolvers/CMakeLists.txt
@@ -2,10 +2,7 @@
#install headers
install(FILES
compositionalflash.hh
-compositionfromfugacities2pncmin.hh
compositionfromfugacities.hh
-computefromreferencephase2pnc.hh
-computefromreferencephase2pncmin.hh
computefromreferencephase.hh
fluidsystemcomputefromreferencephase.hh
fluidsystemconstraintsolver.hh
diff --git a/dumux/material/constraintsolvers/compositionalflash.hh b/dumux/material/constraintsolvers/compositionalflash.hh
index 906bbb3c48a228bc2427f2fc522543a8144c0092..7fb27225a884938394e05b854e507f0dbaef8eb7 100644
--- a/dumux/material/constraintsolvers/compositionalflash.hh
+++ b/dumux/material/constraintsolvers/compositionalflash.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Determines the pressures and saturations of all fluid phases
* given the total mass of all components.
*/
@@ -60,8 +60,8 @@ public:
* \name Concentration flash for a given feed fraction
*/
//@{
- //! 2p2c Flash for constant p & t if concentrations (feed mass fraction) is given.
- /*!
+ /*! 2p2c Flash for constant p & t if concentrations (feed mass fraction) is given.
+ *
* Routine goes as follows:
* - determination of the equilibrium constants from the fluid system
* - determination of maximum solubilities (mole fractions) according to phase pressures
@@ -171,8 +171,8 @@ public:
fluidState.setSaturation(wPhaseIdx, sw);
}
- //! The simplest possible update routine for 1p2c "flash" calculations
- /*!
+ /*! The simplest possible update routine for 1p2c "flash" calculations
+ *
* Routine goes as follows:
* - Check if we are in single phase condition
* - Assign total concentration to the present phase
@@ -242,8 +242,8 @@ public:
* \name Saturation flash for a given saturation (e.g. at boundary)
*/
//@{
- //! a flash routine for 2p2c systems if the saturation instead of total concentration is known.
- /*!
+ /*! a flash routine for 2p2c systems if the saturation instead of total concentration is known.
+ *
* Routine goes as follows:
* - determination of the equilibrium constants from the fluid system
* - determination of maximum solubilities (mole fractions) according to phase pressures
diff --git a/dumux/material/constraintsolvers/compositionfromfugacities.hh b/dumux/material/constraintsolvers/compositionfromfugacities.hh
index 45ae297d5fbf2c7464b93272d645c0890cf29fa6..419ca4ab6592eeb65148c9f1573c9d7b32acd53d 100644
--- a/dumux/material/constraintsolvers/compositionfromfugacities.hh
+++ b/dumux/material/constraintsolvers/compositionfromfugacities.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Determines the fluid composition given the component
* fugacities and an arbitary equation of state.
*/
diff --git a/dumux/material/constraintsolvers/computefromreferencephase.hh b/dumux/material/constraintsolvers/computefromreferencephase.hh
index a75a01cef6ea3f98e4fd33be0e4ef146319a155d..80e04d45516f938921788267e17e0d384d72b6b0 100644
--- a/dumux/material/constraintsolvers/computefromreferencephase.hh
+++ b/dumux/material/constraintsolvers/computefromreferencephase.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Computes all quantities of a generic fluid state if a
* reference phase has been specified.
*
diff --git a/dumux/material/constraintsolvers/fluidsystemcomputefromreferencephase.hh b/dumux/material/constraintsolvers/fluidsystemcomputefromreferencephase.hh
index 1a945cda3b3e365af219ff714e580f99a74243ef..4a9fbe95e233987bbd3ef849fad6be41c4fd59f9 100644
--- a/dumux/material/constraintsolvers/fluidsystemcomputefromreferencephase.hh
+++ b/dumux/material/constraintsolvers/fluidsystemcomputefromreferencephase.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Computes the composition of all phases of a N-phase,
* N-component fluid system assuming that all N phases are
* present. The composition is actually retrieved from a
@@ -137,6 +137,7 @@ public:
checkDefinedMoleFractions(fluidState);
}
}
+
/*!
* \brief checks whether all the mole fractions which are stored in the fluidstate are founded on defined values.
*/
diff --git a/dumux/material/constraintsolvers/fluidsystemconstraintsolver.hh b/dumux/material/constraintsolvers/fluidsystemconstraintsolver.hh
index 1a5c912d424c87a1a8be867571c0ee4473f6111f..f69967655601e21d4f60184250dfcab126c7116e 100644
--- a/dumux/material/constraintsolvers/fluidsystemconstraintsolver.hh
+++ b/dumux/material/constraintsolvers/fluidsystemconstraintsolver.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Computes the composition of all phases of a N-phase,
* N-component fluid system assuming that all N phases are
* present. The composition is actually retrieved from a
@@ -34,7 +34,7 @@
#include <dumux/common/valgrind.hh>
namespace Dumux {
-/**
+/*!
* \ingroup ConstraintSolver
* \brief Computes the composition of all phases from a function in the fluidsystem.
*
@@ -63,7 +63,7 @@ class FluidSystemConstraintSolver
static constexpr int numPhases = FluidSystem::numPhases;
public:
- /**
+ /*!
* \brief @copybrief Dumux::FluidSystemConstraintSolver
*
* \param fluidState A container with the current (physical) state of the fluid
diff --git a/dumux/material/constraintsolvers/immiscibleflash.hh b/dumux/material/constraintsolvers/immiscibleflash.hh
index 031e2f17fcac88afee14ce4751f2b895ed2f8d20..3f2aa31884e14ebf44c228bad56a329c8b333072 100644
--- a/dumux/material/constraintsolvers/immiscibleflash.hh
+++ b/dumux/material/constraintsolvers/immiscibleflash.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Determines the pressures and saturations of all fluid phases
* given the total mass of all components.
*/
diff --git a/dumux/material/constraintsolvers/miscible2pnccomposition.hh b/dumux/material/constraintsolvers/miscible2pnccomposition.hh
index 167a47b8fdcb131612a30f28764d9d888028be20..bc94243895cc1a5a6aa2ab9bf682817febd40e5a 100644
--- a/dumux/material/constraintsolvers/miscible2pnccomposition.hh
+++ b/dumux/material/constraintsolvers/miscible2pnccomposition.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Computes the composition of all phases of a N-phase,
* N-component fluid system assuming that all N phases are
* present
diff --git a/dumux/material/constraintsolvers/misciblemultiphasecomposition.hh b/dumux/material/constraintsolvers/misciblemultiphasecomposition.hh
index 28bd6ca3fadd9f1d75629607e94de752e0f9e045..14715b645cf25010b560489571d5adf2758929ef 100644
--- a/dumux/material/constraintsolvers/misciblemultiphasecomposition.hh
+++ b/dumux/material/constraintsolvers/misciblemultiphasecomposition.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Computes the composition of all phases of a N-phase,
* N-component fluid system assuming that all N phases are
* present
diff --git a/dumux/material/constraintsolvers/ncpflash.hh b/dumux/material/constraintsolvers/ncpflash.hh
index 8c7c549017f4375e0847a3c960f799ccb7818282..4ffcc557484e360102fcf52c51c5f957fe0fcf4d 100644
--- a/dumux/material/constraintsolvers/ncpflash.hh
+++ b/dumux/material/constraintsolvers/ncpflash.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ConstraintSolver
* \brief Determines the phase compositions, pressures and saturations
* given the total mass of all components.
*/
@@ -95,7 +95,6 @@ public:
* \param fluidState Thermodynamic state of the fluids
* \param paramCache Container for cache parameters
* \param globalMolarities
- *
*/
template <class FluidState>
static void guessInitial(FluidState &fluidState,
diff --git a/dumux/material/eos/pengrobinson.hh b/dumux/material/eos/pengrobinson.hh
index 1fdee070253498a9af9f74f27ec93e2ebad992ff..a61c178f499190f3500618ce3bcc711364031da3 100644
--- a/dumux/material/eos/pengrobinson.hh
+++ b/dumux/material/eos/pengrobinson.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup EOS
* \brief Implements the Peng-Robinson equation of state for liquids
* and gases.
*
diff --git a/dumux/material/eos/pengrobinsonmixture.hh b/dumux/material/eos/pengrobinsonmixture.hh
index bdb259ab5b82d7e929340b534c3fcf82aa7bd802..e4a6d144fbd59969979487d0bbb1165c0efb785b 100644
--- a/dumux/material/eos/pengrobinsonmixture.hh
+++ b/dumux/material/eos/pengrobinsonmixture.hh
@@ -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 ¶ms,
diff --git a/dumux/material/eos/pengrobinsonparams.hh b/dumux/material/eos/pengrobinsonparams.hh
index 4b582cf9d6b33b29deeb22d9f1c430e5df7b01a8..20818d159ca0c09b518890737c08c84304b06793 100644
--- a/dumux/material/eos/pengrobinsonparams.hh
+++ b/dumux/material/eos/pengrobinsonparams.hh
@@ -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; }
diff --git a/dumux/material/eos/pengrobinsonparamsmixture.hh b/dumux/material/eos/pengrobinsonparamsmixture.hh
index 8450986995f938994ceaed58cc78145cb349da4b..7e346a4b5707d2d496ddd35d32c0243e268066f5 100644
--- a/dumux/material/eos/pengrobinsonparamsmixture.hh
+++ b/dumux/material/eos/pengrobinsonparamsmixture.hh
@@ -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
{
diff --git a/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh b/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
index c8b7a3bc8f7e3b81af29ae774845c48d4becd927..13434980af2834acb2174d6b1809018a9016a1c3 100644
--- a/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
+++ b/dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief simple effective thermal conductivity
+ * \ingroup fluidmatrixinteractionslaws
+ * \brief Reation for a simple effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_AVERAGE_HH
#define THERMALCONDUCTIVITY_AVERAGE_HH
@@ -31,7 +31,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for a simple effective thermal conductivity
*/
template<class Scalar>
@@ -39,7 +38,7 @@ class ThermalConductivityAverage
{
public:
/*!
- * \brief simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
+ * \brief Relation for a simple effective thermal conductivity \f$\mathrm{[W/(m K)]}\f$
*
* \param volVars volume variables
* \param spatialParams spatial parameters
diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
index fe3affa33e3d1eebed3e9eb83ba9e5b0cdbc4a4c..021b6afe94a46688eae215f4cf617b2625662973 100644
--- a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to Brooks and Corey.
*
@@ -58,10 +58,9 @@ public:
* The Brooks-Corey empirical capillary pressure <-> saturation
* function is given by
*
- * \f$\mathrm{
- p_C = p_e\overline{S}_w^{-1/\lambda}
- * }\f$
- *
+ * \f$\mathrm{ p_C = p_e\overline{S}_w^{-1/\lambda}
+ * }\f$
+ *
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
@@ -86,8 +85,7 @@ public:
* \brief The saturation-capillary pressure curve according to Brooks & Corey.
*
* This is the inverse of the capillary pressure-saturation curve:
- * \f$\mathrm{
- \overline{S}_w = (\frac{p_C}{p_e})^{-\lambda}}\f$
+ * \f$\mathrm{ \overline{S}_w = (\frac{p_C}{p_e})^{-\lambda}}\f$
*
* \param pc Capillary pressure \f$\mathrm{[p_C]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -123,10 +121,9 @@ public:
* pressure w.r.t. the effective saturation according to Brooks & Corey.
*
* This is equivalent to
- * \f$\mathrm{
- \frac{\partial p_C}{\partial \overline{S}_w} =
- -\frac{p_e}{\lambda} \overline{S}_w^{-1/\lambda - 1}
- }\f$
+ * \f$\mathrm{\frac{\partial p_C}{\partial \overline{S}_w} =
+ * -\frac{p_e}{\lambda} \overline{S}_w^{-1/\lambda - 1}
+ * }\f$
*
* \param swe Effective saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -136,7 +133,7 @@ public:
*
* \note Instead of undefined behaviour if pc is not in the valid range, we return a valid number,
* by clamping the input.
- */
+ */
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
using std::pow;
diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh b/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
index 700157c8bd3481772e28b5ae92a89883333781ac..820eabaa8e3fe104a577e992f0c3a6e73500c1e0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/brookscoreyparams.hh
@@ -19,7 +19,7 @@
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*/
@@ -35,7 +35,7 @@ namespace Dumux
* \brief Specification of the material parameters
* for the Brooks Corey constitutive relations.
*
- * \ingroup fluidmatrixinteractionsparams
+ * \ingroup fluidmatrixinteractionsparams
*
*\see BrooksCorey
*/
diff --git a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
index 2bae19e8722b3cf8a4f0eba3c6964659fd85dbb0..47b646f5f6d327a96a39bcd6cd7f987718558949 100644
--- a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
@@ -18,11 +18,10 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations.
- *
*/
#ifndef DUMUX_EFF_TO_ABS_LAW_HH
#define DUMUX_EFF_TO_ABS_LAW_HH
@@ -68,8 +67,6 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
- *
- *
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -77,7 +74,6 @@ public:
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Capillary pressure calculated by specific constitutive relation
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...)
- *
*/
static Scalar pc(const Params ¶ms, Scalar sw)
{
@@ -91,17 +87,15 @@ public:
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
- *\return Absolute wetting phase saturation calculated as inverse of
+ * \return Absolute wetting phase saturation \f$\mathrm{[S_w]}\f$ calculated as inverse of
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...) constitutive relation.
- *
- * \return The absolute saturation of the wetting phase \f$\mathrm{[S_w]}\f$
*/
static Scalar sw(const Params ¶ms, Scalar pc)
{
return sweToSw_(params, EffLaw::sw(params, pc));
}
- /*!
+ /*!
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -126,7 +120,7 @@ public:
and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
- */
+ */
static Scalar dpc_dsw(const Params ¶ms, Scalar sw)
{
return EffLaw::dpc_dswe(params, swToSwe(params, sw) )*dswe_dsw_(params);
@@ -165,7 +159,6 @@ public:
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Relative permeability of the wetting phase calculated as implied by
* EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
- *
*/
static Scalar krw(const Params ¶ms, Scalar sw)
{
diff --git a/dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh b/dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh
index 24fc8cfa9da65f3430ec885c9baa1bad2f359c68..0ce628d7e8e2fe29b35ec6d5e70db2f1acb6fb39 100644
--- a/dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/efftoabslawparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
- *
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
diff --git a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
index 4353159c880b9ed655b5ec08fc0e9e22d315e538..95ccb1b9c876f9d7ebe43de55e6e18d8569e15b8 100644
--- a/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/heatpipelaw.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure <-> saturation relation
* for the heatpipe problem.
*/
@@ -37,8 +37,7 @@
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure <-> saturation
* relation for the heatpipe problem.
*
diff --git a/dumux/material/fluidmatrixinteractions/2p/heatpipelawparams.hh b/dumux/material/fluidmatrixinteractions/2p/heatpipelawparams.hh
index 4431dfb208575438a3acb08c91a42c2a04f1c272..77a26c09c06113824c526cbdd3dd0dcba5b9117d 100644
--- a/dumux/material/fluidmatrixinteractions/2p/heatpipelawparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/heatpipelawparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslparams
* \brief Specification of the material params for the heat pipe's capillary
* pressure model.
*/
@@ -28,6 +28,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of a params for the heat pipe's
* material law
*/
diff --git a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
index 6b4182bad6f813d42240d586e0e6b68f935e7a6c..fa76e33ed28339253807a1c6dccc5ccdf1cc4227 100644
--- a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*/
@@ -33,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Linear capillary pressure and
* relative permeability <-> saturation relations
*
@@ -113,7 +112,7 @@ public:
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to linear material relation.
- */
+ */
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
return - (params.maxPc() - params.entryPc());
diff --git a/dumux/material/fluidmatrixinteractions/2p/linearmaterialparams.hh b/dumux/material/fluidmatrixinteractions/2p/linearmaterialparams.hh
index 2017eec814f0c6834cc3c367df9a851b5215324f..ca7f7cbc0257c515f356fa046766787da957be41 100644
--- a/dumux/material/fluidmatrixinteractions/2p/linearmaterialparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/linearmaterialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters for the linear capillary pressure and
* relative permeability <-> saturation relations
*/
@@ -30,8 +30,7 @@ namespace Dumux
/*!
* \brief Reference implementation of params for the linear material
* law.
- *
- * \ingroup fluidmatrixinteractionsparams
+ * \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class LinearMaterialParams
diff --git a/dumux/material/fluidmatrixinteractions/2p/philtophoblaw.hh b/dumux/material/fluidmatrixinteractions/2p/philtophoblaw.hh
index 95646de0566560d9c8f861b14d12ca0a2e794939..ee43e08431183eb9c853a9e9d9b22b4dfb5ad750 100644
--- a/dumux/material/fluidmatrixinteractions/2p/philtophoblaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/philtophoblaw.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations. It is valid for hydrophobic materials and is
@@ -37,7 +37,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
* saturations.
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
index 14ec92423b32e32c2367ad116a91ac05a1ec3ff9..0057afd955f5c26ebfec76c28bc5cba7cc8b1b02 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscorey.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of a regularized version of the Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
*/
@@ -34,8 +34,8 @@
namespace Dumux
{
-/*!\ingroup fluidmatrixinteractionslaws
- *
+/*!
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized Brooks-Corey
* capillary pressure / relative permeability <-> saturation relation.
* This class bundles the "raw" curves as
@@ -276,7 +276,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
- \copydetails BrooksCorey::krn()
+ * \copydetails BrooksCorey::krn()
*
*/
static Scalar krn(const Params ¶ms, Scalar swe)
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
index 25303244715269818d7d22fb8654864cef08cb3a..01f2584479c34896b2af9de3454d864d2f2163d7 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
*/
@@ -32,8 +32,7 @@ namespace Dumux
/*!
* \brief Parameters that are necessary for the \em regularization of
* the Brooks-Corey capillary pressure model.
- *
- * \ingroup fluidmatrixinteractionsparams
+ * \ingroup fluidmatrixinteractionsparams
*/
template <class ScalarT>
class RegularizedBrooksCoreyParams : public BrooksCoreyParams<ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
index 00b32d7686508e83a22597af439d30e4d8424a99..d23b6ece9a1d26371ac082e74a5898a437aae5a6 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Regularized linear capillary pressure and
* relative permeability <-> saturation relations.
*/
@@ -36,7 +36,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Implements a linear saturation-capillary pressure relation
*
* The entry pressure is reached at \f$\mathrm{\overline{S}_w = 1}\f$, the maximum
@@ -102,7 +101,7 @@ public:
return LinearMaterial::sw(params, pc);
}
- /*!
+ /*!
* \brief The capillary pressure at Swe = 1.0 also called end point capillary pressure
*
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -125,7 +124,7 @@ public:
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen, and then the params container
* is constructed accordingly. Afterwards the values are set there, too.
- */
+ */
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
return LinearMaterial::dpc_dswe(params, swe);
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterialparams.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterialparams.hh
index d63e80eb01ed28a1e03b9e5cbd021a8f391f14d1..85b1b4a78e8c74f06ae4dc2427bd9f2de0a37ed6 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterialparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
*/
@@ -30,11 +30,9 @@
namespace Dumux
{
/*!
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the linear constitutive relations.
- *
- * \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class RegularizedLinearMaterialParams : public LinearMaterialParams<ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
index dbb07a8a41a853d48b4ae2d93b28eda426bc7e88..c197b7d856e4f13dbb2739de4c799fda6439551d 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized version of the van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*/
@@ -35,9 +35,8 @@
namespace Dumux
{
-/*!\ingroup fluidmatrixinteractionslaws
-
-
+/*!
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized van Genuchten's
* capillary pressure / relative permeability <-> saturation relation.
*
@@ -88,7 +87,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::pc()
+ * \copydetails VanGenuchten::pc()
*/
static Scalar pc(const Params ¶ms, Scalar swe)
{
@@ -141,7 +140,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::sw()
+ * \copydetails VanGenuchten::sw()
*
*/
static Scalar sw(const Params ¶ms, Scalar pc)
@@ -215,8 +214,7 @@ public:
*
* For not-regularized part:
*
- \copydetails VanGenuchten::dpc_dswe()
- *
+ * \copydetails VanGenuchten::dpc_dswe()
*/
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
@@ -263,7 +261,7 @@ public:
* by a straight line and use that slope (yes, there is a kink :-( ).
*
* For not-regularized part:
- \copydetails VanGenuchten::dswe_dpc()
+ * \copydetails VanGenuchten::dswe_dpc()
*/
static Scalar dswe_dpc(const Params ¶ms, Scalar pc)
{
@@ -302,7 +300,7 @@ public:
* - between \f$\mathrm{0.95 \leq \overline{S}_w \leq 1}\f$: use a spline as interpolation
*
* For not-regularized part:
- \copydetails VanGenuchten::krw()
+ * \copydetails VanGenuchten::krw()
*/
static Scalar krw(const Params ¶ms, Scalar swe)
{
@@ -331,7 +329,7 @@ public:
* permeability for the wetting phase in regard to the wetting
* saturation of the medium implied by the van Genuchten parameterization.
*
- \copydetails VanGenuchten::dkrw_dswe()
+ * \copydetails VanGenuchten::dkrw_dswe()
*/
static Scalar dkrw_dswe(const Params ¶ms, Scalar swe)
{
@@ -371,7 +369,7 @@ public:
* - above \f$\mathrm{\overline{S}_w =1}\f$: set relative permeability to one
* - for \f$\mathrm{0 \leq \overline{S}_w \leq 0.05}\f$: use a spline as interpolation
*
- \copydetails VanGenuchten::krn()
+ * \copydetails VanGenuchten::krn()
*
*/
static Scalar krn(const Params ¶ms, Scalar swe)
@@ -401,7 +399,7 @@ public:
* for the non-wetting phase in regard to the wetting saturation of
* the medium as implied by the van Genuchten parameterization.
*
- \copydetails VanGenuchten::dkrw_dswe()
+ * \copydetails VanGenuchten::dkrw_dswe()
*/
static Scalar dkrn_dswe(const Params ¶ms, Scalar swe)
{
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
index 69e538e3017b4462739f298f900798b2cd4566ac..e60c1d9c753c1d59d5cba04500bd8623471e835c 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
*/
@@ -31,12 +31,9 @@
namespace Dumux
{
/*!
- *
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* VanGenuchten "material law".
- *
- * \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class RegularizedVanGenuchtenParams : public VanGenuchtenParams<ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
index e933960fbdf6469e756df9eb0654f716662efe4e..16b92a29f6baafaf908ef211c5305106a28a33e7 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_JOHANSEN_HH
@@ -37,7 +37,6 @@ struct JohansenIndices
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Johansen method (Johansen 1975 \cite johansen1977 ) computes the thermal conductivity of dry and the
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
index 87b0df4f099a6739ff8cf87a328f0ad1fd9503c5..5b31aeab4097ec6f542e86deb846339e817d8ec0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SIMPLE_FLUID_LUMPING_HH
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
index 7a1f4c249c81ee6e78afb99570129563687ec007..994df555bb091e43fa8b8a4a8534484a765a24ed 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SOMERTON_HH
@@ -38,7 +38,6 @@ struct SomertonIndices
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Somerton method computes the thermal conductivity of dry and the wet soil material
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
index 78abc5ccb89276c3496905d26c7d9a5f5a409ff8..1519e7a95aad4e788bd95e4f63dbd19d7c0994b7 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the capillary pressure and
* relative permeability <-> saturation relations according to van Genuchten.
*/
@@ -35,7 +35,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Implementation of the van Genuchten capillary pressure <->
* saturation relation. This class bundles the "raw" curves
* as static members and doesn't concern itself converting
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchtenoftemperature.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchtenoftemperature.hh
index 247416e14d8cb45f324c9c5732d6240bfba56ce9..8737f64c204b10d8540c9fc9d5685c372724cd0a 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchtenoftemperature.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchtenoftemperature.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized version of the van Genuchten's
* capillary pressure / relative permeability <-> saturation relation
* *as function of temperature*.
@@ -31,8 +31,8 @@
namespace Dumux
{
-/*!\ingroup fluidmatrixinteractionslaws
- *
+/*!
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the regularized van Genuchten's
* capillary pressure / relative permeability <-> saturation relation
* *as a function of temperature*.
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchtenparams.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchtenparams.hh
index 8622feafc3eb53abee5d06f93c51abfec663931b..82755d9eadcb50b9b120b565011703a72f4cce9c 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchtenparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchtenparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the material parameters
* for the van Genuchten constitutive relations.
*/
@@ -28,14 +28,12 @@
namespace Dumux
{
/*!
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the material parameters
* for the van Genuchten constitutive relations.
*
* In this implementation setting either the \f$\mathrm{n}\f$ or \f$\mathrm{m}\f$ shape parameter
* automatically calculates the other. I.e. they cannot be set independently.
- *
- * \ingroup fluidmatrixinteractionsparams
*/
template<class ScalarT>
class VanGenuchtenParams
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfct.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfct.hh
index 152a68bdccd94a45af7120c739ad2bd8c6516313..0658e36d3c597d684421eaa430933b4a7983966b 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfct.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfct.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
@@ -27,17 +27,14 @@
#include <dune/common/exceptions.hh>
-
#include <algorithm>
-
#include <cmath>
#include <assert.h>
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the exponential function relating
* specific interfacial area to wetting phase saturation and capillary pressure as suggested by Nuske(2009) (Diploma thesis) \cite nuske2009 .
*/
@@ -108,5 +105,3 @@ public:
} // namespace Dumux
#endif
-
-
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfctparams.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfctparams.hh
index 6416f1fe9d8148b7e66ba96d690de3236b7098d7..9d433e15dafcfdd2aa8c6b45e45ad04c46848daa 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfctparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpfctparams.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
@@ -26,6 +26,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3.hh
index 33db148e96df79cbff7e7767e47b2c0e564f0017..dbe41c63ec65fd49b9d145ee928ae078fcce6b3a 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is of third order in pc.
*/
@@ -27,9 +27,7 @@
#include <dune/common/exceptions.hh>
-
#include <algorithm>
-
#include <cmath>
#include <assert.h>
@@ -37,9 +35,9 @@ namespace Dumux
{
/*!
* \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of a exponential function relating
- * specific interfacial area to wetting phase saturation and capillary pressure.
+ * specific interfacial area to wetting phase saturation and capillary pressure.
*/
template <class ScalarT, class ParamsT =AwnSurfaceExpSwPcTo3Params<ScalarT> >
class AwnSurfaceExpSwPcTo3
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3params.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3params.hh
index 948d336cbbc4112f905fab684c8ed29f1e8f3f04..3caeb636bcac6640a91703c0d19945c966615b2e 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3params.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfaceexpswpcto3params.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This is of third order in pc.
*/
@@ -26,6 +26,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfct.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfct.hh
index 880e513a1185a610c40a6cf81937df41c80f4ef8..cc30ce7f5fea037cdd8b164ff4b8e99171d67d8d 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfct.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfct.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
@@ -26,13 +26,10 @@
#include "awnsurfacepcmaxfctparams.hh"
#include <dune/common/exceptions.hh>
-
-
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of an interfacial area surface.
*
* The idea here is to make sure that interfacial area be zero for Sw=1 and pc=pcmax.
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfctparams.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfctparams.hh
index 3b23dfc7b0b50fbbf3ed406a34ee2acab727a642..0d2dd03dbbde5bcb54ce5621b32ded7658d5432a 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfctparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepcmaxfctparams.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
@@ -26,6 +26,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
@@ -37,7 +38,7 @@ public:
AwnSurfacePcMaxFctParams()
{}
- /*!
+ /*!
* \brief Return the \f$\mathrm{a_{1}}\f$ shape parameter of awn surface.
*/
const Scalar a1() const
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorder.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorder.hh
index 091bde0df35795c55bcb58ff9dcb0edeba87be65..13e49c2b93861afd342026a8e4ea7cf8f7243328 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorder.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorder.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
@@ -28,19 +28,16 @@
#include <dune/common/exceptions.hh>
-
#include <algorithm>
-
#include <cmath>
#include <assert.h>
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the polynomial of second order relating
- * specific interfacial area to wetting phase saturation and capillary pressure as suggested by Joekar-Niasar(2008) \cite joekar2008 .
+ * specific interfacial area to wetting phase saturation and capillary pressure as suggested by Joekar-Niasar(2008) \cite joekar2008 .
*/
template <class ScalarT, class ParamsT = AwnSurfacePolynomial2ndOrderParams<ScalarT> >
class AwnSurfacePolynomial2ndOrder
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorderparams.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorderparams.hh
index a38ba9394e71b201d19d276d1f883d5240afb926..71e722db9c8db5fdcd5d9e64ca01ce47a7e92bc3 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorderparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomial2ndorderparams.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
@@ -26,6 +26,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief implementation of interfacial area surface params
*/
template<class ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorder.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorder.hh
index 6ba288dd5836a8ae4e7c9061e4d521fbe223ad98..bc84b81fef204451cf89a8848a16bc0696ae79cb 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorder.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorder.hh
@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
@@ -28,18 +28,15 @@
#include <dune/common/exceptions.hh>
#include <algorithm>
-
#include <math.h>
#include <assert.h>
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of the polynomial of second order relating
* specific interfacial area to wetting phase saturation and capillary pressure.
- *
*/
template <class ParamsT>
class AwnSurfacePolynomialEdgeZero2ndOrder
@@ -50,7 +47,6 @@ public:
/*!
* \brief The awn surface
- *
* the suggested (as estimated from pore network models) awn surface:
* \f$[
a_{wn} = a_{1} (S_{wr}-S_{w})(1.-S_{w}) + a_2 (S_{wr}-S_{w})(1.-S_{w}) p_{c} + a_{3} (S_{wr}-S_{w})(1.-S_{w}) p_{c}^2
diff --git a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorderparams.hh b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorderparams.hh
index 387e63c17694349705ccdeca83e3283e0c184f2d..7d12fb75f29b13e191181c1b3ae983949f184918 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorderparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/awnsurfacepolynomialedgezero2ndorderparams.hh
@@ -16,23 +16,18 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
#define AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
-/*!
- * \file
- * Specification of the material params for the interfacial area surface
- * parameters
- */
-
namespace Dumux
{
/*!
- * \brief implementation of interfacial area surface params
+ * \ingroup fluidmatrixinteractionsparams
+ * \brief Implementation of interfacial area surface params
*/
template<class ScalarT>
class AwnSurfacePolynomialEdgeZero2ndOrderParams
diff --git a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
index e813359daf8e73867e5a304500879a7ed3247f6f..dc88f2a0279eeed1dbdefc4bfa54de53de1beebb 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawia.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief This material law takes a material law (interfacial area surface)
* defined for effective saturations and converts it to a material law defined on
* absolute saturations.
@@ -34,7 +34,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief This material law takes a material law (interfacial area surface) defined for effective
* saturations and converts it to a material (interfacial area surface) law defined on absolute
* saturations.
diff --git a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawiaparams.hh b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawiaparams.hh
index 1fe5bd3e6f7c1e0ce642a45ec0e39e6859e215c4..68cb0c51bc170183bad194eecc611bb8797a7baa 100644
--- a/dumux/material/fluidmatrixinteractions/2pia/efftoabslawiaparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2pia/efftoabslawiaparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief A default implementation of the parameters for the adapter
* class to convert material laws -- in this case the interfacial area surfaces --
* from effective to absolute saturations.
@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
- *
* \brief A default implementation of the parameters for the adapter
* class to convert material laws -- in this case the interfacial area surfaces --
* from effective to absolute saturations.
diff --git a/dumux/material/fluidmatrixinteractions/3p/CMakeLists.txt b/dumux/material/fluidmatrixinteractions/3p/CMakeLists.txt
index 47bd8a52544881531d074cab13e7876e6cd26ba6..7d5371e22aeed3a5b1016e5d17e205fa381e4724 100644
--- a/dumux/material/fluidmatrixinteractions/3p/CMakeLists.txt
+++ b/dumux/material/fluidmatrixinteractions/3p/CMakeLists.txt
@@ -1,7 +1,11 @@
#install headers
install(FILES
+efftoabslaw.hh
+efftoabslawparams.hh
parkervangen3p.hh
parkervangen3pparams.hh
+regularizedparkervangen3p.hh
+regularizedparkervangen3pparams.hh
thermalconductivitysomerton3p.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/fluidmatrixinteractions/3p)
diff --git a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
index 00f454e5eafaf1448c0f9d056b914b2e309dac1c..536255fb255be478269245d13181128d6860882f 100644
--- a/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/efftoabslaw.hh
@@ -18,11 +18,10 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on
* absolute saturations.
- *
*/
#ifndef DUMUX_EFF_TO_ABS_LAW_HH
#define DUMUX_EFF_TO_ABS_LAW_HH
@@ -34,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief This material law takes a material law defined for effective
* saturations and converts it to a material law defined on absolute
* saturations.
@@ -69,8 +67,6 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
- *
- *
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[\overline{S}_w]}\f$. It is converted to effective saturation
* and then handed over to the material law actually used for calculation.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
@@ -78,26 +74,24 @@ public:
* and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Capillary pressure calculated by specific constitutive relation
* (EffLaw e.g. Brooks & Corey, van Genuchten, linear...)
- *
*/
static Scalar pc(const Params ¶ms, const Scalar sw)
{
return EffLaw::pc(params, swToSwe(params, sw));
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the gas and wetting phase
* \param params Array of parameters
* \param sw wetting phase saturation or sum of wetting phase saturations
- *
*/
static Scalar pcgw(const Params ¶ms, const Scalar sw)
{
return EffLaw::pcgw(params, swToSwe(params, sw));
}
- /*!
- * \brief The capillary pressure-saturation curve the non-wettigng and wetting phase
+ /*!
+ * \brief The capillary pressure-saturation curve the non-wetting and wetting phase
* \param params Array of parameters
* \param sw wetting phase saturation or sum of wetting phase saturations
*/
@@ -106,7 +100,7 @@ public:
return EffLaw::pcnw(params, swToSwe(params, sw));
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the gas and non-wetting phase
* \param params Array of parameters
* \param st sum of wetting (liquid) phase saturations
@@ -116,8 +110,8 @@ public:
return EffLaw::pcgn(params, stToSte(params, st));
}
- /*!
- * \brief This function ensures a continous transition from 2 to 3 phases and vice versa
+ /*!
+ * \brief This function ensures a continuous transition from 2 to 3 phases and vice versa
* \param params Array of parameters
* \param sn Non-wetting liquid saturation
*/
@@ -128,7 +122,6 @@ public:
/*!
* \brief The saturation-capillary pressure curve.
- *
* \param pc Capillary pressure \f$\mathrm{[p_c]}\f$ in \f$\mathrm{[Pa]}\f$.
* \param params A container object that is populated with the appropriate coefficients for the respective law.
* Therefore, in the (problem specific) spatialParameters first, the material law is chosen,
@@ -146,7 +139,6 @@ public:
/*!
* \brief Returns the partial derivative of the capillary
* pressure w.r.t the absolute saturation.
- *
* In this case the chain rule needs to be applied:
\f$\mathrm{
p_c = p_c( \overline{S}_w (S_w))
@@ -158,7 +150,7 @@ public:
and then the params container is constructed accordingly. Afterwards the values are set there, too.
* \return Partial derivative of \f$\mathrm{[p_c]}\f$ w.r.t. effective saturation according to
EffLaw e.g. Brooks & Corey, van Genuchten, linear... .
- */
+ */
static Scalar dpc_dsw(const Params ¶ms, const Scalar sw)
{
return EffLaw::dpc_dswe(params, pc);
@@ -167,7 +159,6 @@ public:
/*!
* \brief Returns the partial derivative of the absolute
* saturation w.r.t. the capillary pressure.
- *
* In this case the chain rule needs to be applied:
\f$\mathrm{
S_w = S_w(\overline{S}_w (p_c) )
@@ -225,7 +216,7 @@ public:
return EffLaw::krn(params, swToSwe(params, sw), sn, stToSte(params, st));
}
- /*!
+ /*!
* \brief The relative permeability for the gas phase.
*
* \param sw Absolute saturation of the wetting phase \f$\mathrm{[{S}_w]}\f$. It is converted to effective saturation
@@ -244,7 +235,7 @@ public:
return EffLaw::krg(params, stToSte(params, st));
}
- /*!
+ /*!
* \brief The relative permeability for a phase.
* \param sw Wetting liquid saturation
* \param sg Gas saturation
@@ -258,7 +249,7 @@ public:
return EffLaw::kr(params, phaseIdx, swToSwe(params, sw), sn, stToSte(params, st));
}
- /*!
+ /*!
* \brief the basis for calculating adsorbed NAPL in storage term
* \param params Array of parameters
*/
@@ -309,7 +300,7 @@ public:
return (st-params.swr()) / (1-params.swr());
}
- /*!
+ /*!
* \brief Convert an absolute gas saturation to an effective one.
*
* \param sg Absolute saturation of the gas phase \f$\mathrm{[{S}_n]}\f$.
diff --git a/dumux/material/fluidmatrixinteractions/3p/efftoabslawparams.hh b/dumux/material/fluidmatrixinteractions/3p/efftoabslawparams.hh
index 667d725911789c6d65bc24ea4660ab9a6ebb951a..18f047f62fd3c4c9aace3f914371ae0d970a2c19 100644
--- a/dumux/material/fluidmatrixinteractions/3p/efftoabslawparams.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/efftoabslawparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionsparams
- *
* \brief A default implementation of the parameters for the adapter
* class to convert material laws from effective to absolute
* saturations.
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
index c457074f6934bf2fc33bd80bfee8662f98032a21..222f17d8e28ae6273a0476dbe116618d24a6105b 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
@@ -18,9 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of van Genuchten's capillary pressure-saturation relation for three phases.
- *
*/
#ifndef PARKERVANGEN_3P_HH
#define PARKERVANGEN_3P_HH
@@ -32,8 +31,7 @@
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of van Genuchten's capillary pressure <->
* saturation relation. This class bundles the "raw" curves
* as static members and doesn't concern itself converting
@@ -53,13 +51,12 @@ public:
* \brief The capillary pressure-saturation curve.
* \param params Array of parameters
* \param sw wetting phase saturation
- *
*/
static Scalar pc(const Params ¶ms, const Scalar sw)
{
DUNE_THROW(Dune::NotImplemented, "Capillary pressures for three phases is not so simple! Use pcgn, pcnw, and pcgw");
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the gas and wetting phase
* \param params Array of parameters
* \param swe Effective wetting phase saturation
@@ -71,7 +68,7 @@ public:
return pc_(params, swe);
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the non-wettigng and wetting phase
* \param params Array of parameters
* \param swe Effective wetting phase saturation
@@ -93,8 +90,8 @@ public:
return pc_(params,ste)/params.betaGn();
}
- /*!
- * \brief This function ensures a continous transition from 2 to 3 phases and vice versa
+ /*!
+ * \brief This function ensures a continuous transition from 2 to 3 phases and vice versa
* \param params Array of parameters
* \param sne Non-wetting liquid saturation
*/
@@ -134,18 +131,18 @@ public:
* pressure to the effective saturation.
* \param params Array of parameters
* \param swe Effective wetting liquid saturation
- */
+ */
static Scalar dpc_dswe(const Params ¶ms, const Scalar swe)
{
DUNE_THROW(Dune::NotImplemented, "dpc/dswe for three phases not implemented! Do it yourself!");
}
- /*!
+ /*!
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \param params Array of parameters
* \param seRegu Effective wetting phase saturation for regularization
- */
+ */
static Scalar dpcgw_dswe(const Params ¶ms, const Scalar seRegu)
{
using std::pow;
@@ -154,12 +151,12 @@ public:
* powSeRegu/seRegu/params.vgm()/params.betaGw();
}
- /*!
+ /*!
* \brief Returns the partial derivative of the capillary
* pressure to the effective saturation.
* \param params Array of parameters
* \param seRegu Effective wetting phase saturation for regularization
- */
+ */
static Scalar dpcnw_dswe(const Params ¶ms, const Scalar seRegu)
{
using std::pow;
@@ -173,7 +170,7 @@ public:
* pressure to the effective saturation.
* \param params Array of parameters
* \param seRegu Effective wetting phase saturation for regularization
- */
+ */
static Scalar dpcgn_dste(const Params ¶ms, const Scalar seRegu)
{
using std::pow;
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
index 9d6f7dfcb10ea46258aada6a218a90f540d4f774..dc07308536f875cbb1407554e9acfb9170d82bc8 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3pparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Specification of the material params for the van Genuchten
* capillary pressure model.
*
@@ -34,6 +34,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of a van Genuchten params
*/
template<class ScalarT>
@@ -166,7 +167,7 @@ public:
void setSnr(Scalar input)
{ snr_ = input; }
- /*!
+ /*!
* \brief Return the residual gas saturation.
*/
Scalar sgr() const
@@ -174,7 +175,7 @@ public:
return sgr_;
}
- /*!
+ /*!
* \brief Set the residual gas saturation.
* \param input Set the resiudal gas saturation
*/
@@ -183,7 +184,7 @@ public:
sgr_ = input;
}
- /*!
+ /*!
* \brief Set the residual total liquid saturation.
*/
Scalar swrx() const
@@ -192,7 +193,7 @@ public:
return swr_;
}
- /*!
+ /*!
* \brief Set the residual total liquid saturation.
* \param v Set the resiudal gas saturation
*/
diff --git a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
index a1eecb2246eb0ea8f1d19997eaf663d5ba39825b..8eadaff905ae3dd662641b0281cf1167c27714b3 100644
--- a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implementation of a regularized version of van Genuchten's capillary
* pressure-saturation relation for three phases.
*/
@@ -84,7 +84,7 @@ public:
return ParkerVanGen3P::pc(params, sw);
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the gas and wetting phase
* \param params Array of parameters
* \param swe Effective wetting phase saturation
@@ -140,7 +140,7 @@ public:
return ParkerVanGen3P::pcgw(params, swe);
}
- /*!
+ /*!
* \brief The capillary pressure-saturation curve for the non-wettigng and wetting phase
* \param params Array of parameters
* \param swe Effective wetting phase saturation
@@ -250,7 +250,7 @@ public:
}
/*!
- * \brief This function ensures a continous transition from 2 to 3 phases and vice versa
+ * \brief This function ensures a continuous transition from 2 to 3 phases and vice versa
* \param params Array of parameters
* \param sne Effective non-wetting liquid saturation
*/
@@ -275,7 +275,7 @@ public:
* pressure to the effective saturation.
* \param params Array of parameters
* \param swe Effective wetting liquid saturation
- */
+ */
static Scalar dpc_dswe(const Params ¶ms, Scalar swe)
{
return ParkerVanGen3P::dpc_dswe(params, swe);
diff --git a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3pparams.hh b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3pparams.hh
index 0c47cd6f255214d913eecef41c9fae29a7ff6822..d04f94037128282050c5ba38024fe71aca073c09 100644
--- a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3pparams.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3pparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Parker - Van Genuchten capillary pressure model.
*/
@@ -30,10 +30,9 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief Parameters that are necessary for the \em regularization of
* the Parker - van Genuchten capillary pressure model.
- *
- * \ingroup fluidmatrixinteractionsparams
*/
template <class ScalarT>
class RegularizedParkerVanGen3PParams : public ParkerVanGen3PParams<ScalarT>
diff --git a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
index 705aa92a3c84d040e4c2ff0183526834b02732d8..4ae52dd73815f3b350f6ad1ade9a1e0eb9f94caf 100644
--- a/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective thermal conductivity
*/
#ifndef THERMALCONDUCTIVITY_SOMERTON_3P_HH
@@ -39,7 +39,6 @@ struct SimpleThreePIndices
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the saturation-dependent effective thermal conductivity
*
* The Somerton method computes the thermal conductivity of dry and the wet soil material.
diff --git a/dumux/material/fluidmatrixinteractions/CMakeLists.txt b/dumux/material/fluidmatrixinteractions/CMakeLists.txt
index 80442427bc50024fcdc3b3dfbdc1f2435edc9acc..4c7d16d78aaa285d9485fcdef7e2d1c23bf232a8 100644
--- a/dumux/material/fluidmatrixinteractions/CMakeLists.txt
+++ b/dumux/material/fluidmatrixinteractions/CMakeLists.txt
@@ -8,5 +8,10 @@ add_subdirectory("mp")
install(FILES
diffusivityconstant.hh
diffusivityconstanttau.hh
+diffusivityconstanttortuosity.hh
diffusivitymillingtonquirk.hh
+permeabilitykozenycarman.hh
+permeabilityrutqvisttsang.hh
+porosityprecipitation.hh
+porosityreactivebed.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/fluidmatrixinteractions)
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstant.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstant.hh
index ffebcd9ed084b6d686a5d8fae812137ab1e162c6..fd68f2e6bee174ffb3e19668e498619577ea5786 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstant.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstant.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_HH
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
index 27540f0b9d0a6792b8b8e9e02cd9351b4c6539fa..57c931005ac7895b599acd7ababbe3b9343ece56 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_TAU_HH
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
index 730bc3d81e37fd7c9c746b957e9946cd11bf1762..56a56badd13e19a50f608ad4ffc3560223cdf4c9 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_CONSTANT_TORTUOSITY_HH
@@ -30,7 +30,6 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the saturation-dependent effective diffusion coefficient
*
* The material law is:
@@ -52,7 +51,6 @@ public:
/*!
* \brief Returns the effective diffusion coefficient \f$\mathrm{[m^2/s]}\f$ based
* on a constant tortuosity value
- *
* \param porosity The porosity
* \param saturation The saturation of the wetting phase
* \param diffCoeff The diffusion coefficient of the phase in \f$\mathrm{[m^2/s]}\f$
@@ -60,7 +58,6 @@ public:
static Scalar effectiveDiffusivity(const Scalar porosity,
const Scalar saturation,
const Scalar diffCoeff)
-
{
static const Scalar tau = getParam<Scalar>("SpatialParams.Tortuosity", 0.5);
diff --git a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
index 00e818d59cbe9cdfb1f256efa86482237f64ffd7..937d7147fca634b0bc17407a5acc9f5256bb21c2 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the saturation-dependent effective diffusion coefficient
*/
#ifndef DIFFUSIVITY_MILLINGTON_QUIRK_HH
@@ -30,10 +30,8 @@ namespace Dumux
{
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the saturation-dependent effective diffusion coefficient
*
- *
* The material law is:
* \f[
* D_\text{eff,pm} = \phi * S_w * \tau * D
@@ -62,7 +60,6 @@ public:
static Scalar effectiveDiffusivity(const Scalar porosity,
const Scalar saturation,
const Scalar diffCoeff)
-
{
// instead of D_eff,pm = phi * Sw * 1/phi^2 * (phi * Sw)^(7/3) * D
// we calculate the more efficient
diff --git a/dumux/material/fluidmatrixinteractions/mp/2padapter.hh b/dumux/material/fluidmatrixinteractions/mp/2padapter.hh
index 919cd8942ce14543520f4ae73a6d9c4225460ffc..0af7fe95ee4fc43603c30af5656a605cde8e391a 100644
--- a/dumux/material/fluidmatrixinteractions/mp/2padapter.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/2padapter.hh
@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file 2padapter.hh
- *
+ * \file
+ * \ingroup fluidmatrixinteractionslaws
* \brief Makes the twophase capillary pressure-saturation relations available under the M-phase API for material laws
*
* Makes the twophase capillary pressure-saturation relations
@@ -32,8 +32,7 @@
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implements a brookscorey saturation-capillary pressure relation
*
* Implements a brookscorey saturation-capillary pressure relation for
diff --git a/dumux/material/fluidmatrixinteractions/mp/2poftadapter.hh b/dumux/material/fluidmatrixinteractions/mp/2poftadapter.hh
index ce8bda5e09153c626a87d3725085564767f03804..f3cbda05ca0923a4e8dc97efe1ece3b3ea0f9de9 100644
--- a/dumux/material/fluidmatrixinteractions/mp/2poftadapter.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/2poftadapter.hh
@@ -18,10 +18,9 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Makes the twophase capillary pressure-saturation relations
* available under the M-phase API for material laws.
- *
* Also use the temperature dependent version of the material laws.
*/
#ifndef DUMUX_MP_2P_OFT_ADAPTER_HH
@@ -32,11 +31,9 @@
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Adapts the interface of the MpNc material law to the standard-Dumux material law.
- *
- * Also use the temperature dependent version of the material laws.
+ * Also use the temperature dependent version of the material laws.
*/
template <int wPhaseIdx, class TwoPLaw>
class TwoPOfTAdapter
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
index 69e43fd2bab8ed3cb7e66a1b6d43cc94288811be..3d2aecb620ea022e313d72ddc960ea953be2d7ea 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implements a linear saturation-capillary pressure relation
*
* Implements a linear saturation-capillary pressure relation for
@@ -34,8 +34,7 @@
namespace Dumux
{
/*!
- * \ingroup material
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Implements a linear saturation-capillary pressure relation
*
* Implements a linear saturation-capillary pressure relation for
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
index f6603af92101f02c6d88dda54c3141253ab3ed3e..ba7aa2f9e58a90efd8edcbf1e59c7b1cacaf0a1f 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of parameters for the M-phase linear
* material material.
*/
@@ -28,6 +28,7 @@
namespace Dumux
{
/*!
+ * \ingroup fluidmatrixinteractionsparams
* \brief Reference implementation of params for the linear M-phase
* material material.
*/
diff --git a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
index cc56135734e9160ebad9389961ba596a006ca2b1..66be802fa4ce8e2575b55f4cd261a3c2d5368c18 100644
--- a/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
+++ b/dumux/material/fluidmatrixinteractions/permeabilitykozenycarman.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief The Kozeny-Carman relationship for the calculation of a porosity-dependent permeability.
*/
#ifndef DUMUX_PERMEABILITY_KOZENY_CARMAN_HH
@@ -29,9 +29,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
- */
-
-/**
* \brief The Kozeny-Carman relationship for the calculation of a porosity-dependent permeability.
* When the porosity is implemented as solution-independent, using this relationship for the
* permeability leads to unnecessary overhead.
@@ -56,13 +53,21 @@ class PermeabilityKozenyCarman
public:
- // the initial parameter distribution
+ /*!
+ * \brief The initial parameter distribution.
+ * \param spatialParams the spatial parameters
+ */
void init(const SpatialParams& spatialParams)
{
spatialParamsPtr_ = &spatialParams;
}
- // calculate permeability for a given scv
+ /*!
+ * \brief calculates the permeability for a given sub-control volume
+ * \param element element
+ * \param elemSol the element solution
+ * \param scv sub control volume
+ */
PermType evaluatePermeability(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
diff --git a/dumux/material/fluidmatrixinteractions/permeabilityrutqvisttsang.hh b/dumux/material/fluidmatrixinteractions/permeabilityrutqvisttsang.hh
index c551822496676994eb4d43a6e9f092539a606d25..14054adab90d6d9409c0d419105ec3b9805bb0b5 100644
--- a/dumux/material/fluidmatrixinteractions/permeabilityrutqvisttsang.hh
+++ b/dumux/material/fluidmatrixinteractions/permeabilityrutqvisttsang.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Relation for the effective permeability
*/
#ifndef PERMEABILITYRUTQVISTSTANG_HH
@@ -32,7 +32,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
- *
* \brief Relation for the effective permeability
*
* After Rutqvist and Tsang (2002) \cite rutqvist2002, the effective permeability can be
diff --git a/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh b/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
index 443d7273c5efd130b38c84be9497625a9ccb4e58..2397e29c18c02d99c206654fa537dfa18670d276 100644
--- a/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
+++ b/dumux/material/fluidmatrixinteractions/porosityprecipitation.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Class for the evaluation of the porosity subject to precipitation.
*/
#ifndef DUMUX_POROSITY_PRECIPITATION_HH
@@ -31,9 +31,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
- */
-
-/**
* \brief Calculates the porosity depending on the volume fractions of precipitated minerals.
*/
template<class TypeTag>
@@ -59,7 +56,12 @@ public:
spatialParamsPtr_ = &spatialParams;
}
- // calculates the porosity in a sub-control volume
+ /*!
+ * \brief calculates the porosity in a sub-control volume
+ * \param element element
+ * \param elemSol the element solution
+ * \param scv sub control volume
+ */
Scalar evaluatePorosity(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
diff --git a/dumux/material/fluidmatrixinteractions/porosityreactivebed.hh b/dumux/material/fluidmatrixinteractions/porosityreactivebed.hh
index 7d7f3c7a225832e441a04de0ff3cf26c1ad23e80..fd0dac0d6ae982ad006de90097aa785b1d64a705 100644
--- a/dumux/material/fluidmatrixinteractions/porosityreactivebed.hh
+++ b/dumux/material/fluidmatrixinteractions/porosityreactivebed.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup fluidmatrixinteractionslaws
* \brief Class for the evaluation of the porosity subject to precipitation.
*/
#ifndef DUMUX_POROSITY_REACTIVE_BED_HH
@@ -31,9 +31,6 @@ namespace Dumux
/*!
* \ingroup fluidmatrixinteractionslaws
- */
-
-/**
* \brief Calculates the porosity depeding on the volume fractions of different solid species.
*/
template<class TypeTag>
@@ -60,7 +57,13 @@ public:
spatialParamsPtr_ = &spatialParams;
}
- // calculates the porosity in a sub-control volume
+ /*!
+ * \brief Calculates the porosity in a sub-control volume.
+ *
+ * \param element element
+ * \param elemSol the element solution
+ * \param scv sub control volume
+ */
Scalar evaluatePorosity(const Element& element,
const SubControlVolume& scv,
const ElementSolution& elemSol) const
diff --git a/dumux/material/fluidstates/2p2c.hh b/dumux/material/fluidstates/2p2c.hh
index c28847cd58a156818b0a6b5a02e5e4acf30c4244..f69efa52319bcbbda4bee0ffd73c275644aad265 100644
--- a/dumux/material/fluidstates/2p2c.hh
+++ b/dumux/material/fluidstates/2p2c.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Calculates the 2p2c phase state for compositional models.
*/
#ifndef DUMUX_2P2C_FLUID_STATE_HH
@@ -33,8 +33,7 @@ namespace Dumux
* \ingroup FluidStates
* \brief Calculates the phase state from the primary variables in the
* sequential 2p2c model.
- *
- * This boils down to so-called "flash calculation", in this case isothermal and isobaric.
+ * This boils down to so-called "flash calculation", in this case isothermal and isobaric.
*/
template <class Scalar, class FluidSystem>
class TwoPTwoCFluidState
@@ -51,10 +50,18 @@ public:
public:
/*!
- * \name acess functions
+ * \name access functions
+ * \todo doc me!
*/
//@{
- /*! @copydoc CompositionalFluidState::saturation()
+
+ /*!
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{
@@ -65,38 +72,63 @@ public:
return 1.0 - sw_;
}
- /*! @copydoc CompositionalFluidState::massFraction()
+ /*!
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The molar fraction \f$x^\kappa_\alpha\f$ is defined as the ratio of the number of molecules
+ * of component \f$\kappa\f$ and the total number of molecules of the phase \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
- Scalar massFraction(int phaseIdx, int compIdx) const
+ Scalar moleFraction(int phaseIdx, int compIdx) const
{
- return massFraction_[phaseIdx][compIdx];
+ return moleFraction_[phaseIdx][compIdx];
}
- /*! @copydoc CompositionalFluidState::moleFraction()
+ /*!
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The mass fraction \f$X^\kappa_\alpha\f$ is defined as the weight of all molecules of a
+ * component divided by the total mass of the fluid phase. It is related with the component's mole fraction by means of the relation
+ *
+ * \f[X^\kappa_\alpha = x^\kappa_\alpha \frac{M^\kappa}{\overline M_\alpha}\;,\f]
+ *
+ * where \f$M^\kappa\f$ is the molar mass of component \f$\kappa\f$ and
+ * \f$\overline M_\alpha\f$ is the mean molar mass of a molecule of phase
+ * \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
- Scalar moleFraction(int phaseIdx, int compIdx) const
+ Scalar massFraction(int phaseIdx, int compIdx) const
{
- return moleFraction_[phaseIdx][compIdx];
+ return massFraction_[phaseIdx][compIdx];
}
- /*! @copydoc CompositionalFluidState::density()
+ /*!
+ * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase
+ * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$
*/
Scalar density(int phaseIdx) const
{ return density_[phaseIdx]; }
- /*! @copydoc CompositionalFluidState::viscosity()
+ /*!
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{ return viscosity_[phaseIdx]; }
- /*! @copydoc CompositionalFluidState::partialPressure()
+ /*!
+ * \brief The partial pressure of a component in the n-phase \f$\mathrm{[Pa]}\f$
*/
Scalar partialPressure(int compIdx) const
{
return partialPressure(nPhaseIdx, compIdx);
}
- /*! @copydoc CompositionalFluidState::partialPressure()
+ /*!
+ * \brief The partial pressure of a component in a phase \f$\mathrm{[Pa]}\f$
*/
Scalar partialPressure(int phaseIdx, int compIdx) const
{
@@ -104,7 +136,8 @@ public:
return pressure(phaseIdx)*moleFraction(phaseIdx, compIdx);
}
- /*! @copydoc CompositionalFluidState::pressure()
+ /*!
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return phasePressure_[phaseIdx]; }
@@ -115,12 +148,19 @@ public:
Scalar capillaryPressure() const
{ return phasePressure_[nPhaseIdx] - phasePressure_[wPhaseIdx]; }
- /*! @copydoc CompositionalFluidState::temperature()
+ /*!
+ * \brief The temperature within the domain \f$\mathrm{[K]}\f$
*/
Scalar temperature(int phaseIdx = 0) const
{ return temperature_; }
- /*! @copydoc CompositionalFluidState::averageMolarMass()
+ /*!
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
*/
Scalar averageMolarMass(int phaseIdx) const
{
@@ -134,7 +174,6 @@ public:
/*!
* \brief Returns the phase mass fraction. phase mass per total mass \f$\mathrm{[kg/kg]}\f$.
- *
* \param phaseIdx the index of the phase
*/
Scalar phaseMassFraction(int phaseIdx)
@@ -148,10 +187,10 @@ public:
}
return nu_[phaseIdx];
}
+
/*!
* \brief Returns the phase mass fraction \f$ \nu \f$:
* phase mass per total mass \f$\mathrm{[kg/kg]}\f$.
- *
* \param phaseIdx the index of the phase
*/
Scalar& nu(int phaseIdx) const
@@ -165,7 +204,6 @@ public:
//@{
/*!
* \brief Sets the viscosity of a phase \f$\mathrm{[Pa*s]}\f$.
- *
* \param phaseIdx the index of the phase
* @param value Value to be stored
*/
@@ -175,7 +213,6 @@ public:
/*!
* \brief Sets the mass fraction of a component in a phase.
- *
* \param phaseIdx the index of the phase
* \param compIdx the index of the component
* @param value Value to be stored
@@ -187,7 +224,6 @@ public:
/*!
* \brief Sets the molar fraction of a component in a fluid phase.
- *
* \param phaseIdx the index of the phase
* \param compIdx the index of the component
* @param value Value to be stored
@@ -198,7 +234,6 @@ public:
}
/*!
* \brief Sets the density of a phase \f$\mathrm{[kg/m^3]}\f$.
- *
* \param phaseIdx the index of the phase
* @param value Value to be stored
*/
@@ -220,7 +255,6 @@ public:
/*!
* \brief Sets the phase mass fraction. phase mass per total mass \f$\mathrm{[kg/kg]}\f$.
- *
* \param phaseIdx the index of the phase
* @param value Value to be stored
*/
@@ -230,7 +264,6 @@ public:
}
/*!
* \brief Sets the temperature
- *
* @param value Value to be stored
*/
void setTemperature(Scalar value)
@@ -239,7 +272,6 @@ public:
}
/*!
* \brief Sets phase pressure
- *
* \param phaseIdx the index of the phase
* @param value Value to be stored
*/
diff --git a/dumux/material/fluidstates/CMakeLists.txt b/dumux/material/fluidstates/CMakeLists.txt
index a2ba880bb2cf125cba00e27551ab96515a56a7c5..7dfb611501406a89820e10851ba2355477add6ce 100644
--- a/dumux/material/fluidstates/CMakeLists.txt
+++ b/dumux/material/fluidstates/CMakeLists.txt
@@ -1,11 +1,12 @@
#install headers
install(FILES
+2p2c.hh
compositional.hh
immiscible.hh
isothermalimmiscible.hh
-nonequilibriumenergy.hh
nonequilibrium.hh
+nonequilibriumenergy.hh
nonequilibriummass.hh
pressureoverlay.hh
saturationoverlay.hh
diff --git a/dumux/material/fluidstates/compositional.hh b/dumux/material/fluidstates/compositional.hh
index 86999c562fc1bdab18292a52ca85294b6d873bc3..79d5198363b3bcfcdaf8e461d01cb0faaf5db213 100644
--- a/dumux/material/fluidstates/compositional.hh
+++ b/dumux/material/fluidstates/compositional.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system assuming
* thermodynamic equilibrium.
diff --git a/dumux/material/fluidstates/immiscible.hh b/dumux/material/fluidstates/immiscible.hh
index 694ce459078b27cdf65695135a6782b73475bbdb..8688eb646fc3246f1c481df5e1de6db65fcf2550 100644
--- a/dumux/material/fluidstates/immiscible.hh
+++ b/dumux/material/fluidstates/immiscible.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase fluid system assuming immiscibility and
* thermodynamic equilibrium.
@@ -60,37 +60,81 @@ public:
* on thermodynamic equilibrium required)
*****************************************************/
/*!
- * @copydoc CompositionalFluidState::saturation()
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{ return saturation_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::moleFraction()
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The molar fraction \f$x^\kappa_\alpha\f$ is defined as the ratio of the number of molecules
+ * of component \f$\kappa\f$ and the total number of molecules of the phase \f$\alpha\f$.
+ * They are set either 1 or 0 in a phase since this is an immiscible fluidstate.
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{ return (phaseIdx == compIdx)?1.0:0.0; }
/*!
- * @copydoc CompositionalFluidState::massFraction()
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * They are set either 1 or 0 in a phase since this is an immiscible fluidstate.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{ return (phaseIdx == compIdx)?1.0:0.0; }
/*!
- * @copydoc CompositionalFluidState::averageMolarMass()
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
+ *
+ * Since this is an immiscible fluidstate we simply consider the molarMass of the
+ * pure component/phase.
*/
Scalar averageMolarMass(int phaseIdx) const
{ return FluidSystem::molarMass(/*compIdx=*/phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::molarity()
+ * \brief The molar concentration \f$c^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * This quantity is usually called "molar concentration" or just
+ * "concentration", but there are many other (though less common)
+ * measures for concentration.
+ *
+ * http://en.wikipedia.org/wiki/Concentration
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::fugacity()
+ * \brief The fugacity \f$f^\kappa_\alpha\f$ of component \f$\kappa\f$
+ * in fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
+ *
+ * The fugacity is defined as:
+ * \f$f_\alpha^\kappa := \Phi^\kappa_\alpha x^\kappa_\alpha p_\alpha \;,\f$
+ * where \f$\Phi^\kappa_\alpha\f$ is the fugacity coefficient \cite reid1987 .
+ * The physical meaning of fugacity becomes clear from the equation:
+ * \f[f_\alpha^\kappa = p_\alpha \exp\left\{\frac{\zeta^\kappa_\alpha}{R T_\alpha} \right\} \;,\f]
+ * where \f$\zeta^\kappa_\alpha\f$ represents the \f$\kappa\f$'s chemical
+ * potential in phase \f$\alpha\f$, \f$R\f$ stands for the ideal gas constant,
+ * and \f$T_\alpha\f$ for the absolute temperature of phase \f$\alpha\f$. Assuming thermal equilibrium,
+ * there is a one-to-one mapping between a component's chemical potential
+ * \f$\zeta^\kappa_\alpha\f$ and its fugacity \f$f^\kappa_\alpha\f$. In this
+ * case chemical equilibrium can thus be expressed by:
+ * \f[f^\kappa := f^\kappa_\alpha = f^\kappa_\beta\quad\forall \alpha, \beta\f]
*
* To avoid numerical issues with code that assumes miscibility,
* we return a fugacity of 0 for components which do not mix with
@@ -107,7 +151,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::fugacityCoefficient()
+ * \brief The fugacity coefficient \f$\Phi^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$
*
* Since we assume immiscibility, the fugacity coefficients for
* the components which are not miscible with the phase is
@@ -123,7 +167,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::partialPressure()
+ * \brief The partial pressure of a component in a phase \f$\mathrm{[Pa]}\f$
*
* To avoid numerical issues with code that assumes miscibility,
* we return a partial pressure of 0 for components which do not mix with
@@ -138,50 +182,61 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::molarVolume()
+ * \brief The molar volume \f$v_{mol,\alpha}\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[m^3/mol]}\f$
*
+ * This quantity is the inverse of the molar density.
*/
Scalar molarVolume(int phaseIdx) const
{ return 1/molarDensity(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::density()
+ * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase
+ * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$
*/
Scalar density(int phaseIdx) const
{ return density_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::molarDensity()
+ * \brief The molar density \f$\rho_{mol,\alpha}\f$
+ * of a fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * The molar density is defined by the mass density \f$\rho_\alpha\f$ and the mean molar mass \f$\overline M_\alpha\f$:
+ *
+ * \f[\rho_{mol,\alpha} = \frac{\rho_\alpha}{\overline M_\alpha} \;.\f]
*/
Scalar molarDensity(int phaseIdx) const
{ return density_[phaseIdx]/averageMolarMass(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::temperature()
+ * \brief The absolute temperature\f$T_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[K]}\f$
*/
Scalar temperature(int phaseIdx) const
{ return temperature_; }
/*!
- * @copydoc CompositionalFluidState::pressure()
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::enthalpy()
+ * \brief The specific enthalpy \f$h_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
*/
Scalar enthalpy(int phaseIdx) const
{ return enthalpy_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::internalEnergy()
+ * \brief The specific internal energy \f$u_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ *
+ * The specific internal energy is defined by the relation:
+ *
+ * \f[u_\alpha = h_\alpha - \frac{p_\alpha}{\rho_\alpha}\f]
*/
Scalar internalEnergy(int phaseIdx) const
{ return enthalpy_[phaseIdx] - pressure(phaseIdx)/density(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::viscosity()
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{ return viscosity_[phaseIdx]; }
diff --git a/dumux/material/fluidstates/isothermalimmiscible.hh b/dumux/material/fluidstates/isothermalimmiscible.hh
index a028111d3d8f7d202271e4bb17fd44fdfc7f6ecf..ba5b0e7eae7f48745f5fa68501a5eb75c64d7568 100644
--- a/dumux/material/fluidstates/isothermalimmiscible.hh
+++ b/dumux/material/fluidstates/isothermalimmiscible.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a isothermal immiscible
* multi-phase fluid system
*/
@@ -56,37 +56,74 @@ public:
* Generic access to fluid properties
*****************************************************/
/*!
- * @copydoc CompositionalFluidState::saturation()
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{ return saturation_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::moleFraction()
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The molar fraction \f$x^\kappa_\alpha\f$ is defined as the ratio of the number of molecules
+ * of component \f$\kappa\f$ and the total number of molecules of the phase \f$\alpha\f$.
+ * They are set either 1 or 0 in a phase since this is an immiscible fluidstate.
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{ return (phaseIdx == compIdx)?1.0:0.0; }
/*!
- * @copydoc CompositionalFluidState::massFraction()
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * They are set either 1 or 0 in a phase since this is an immiscible fluidstate.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{ return (phaseIdx == compIdx)?1.0:0.0; }
/*!
- * @copydoc CompositionalFluidState::averageMolarMass()
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
+ *
+ * Since this is an immiscible fluidstate we simply consider the molarMass of the
+ * pure component/phase.
*/
Scalar averageMolarMass(int phaseIdx) const
{ return FluidSystem::molarMass(/*compIdx=*/phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::molarity()
+ * \brief The molar concentration \f$c^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * This quantity is usually called "molar concentration" or just
+ * "concentration", but there are many other (though less common)
+ * measures for concentration.
+ *
+ * http://en.wikipedia.org/wiki/Concentration
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
/*!
+ * \brief The fugacity \f$f^\kappa_\alpha\f$ of component \f$\kappa\f$
+ * in fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
* @copydoc ImmiscibleFluidState::fugacity()
+ * To avoid numerical issues with code that assumes miscibility,
+ * we return a fugacity of 0 for components which do not mix with
+ * the specified phase. (Actually it is undefined, but for finite
+ * fugacity coefficients, the only way to get components
+ * completely out of a phase is 0 to feed it zero fugacity.)
*/
Scalar fugacity(int phaseIdx, int compIdx) const
{
@@ -97,7 +134,12 @@ public:
}
/*!
- * @copydoc ImmiscibleFluidState::fugacityCoefficient()
+ * \brief The fugacity coefficient \f$\Phi^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$
+ *
+ * Since we assume immiscibility, the fugacity coefficients for
+ * the components which are not miscible with the phase is
+ * infinite. Beware that this will very likely break your code if
+ * you don't keep that in mind.
*/
Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
{
@@ -108,19 +150,27 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::molarVolume()
+ * \brief The molar volume \f$v_{mol,\alpha}\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[m^3/mol]}\f$
+ *
+ * This quantity is the inverse of the molar density.
*/
Scalar molarVolume(int phaseIdx) const
{ return 1/molarDensity(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::density()
+ * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase
+ * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$
*/
Scalar density(int phaseIdx) const
{ return density_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::molarDensity()
+ * \brief The molar density \f$\rho_{mol,\alpha}\f$
+ * of a fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * The molar density is defined by the mass density \f$\rho_\alpha\f$ and the mean molar mass \f$\overline M_\alpha\f$:
+ *
+ * \f[\rho_{mol,\alpha} = \frac{\rho_\alpha}{\overline M_\alpha} \;.\f]
*/
Scalar molarDensity(int phaseIdx) const
{ return density_[phaseIdx]/averageMolarMass(phaseIdx); }
@@ -138,25 +188,30 @@ public:
{ return temperature_; }
/*!
- * @copydoc CompositionalFluidState::pressure()
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::enthalpy()
+ * \brief The specific enthalpy \f$h_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ * This is not defined for an isothermal fluidstate.
*/
Scalar enthalpy(int phaseIdx) const
{ DUNE_THROW(Dune::NotImplemented,"No enthalpy() function defined for isothermal systems!"); }
/*!
- * @copydoc CompositionalFluidState::internalEnergy()
+ * \brief The specific internal energy \f$u_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ *
+ * The specific internal energy is defined by the relation:
+ * \f[u_\alpha = h_\alpha - \frac{p_\alpha}{\rho_\alpha}\f]
+ * This is not defined for an isothermal fluidstate.
*/
Scalar internalEnergy(int phaseIdx) const
{ DUNE_THROW(Dune::NotImplemented,"No internalEnergy() function defined for isothermal systems!"); }
/*!
- * @copydoc CompositionalFluidState::viscosity()
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{ return viscosity_[phaseIdx]; }
diff --git a/dumux/material/fluidstates/nonequilibrium.hh b/dumux/material/fluidstates/nonequilibrium.hh
index ad564533acf32c777c7acab4b6c04604f59194de..d90281815da03b6594568104e03b2566c81c1ad5 100644
--- a/dumux/material/fluidstates/nonequilibrium.hh
+++ b/dumux/material/fluidstates/nonequilibrium.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system without using
* any assumptions.
@@ -69,20 +69,43 @@ public:
* on thermodynamic equilibrium required)
*****************************************************/
/*!
- * @copydoc Dumux::CompositionalFluidState::saturation()
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{ return saturation_[phaseIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::moleFraction()
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The molar fraction \f$x^\kappa_\alpha\f$ is defined as the ratio of the number of molecules
+ * of component \f$\kappa\f$ and the total number of molecules of the phase \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{ return moleFraction_[phaseIdx][compIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::massFraction()
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The mass fraction \f$X^\kappa_\alpha\f$ is defined as the weight of all molecules of a
+ * component divided by the total mass of the fluid phase. It is related with the component's mole fraction by means of the relation
+ *
+ * \f[X^\kappa_\alpha = x^\kappa_\alpha \frac{M^\kappa}{\overline M_\alpha}\;,\f]
+ *
+ * where \f$M^\kappa\f$ is the molar mass of component \f$\kappa\f$ and
+ * \f$\overline M_\alpha\f$ is the mean molar mass of a molecule of phase
+ * \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{
@@ -96,25 +119,50 @@ public:
}
/*!
- * @copydoc Dumux::CompositionalFluidState::averageMolarMass()
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
*/
Scalar averageMolarMass(int phaseIdx) const
{ return averageMolarMass_[phaseIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::molarity()
+ * \brief The molar concentration \f$c^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * This quantity is usually called "molar concentration" or just
+ * "concentration", but there are many other (though less common)
+ * measures for concentration.
+ *
+ * http://en.wikipedia.org/wiki/Concentration
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return molarDensity(phaseIdx)*moleFraction(phaseIdx, compIdx); }
/*!
- * @copydoc Dumux::CompositionalFluidState::fugacityCoefficient()
+ * \brief The fugacity coefficient \f$\Phi^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$
*/
Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
{ return fugacityCoefficient_[phaseIdx][compIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::fugacity()
+ * \brief The fugacity \f$f^\kappa_\alpha\f$ of component \f$\kappa\f$
+ * in fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
+ *
+ * The fugacity is defined as:
+ * \f$f_\alpha^\kappa := \Phi^\kappa_\alpha x^\kappa_\alpha p_\alpha \;,\f$
+ * where \f$\Phi^\kappa_\alpha\f$ is the fugacity coefficient \cite reid1987 .
+ * The physical meaning of fugacity becomes clear from the equation:
+ * \f[f_\alpha^\kappa = p_\alpha \exp\left\{\frac{\zeta^\kappa_\alpha}{R T_\alpha} \right\} \;,\f]
+ * where \f$\zeta^\kappa_\alpha\f$ represents the \f$\kappa\f$'s chemical
+ * potential in phase \f$\alpha\f$, \f$R\f$ stands for the ideal gas constant,
+ * and \f$T_\alpha\f$ for the absolute temperature of phase \f$\alpha\f$. Assuming thermal equilibrium,
+ * there is a one-to-one mapping between a component's chemical potential
+ * \f$\zeta^\kappa_\alpha\f$ and its fugacity \f$f^\kappa_\alpha\f$. In this
+ * case chemical equilibrium can thus be expressed by:
+ * \f[f^\kappa := f^\kappa_\alpha = f^\kappa_\beta\quad\forall \alpha, \beta\f]
*/
Scalar fugacity(int phaseIdx, int compIdx) const
{
@@ -127,26 +175,34 @@ public:
}
/*!
- * @copydoc Dumux::CompositionalFluidState::molarVolume()
+ * \brief The molar volume \f$v_{mol,\alpha}\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[m^3/mol]}\f$
+ *
+ * This quantity is the inverse of the molar density.
*/
Scalar molarVolume(int phaseIdx) const
{ return 1/molarDensity(phaseIdx); }
/*!
- * @copydoc Dumux::CompositionalFluidState::density()
+ * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase
+ * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$
*/
Scalar density(int phaseIdx) const
{ return density_[phaseIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::molarDensity()
+ * \brief The molar density \f$\rho_{mol,\alpha}\f$
+ * of a fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * The molar density is defined by the mass density \f$\rho_\alpha\f$ and the mean molar mass \f$\overline M_\alpha\f$:
+ *
+ * \f[\rho_{mol,\alpha} = \frac{\rho_\alpha}{\overline M_\alpha} \;.\f]
*/
Scalar molarDensity(int phaseIdx) const
{ return density_[phaseIdx]/averageMolarMass(phaseIdx); }
/*!
- * @copydoc Dumux::CompositionalFluidState::temperature()
+ * \brief The absolute temperature\f$T_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[K]}\f$
*/
Scalar temperature(const int phaseIdx) const
{ return temperature_[phaseIdx]; }
@@ -160,18 +216,23 @@ public:
}
/*!
- * @copydoc Dumux::CompositionalFluidState::pressure()
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
+
/*!
- * @copydoc Dumux::CompositionalFluidState::enthalpy()
+ * \brief The specific enthalpy \f$h_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
*/
Scalar enthalpy(int phaseIdx) const
{ return enthalpy_[phaseIdx]; }
/*!
- * @copydoc Dumux::CompositionalFluidState::internalEnergy()
+ * \brief The specific internal energy \f$u_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ *
+ * The specific internal energy is defined by the relation:
+ *
+ * \f[u_\alpha = h_\alpha - \frac{p_\alpha}{\rho_\alpha}\f]
*/
Scalar internalEnergy(int phaseIdx) const
{
@@ -180,7 +241,7 @@ public:
}
/*!
- * @copydoc Dumux::CompositionalFluidState::viscosity()
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{ return viscosity_[phaseIdx]; }
diff --git a/dumux/material/fluidstates/nonequilibriumenergy.hh b/dumux/material/fluidstates/nonequilibriumenergy.hh
index 3dd5b3a0ecc5b975e25671e1e551b5ca4ad97bcf..7ae3cc7ff1cbe456e4b3093cef1235e740c191b3 100644
--- a/dumux/material/fluidstates/nonequilibriumenergy.hh
+++ b/dumux/material/fluidstates/nonequilibriumenergy.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system without using
* any assumptions.
@@ -70,8 +70,22 @@ public:
{ return fugacity(0, compIdx); }
/*!
- * @copydoc NonEquilibriumFluidState::fugacity()
- */
+ * \brief The fugacity \f$f^\kappa_\alpha\f$ of component \f$\kappa\f$
+ * in fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
+ *
+ * The fugacity is defined as:
+ * \f$f_\alpha^\kappa := \Phi^\kappa_\alpha x^\kappa_\alpha p_\alpha \;,\f$
+ * where \f$\Phi^\kappa_\alpha\f$ is the fugacity coefficient \cite reid1987 .
+ * The physical meaning of fugacity becomes clear from the equation:
+ * \f[f_\alpha^\kappa = p_\alpha \exp\left\{\frac{\zeta^\kappa_\alpha}{R T_\alpha} \right\} \;,\f]
+ * where \f$\zeta^\kappa_\alpha\f$ represents the \f$\kappa\f$'s chemical
+ * potential in phase \f$\alpha\f$, \f$R\f$ stands for the ideal gas constant,
+ * and \f$T_\alpha\f$ for the absolute temperature of phase \f$\alpha\f$. Assuming thermal equilibrium,
+ * there is a one-to-one mapping between a component's chemical potential
+ * \f$\zeta^\kappa_\alpha\f$ and its fugacity \f$f^\kappa_\alpha\f$. In this
+ * case chemical equilibrium can thus be expressed by:
+ * \f[f^\kappa := f^\kappa_\alpha = f^\kappa_\beta\quad\forall \alpha, \beta\f]
+ */
Scalar fugacity(int phaseIdx, int compIdx) const
{
// Unfortunately throw does not work when triggered from a constructor
diff --git a/dumux/material/fluidstates/nonequilibriummass.hh b/dumux/material/fluidstates/nonequilibriummass.hh
index f1351c8d0ed3f770e3fcac84be5732a918a8ef9f..5bbd5a7ed3327ca8e83fcaa04c19bac739aeae76 100644
--- a/dumux/material/fluidstates/nonequilibriummass.hh
+++ b/dumux/material/fluidstates/nonequilibriummass.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Represents all relevant thermodynamic quantities of a
* multi-phase, multi-component fluid system without using
* any assumptions.
@@ -106,7 +106,7 @@ class NonEquilibriumMassFluidState
return temperature_ ;
}
- /*!
+ /*!
* \brief Retrieve all parameters from an arbitrary fluid
* state. The assign method from the parent class cannot be used, because here, we have only one temperature.
* \param fs Fluidstate
@@ -134,8 +134,6 @@ class NonEquilibriumMassFluidState
}
-
-
private:
Scalar temperature_;
};
diff --git a/dumux/material/fluidstates/pressureoverlay.hh b/dumux/material/fluidstates/pressureoverlay.hh
index 18309fab90c08643aa4fcfe59bd7b218f927b39c..b3380b7b317a4dc5d4c6056c0a6d80e330a11b44 100644
--- a/dumux/material/fluidstates/pressureoverlay.hh
+++ b/dumux/material/fluidstates/pressureoverlay.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* pressures and takes all other quantities from an other
* fluid state.
@@ -80,91 +80,151 @@ public:
* on thermodynamic equilibrium required)
*****************************************************/
/*!
- * @copydoc CompositionalFluidState::saturation()
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{ return fs_->saturation(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::moleFraction()
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The molar fraction \f$x^\kappa_\alpha\f$ is defined as the ratio of the number of molecules
+ * of component \f$\kappa\f$ and the total number of molecules of the phase \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{ return fs_->moleFraction(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::massFraction()
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The mass fraction \f$X^\kappa_\alpha\f$ is defined as the weight of all molecules of a
+ * component divided by the total mass of the fluid phase. It is related with the component's mole fraction by means of the relation
+ *
+ * \f[X^\kappa_\alpha = x^\kappa_\alpha \frac{M^\kappa}{\overline M_\alpha}\;,\f]
+ *
+ * where \f$M^\kappa\f$ is the molar mass of component \f$\kappa\f$ and
+ * \f$\overline M_\alpha\f$ is the mean molar mass of a molecule of phase
+ * \f$\alpha\f$.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{ return fs_->massFraction(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::averageMolarMass()
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
*/
Scalar averageMolarMass(int phaseIdx) const
{ return fs_->averageMolarMass(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::molarity()
+ * \brief The molar concentration \f$c^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * This quantity is usually called "molar concentration" or just
+ * "concentration", but there are many other (though less common)
+ * measures for concentration.
+ *
+ * http://en.wikipedia.org/wiki/Concentration
*/
Scalar molarity(int phaseIdx, int compIdx) const
{ return fs_->molarity(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::fugacity()
+ * \brief The fugacity \f$f^\kappa_\alpha\f$ of component \f$\kappa\f$
+ * in fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
+ *
+ * The fugacity is defined as:
+ * \f$f_\alpha^\kappa := \Phi^\kappa_\alpha x^\kappa_\alpha p_\alpha \;,\f$
+ * where \f$\Phi^\kappa_\alpha\f$ is the fugacity coefficient \cite reid1987 .
+ * The physical meaning of fugacity becomes clear from the equation:
+ * \f[f_\alpha^\kappa = p_\alpha \exp\left\{\frac{\zeta^\kappa_\alpha}{R T_\alpha} \right\} \;,\f]
+ * where \f$\zeta^\kappa_\alpha\f$ represents the \f$\kappa\f$'s chemical
+ * potential in phase \f$\alpha\f$, \f$R\f$ stands for the ideal gas constant,
+ * and \f$T_\alpha\f$ for the absolute temperature of phase \f$\alpha\f$. Assuming thermal equilibrium,
+ * there is a one-to-one mapping between a component's chemical potential
+ * \f$\zeta^\kappa_\alpha\f$ and its fugacity \f$f^\kappa_\alpha\f$. In this
+ * case chemical equilibrium can thus be expressed by:
+ * \f[f^\kappa := f^\kappa_\alpha = f^\kappa_\beta\quad\forall \alpha, \beta\f]
*/
Scalar fugacity(int phaseIdx, int compIdx) const
{ return fs_->fugacity(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::fugacityCoefficient()
+ * \brief The fugacity coefficient \f$\Phi^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$
*/
Scalar fugacityCoefficient(int phaseIdx, int compIdx) const
{ return fs_->fugacityCoefficient(phaseIdx, compIdx); }
/*!
- * @copydoc CompositionalFluidState::molarVolume()
+ * \brief The molar volume \f$v_{mol,\alpha}\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[m^3/mol]}\f$
+ *
+ * This quantity is the inverse of the molar density.
*/
Scalar molarVolume(int phaseIdx) const
{ return fs_->molarVolume(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::density()
+ * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase
+ * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$
*/
Scalar density(int phaseIdx) const
{ return fs_->density(phaseIdx); }
/*!
- *@copydoc CompositionalFluidState::molarDensity()
+ * \brief The molar density \f$\rho_{mol,\alpha}\f$
+ * of a fluid phase \f$\alpha\f$ in \f$\mathrm{[mol/m^3]}\f$
+ *
+ * The molar density is defined by the mass density \f$\rho_\alpha\f$ and the mean molar mass \f$\overline M_\alpha\f$:
+ *
+ * \f[\rho_{mol,\alpha} = \frac{\rho_\alpha}{\overline M_\alpha} \;.\f]
*/
Scalar molarDensity(int phaseIdx) const
{ return fs_->molarDensity(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::temperature()
+ * \brief The absolute temperature\f$T_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[K]}\f$
*/
Scalar temperature(int phaseIdx) const
{ return fs_->temperature(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::pressure()
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::enthalpy()
+ * \brief The specific enthalpy \f$h_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
*/
Scalar enthalpy(int phaseIdx) const
{ return fs_->enthalpy(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::internalEnergy()
+ * \brief The specific internal energy \f$u_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ *
+ * The specific internal energy is defined by the relation:
+ *
+ * \f[u_\alpha = h_\alpha - \frac{p_\alpha}{\rho_\alpha}\f]
*/
Scalar internalEnergy(int phaseIdx) const
{ return fs_->internalEnergy(phaseIdx); }
/*!
- * @copydoc CompositionalFluidState::viscosity()
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{ return fs_->viscosity(phaseIdx); }
diff --git a/dumux/material/fluidstates/pseudo1p2c.hh b/dumux/material/fluidstates/pseudo1p2c.hh
index b35650c7a09cc2fb78e37fbcd72a47b57b6b631e..77c04a7121f1747ecb3e7420edb851f6af1a9d49 100644
--- a/dumux/material/fluidstates/pseudo1p2c.hh
+++ b/dumux/material/fluidstates/pseudo1p2c.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief Calculates phase state for a single phase but two-component state.
*/
#ifndef DUMUX_PSEUDO1P2C_FLUID_STATE_HH
@@ -56,7 +56,13 @@ public:
public:
/*! \name Acess functions */
//@{
- /*! @copydoc CompositionalFluidState::saturation()
+ /*!
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ * This is set either to 1 or 0 depending on the phase presence.
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{
@@ -86,7 +92,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::partialPressure()
+ * \brief The partial pressure of a component in a phase \f$\mathrm{[Pa]}\f$
*/
Scalar partialPressure(int phaseIdx, int compIdx) const
{
@@ -94,13 +100,14 @@ public:
return pressure(phaseIdx)*moleFraction(phaseIdx, compIdx);
}
- /*! @copydoc CompositionalFluidState::pressure()
+ /*!
+ * \brief The pressure \f$p_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa]}\f$
*/
Scalar pressure(int phaseIdx) const
{ return pressure_[phaseIdx]; }
/*!
- * @copydoc CompositionalFluidState::density()
+ * \brief Set the density of a phase \f$\mathrm{[kg / m^3]}\f$
*/
Scalar density(int phaseIdx) const
{
@@ -112,7 +119,18 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::massFraction()
+ * \brief Returns the mass fraction \f$X^\kappa_\alpha\f$ of component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The mass fraction \f$X^\kappa_\alpha\f$ is defined as the weight of all molecules of a
+ * component divided by the total mass of the fluid phase. It is related with the component's mole fraction by means of the relation
+ *
+ * This is either set to 1 or 0 depending on the phase presence for the
+ * non-wetting phase in general.
+ * It is set to the mass fraction of water or 1-massFractionWater
+ * if the considered component is the main component of the wetting phase.
+ *
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar massFraction(int phaseIdx, int compIdx) const
{
@@ -133,7 +151,14 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::moleFraction()
+ * \brief Returns the molar fraction \f$x^\kappa_\alpha\f$ of the component \f$\kappa\f$ in fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * This is either set to 1 or 0 depending on the phase presence for the
+ * non-wetting phase in general.
+ * It is set to the mole fraction of water or 1-moleFractionWater
+ * if the considered component is the main component of the wetting phase.
+ * \param phaseIdx the index of the phase
+ * \param compIdx the index of the component
*/
Scalar moleFraction(int phaseIdx, int compIdx) const
{
@@ -152,7 +177,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::viscosity()
+ * \brief The dynamic viscosity \f$\mu_\alpha\f$ of fluid phase \f$\alpha\f$ in \f$\mathrm{[Pa s]}\f$
*/
Scalar viscosity(int phaseIdx) const
{
@@ -161,7 +186,12 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::averageMolarMass()
+ * \brief The average molar mass \f$\overline M_\alpha\f$ of phase \f$\alpha\f$ in \f$\mathrm{[kg/mol]}\f$
+ *
+ * The average molar mass is the mean mass of a mole of the
+ * fluid at current composition. It is defined as the sum of the
+ * component's molar masses weighted by the current mole fraction:
+ * \f[\mathrm{ \overline M_\alpha = \sum_\kappa M^\kappa x_\alpha^\kappa}\f]
*/
Scalar averageMolarMass(int phaseIdx) const
{
@@ -169,7 +199,7 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::enthalpy()
+ * \brief The specific enthalpy \f$h_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
*/
Scalar enthalpy(int phaseIdx) const
{
@@ -180,7 +210,11 @@ public:
}
/*!
- * @copydoc CompositionalFluidState::internalEnergy()
+ * \brief The specific internal energy \f$u_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[J/kg]}\f$
+ *
+ * The specific internal energy is defined by the relation:
+ *
+ * \f[u_\alpha = h_\alpha - \frac{p_\alpha}{\rho_\alpha}\f]
*/
Scalar internalEnergy(int phaseIdx) const
{
diff --git a/dumux/material/fluidstates/saturationoverlay.hh b/dumux/material/fluidstates/saturationoverlay.hh
index 30b576ca442c9d9ed51a1593133d19c9d113eafa..14b7236d46f4944b1028584a15f165e4e0e56614 100644
--- a/dumux/material/fluidstates/saturationoverlay.hh
+++ b/dumux/material/fluidstates/saturationoverlay.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* saturations and takes all other quantities from an other
* fluid state.
@@ -77,7 +77,12 @@ public:
* on thermodynamic equilibrium required)
*****************************************************/
/*!
- * @copydoc CompositionalFluidState::saturation()
+ * \brief Returns the saturation \f$S_\alpha\f$ of a fluid phase \f$\alpha\f$ in \f$\mathrm{[-]}\f$.
+ *
+ * The saturation is defined as the pore space occupied by the fluid divided by the total pore space:
+ * \f[S_\alpha := \frac{\phi \mathcal{V}_\alpha}{\phi \mathcal{V}}\f]
+ *
+ * \param phaseIdx the index of the phase
*/
Scalar saturation(int phaseIdx) const
{ return saturation_[phaseIdx]; }
diff --git a/dumux/material/fluidstates/temperatureoverlay.hh b/dumux/material/fluidstates/temperatureoverlay.hh
index 576d0b8aeedbb3a13a1ef544057c42e917ea75ee..b902ebccdb53d873dcceaae3c4d8dfbb668ff0e4 100644
--- a/dumux/material/fluidstates/temperatureoverlay.hh
+++ b/dumux/material/fluidstates/temperatureoverlay.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidStates
* \brief This is a fluid state which allows to set the fluid
* temperatures and takes all other quantities from an other
* fluid state.
diff --git a/dumux/material/fluidsystems/1p.hh b/dumux/material/fluidsystems/1p.hh
index 599e4a9d353b50dfbab6e8d1c38c2dcc712d61f1..c8899ab81e26c5c50e7db021d51f76e237911355 100644
--- a/dumux/material/fluidsystems/1p.hh
+++ b/dumux/material/fluidsystems/1p.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::OneP
*/
#ifndef DUMUX_1P_FLUIDSYSTEM_HH
@@ -38,7 +38,6 @@ namespace FluidSystems {
/*!
* \ingroup Fluidsystems
- *
* \brief A fluid system for single phase models.
*
* \tparam Scalar the scalar type
diff --git a/dumux/material/fluidsystems/2pimmiscible.hh b/dumux/material/fluidsystems/2pimmiscible.hh
index b89d89ba1505407289399a72f4cf536ff4433727..b2e9d512e4be2b5c6eca6c3391c26443942e9c91 100644
--- a/dumux/material/fluidsystems/2pimmiscible.hh
+++ b/dumux/material/fluidsystems/2pimmiscible.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::TwoPImmiscible
*/
#ifndef DUMUX_2P_IMMISCIBLE_FLUID_SYSTEM_HH
@@ -40,7 +40,6 @@ namespace FluidSystems {
/*!
* \ingroup Fluidsystems
- *
* \brief A fluid system for two-phase models assuming immiscibility and
* thermodynamic equilibrium
*
diff --git a/dumux/material/fluidsystems/2pliquidvapor.hh b/dumux/material/fluidsystems/2pliquidvapor.hh
index 05945907c6fba284c49023b5bf57ccbf94789d38..30679b129a39a54b86a900b7e77061b3648ba9ed 100644
--- a/dumux/material/fluidsystems/2pliquidvapor.hh
+++ b/dumux/material/fluidsystems/2pliquidvapor.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::TwoPLiquidVaporFluidsystem
*/
#ifndef DUMUX_2P_LIQUID_VAPOR_FLUID_SYSTEM_HH
@@ -40,7 +40,6 @@ namespace Dumux {
namespace FluidSystems {
/*!
* \ingroup Fluidsystems
- *
* \brief A two-phase fluid system with only one component.
*/
template <class Scalar, class ComponentType>
diff --git a/dumux/material/fluidsystems/CMakeLists.txt b/dumux/material/fluidsystems/CMakeLists.txt
index 8280d62b894919c9e7a3874aea007924e6b675b4..58233bdd3d5cc4e84bcfbe62478f8e16a91ec12e 100644
--- a/dumux/material/fluidsystems/CMakeLists.txt
+++ b/dumux/material/fluidsystems/CMakeLists.txt
@@ -14,9 +14,11 @@ install(FILES
h2on2kinetic.hh
h2on2o2.hh
liquidphase.hh
+ liquidphase2c.hh
nullparametercache.hh
parametercachebase.hh
purewatersimple.hh
+ simplesteamaircao2h2.hh
spe5.hh
spe5parametercache.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/fluidsystems)
diff --git a/dumux/material/fluidsystems/base.hh b/dumux/material/fluidsystems/base.hh
index b73abf94d3df04f7d671002898f1a233198eb870..2336754b8e96a47d9a0fdc5404d40dd8a7864d91 100644
--- a/dumux/material/fluidsystems/base.hh
+++ b/dumux/material/fluidsystems/base.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::BaseFluidSystem
*/
#ifndef DUMUX_BASE_FLUID_SYSTEM_HH
@@ -29,18 +29,18 @@
namespace Dumux
{
-/*!
- * \ingroup Fluidsystems
- * \brief Fluid system base class.
- *
- * \note Always derive your fluid system from this class to be sure
- * that all basic functionality is available!
- */
namespace FluidSystems
-{
-template <class Scalar, class Implementation>
+{
+ /*!
+ * \ingroup Fluidsystems
+ * \brief Fluid system base class.
+ *
+ * \note Always derive your fluid system from this class to be sure
+ * that all basic functionality is available!
+ */
+ template <class Scalar, class Implementation>
class BaseFluidSystem
{
public:
diff --git a/dumux/material/fluidsystems/brineair.hh b/dumux/material/fluidsystems/brineair.hh
index e87eeee2c6232c7d9d8ef6a304ca2f6e4216f751..9ced0e741627ccc0c70cce7aff1529a94f83b7f9 100644
--- a/dumux/material/fluidsystems/brineair.hh
+++ b/dumux/material/fluidsystems/brineair.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup FluidSystems
* \brief @copybrief Dumux::FluidSystems::BrineAir
*/
#ifndef DUMUX_BRINE_AIR_SYSTEM_HH
@@ -43,7 +43,6 @@ namespace Dumux {
namespace FluidSystems {
/*!
* \ingroup Fluidsystems
- *
* \brief A compositional two-phase fluid system with a liquid and a gaseous phase
* and \f$H_2O\f$, \f$Air\f$ and \f$S\f$ (dissolved minerals) as components.
*
@@ -279,6 +278,7 @@ public:
/*endPressure=*/20e6,
/*pressureSteps=*/200);
}
+
/*!
* \brief Initialize the fluid system's static parameters using
* problem specific temperature and pressure ranges
@@ -290,7 +290,6 @@ public:
* \param pressMax The maximum pressure used for tabulation of water \f$\mathrm{[Pa]}\f$
* \param nPress The number of ticks on the pressure axis of the table of water
*/
-
static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp,
Scalar pressMin, Scalar pressMax, unsigned nPress)
{
@@ -310,7 +309,7 @@ public:
}
using Base::density;
- /*!
+ /*!
* \brief Given a phase's composition, temperature, pressure, and
* the partial pressures of all components, return its
* density \f$\mathrm{[kg/m^3]}\f$.
@@ -555,7 +554,7 @@ public:
}
}
- /*!
+ /*!
* \brief Returns the specific enthalpy \f$\mathrm{[J/kg]}\f$ of a component in a specific phase
* \param fluidState The fluid state
* \param phaseIdx The index of the phase
@@ -642,6 +641,7 @@ public:
else
DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
}
+
/*!
* \brief Return the molality of NaCl \f$\mathrm{[mol/m^3]}\f$.
* \param fluidState An abitrary fluid state
diff --git a/dumux/material/fluidsystems/brineco2.hh b/dumux/material/fluidsystems/brineco2.hh
index e719a8eb42111b866c401647cff5de91bd590431..d3fe6a792776b3506875f8cdc1ebc27dcb28d98d 100644
--- a/dumux/material/fluidsystems/brineco2.hh
+++ b/dumux/material/fluidsystems/brineco2.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::BrineCO2
*/
#ifndef DUMUX_BRINE_CO2_SYSTEM_HH
@@ -413,7 +413,6 @@ public:
* \param paramCache Parameter cache
* \param phaseIdx The index of the fluid phase to consider
*/
-
template <class FluidState>
static Scalar equilibriumMoleFraction(const FluidState &fluidState,
const ParameterCache ¶mCache,
diff --git a/dumux/material/fluidsystems/gasphase.hh b/dumux/material/fluidsystems/gasphase.hh
index 38ffc027b052317e0546155567184eb4841c4872..a7d41e98333bf8e9d395de9891918f230ee4f82e 100644
--- a/dumux/material/fluidsystems/gasphase.hh
+++ b/dumux/material/fluidsystems/gasphase.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::GasPhase
*/
#ifndef DUMUX_GAS_PHASE_HH
diff --git a/dumux/material/fluidsystems/h2oair.hh b/dumux/material/fluidsystems/h2oair.hh
index 9a8244b9a3dbb13164b7add6d5ba6ea520723904..87f764c7256d809d03bb87e6421eb2a2be1faa4f 100644
--- a/dumux/material/fluidsystems/h2oair.hh
+++ b/dumux/material/fluidsystems/h2oair.hh
@@ -19,7 +19,7 @@
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::H2OAir
*/
#ifndef DUMUX_H2O_AIR_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/h2oairmesitylene.hh b/dumux/material/fluidsystems/h2oairmesitylene.hh
index 8cf02196017efe399bf68492fb26a5c54714ca92..786c114c7b097865c20313c7fbe2051ab41d1208 100644
--- a/dumux/material/fluidsystems/h2oairmesitylene.hh
+++ b/dumux/material/fluidsystems/h2oairmesitylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::H2OAirMesitylene
*/
#ifndef DUMUX_H2O_AIR_MESITYLENE_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/h2oairxylene.hh b/dumux/material/fluidsystems/h2oairxylene.hh
index a1584aa194ac908f12c34b456470e28b1fb4ea62..db69d570c91e7fe71f9ed23af64e2705bda07100 100644
--- a/dumux/material/fluidsystems/h2oairxylene.hh
+++ b/dumux/material/fluidsystems/h2oairxylene.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::H2OAirXylene
*/
#ifndef DUMUX_H2O_AIR_XYLENE_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/h2oheavyoilfluidsystem.hh b/dumux/material/fluidsystems/h2oheavyoilfluidsystem.hh
index a6f7b53155cc11a2547a2dac2bb39a0529e1bf40..db51258e8a204e0d36511f392c3701b9c20e1e2c 100644
--- a/dumux/material/fluidsystems/h2oheavyoilfluidsystem.hh
+++ b/dumux/material/fluidsystems/h2oheavyoilfluidsystem.hh
@@ -18,11 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief A fluid system with water, gas and NAPL as phases and
- * \f$H_2O\f$ and \f$NAPL (contaminant)\f$ as components.
- * It uses heavyoil Properties, but allows for a scaling of density
- * thus enabling an artifical DNAPL if desired
+ * \ingroup Fluidsystems
+ * \brief @copybrief Dumux::FluidSystems::H2OHeavyOil
*/
#ifndef DUMUX_H2O_HEAVYOIL_FLUID_SYSTEM_HH
#define DUMUX_H2O_HEAVYOIL_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/h2on2.hh b/dumux/material/fluidsystems/h2on2.hh
index e19e92ebb92197d54c43c95aed51b81ef1f6f6a0..a365db12833b9f859053715af985e1afeb6bbfeb 100644
--- a/dumux/material/fluidsystems/h2on2.hh
+++ b/dumux/material/fluidsystems/h2on2.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief @copybrief Dumux::FluidSystems::H2ON2
+ * \ingroup Fluidsystems
+ * \brief @copydoc Dumux::FluidSystems::H2ON2
*/
#ifndef DUMUX_H2O_N2_FLUID_SYSTEM_HH
#define DUMUX_H2O_N2_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/h2on2kinetic.hh b/dumux/material/fluidsystems/h2on2kinetic.hh
index cc55843d793fc3d6b1ba2888d7b0b5cae303deda..20f84ce8fa420807fa4d5f3686db613c22f05726 100644
--- a/dumux/material/fluidsystems/h2on2kinetic.hh
+++ b/dumux/material/fluidsystems/h2on2kinetic.hh
@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief @copybrief Dumux::FluidSystems::H2ON2Kinetic
+ * \ingroup Fluidsystems
+ * \brief @copydoc Dumux::FluidSystems::H2ON2Kinetic
*/
#ifndef DUMUX_H2O_N2_FLUID_SYSTEM_KINETIC_HH
#define DUMUX_H2O_N2_FLUID_SYSTEM_KINETIC_HH
@@ -310,7 +310,7 @@ public:
return ParentType::H2O::vaporPressure(temperature);
}
};
-}// end namespace Fluidsystem
+} // end namespace Fluidsystem
} // end namespace Dumux
#endif
diff --git a/dumux/material/fluidsystems/h2on2o2.hh b/dumux/material/fluidsystems/h2on2o2.hh
index ba3c02997046fb44c63c101406a7272f593d5b4c..09c6b96d1bf4e254b0502a5a2c6466d444a0ec73 100644
--- a/dumux/material/fluidsystems/h2on2o2.hh
+++ b/dumux/material/fluidsystems/h2on2o2.hh
@@ -19,7 +19,7 @@
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::H2ON2O2
*/
#ifndef DUMUX_H2O_N2_O2_FLUID_SYSTEM_HH
@@ -50,7 +50,6 @@ namespace FluidSystems
/*!
* \ingroup Fluidsystems
- *
* \brief A two-phase (water and air) fluid system
* with water, nitrogen and oxygen as components.
*
diff --git a/dumux/material/fluidsystems/liquidphase.hh b/dumux/material/fluidsystems/liquidphase.hh
index c895044c62d9d197c17bf77bfbd1e9747af52bf0..6d3d99b17b70be2aabc0307461b3475f9ff52688 100644
--- a/dumux/material/fluidsystems/liquidphase.hh
+++ b/dumux/material/fluidsystems/liquidphase.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::LiquidPhase
*/
#ifndef DUMUX_LIQUID_PHASE_HH
diff --git a/dumux/material/fluidsystems/liquidphase2c.hh b/dumux/material/fluidsystems/liquidphase2c.hh
index 9b23b0d48ae53744d2038902edc9976a9cc24795..e114f3d267ca91bd364340fd9755ae22c275d766 100644
--- a/dumux/material/fluidsystems/liquidphase2c.hh
+++ b/dumux/material/fluidsystems/liquidphase2c.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::LiquidPhaseTwoC
*/
#ifndef DUMUX_LIQUID_TWOC_PHASE_HH
diff --git a/dumux/material/fluidsystems/nullparametercache.hh b/dumux/material/fluidsystems/nullparametercache.hh
index d4884f03a75e312b17d069def6a955acaf7b2d03..a056632b89c0b8420dd9ee85461bf0cb9bfe754a 100644
--- a/dumux/material/fluidsystems/nullparametercache.hh
+++ b/dumux/material/fluidsystems/nullparametercache.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::NullParameterCache
*/
#ifndef DUMUX_NULL_PARAMETER_CACHE_HH
@@ -29,6 +29,7 @@
namespace Dumux
{
/*!
+ * \ingroup Fluidsystems
* \brief The a parameter cache which does nothing
*/
class NullParameterCache : public ParameterCacheBase<NullParameterCache>
diff --git a/dumux/material/fluidsystems/parametercachebase.hh b/dumux/material/fluidsystems/parametercachebase.hh
index 96dd8bacc8f918c193349067fbf973048793de57..62965680e8ff023857e4344ba3be1f44e869fa30 100644
--- a/dumux/material/fluidsystems/parametercachebase.hh
+++ b/dumux/material/fluidsystems/parametercachebase.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::ParameterCacheBase
*/
#ifndef DUMUX_PARAMETER_CACHE_BASE_HH
@@ -27,7 +27,7 @@
namespace Dumux
{
/*!
- * \ingroup ParameterCache
+ * \ingroup Fluidsystems
* \brief The base class of the parameter cache classes for fluid systems
*/
template <class Implementation>
diff --git a/dumux/material/fluidsystems/purewatersimple.hh b/dumux/material/fluidsystems/purewatersimple.hh
index 8ce1e38ddad28c42ffa02236d29b1e6404b89d5c..3305b021451f4040a8a4c8da62a8961c29097c1c 100644
--- a/dumux/material/fluidsystems/purewatersimple.hh
+++ b/dumux/material/fluidsystems/purewatersimple.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::PureWaterSimpleFluidSystem
*/
#ifndef DUMUX_PURE_WATER_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/simplesteamaircao2h2.hh b/dumux/material/fluidsystems/simplesteamaircao2h2.hh
index 61494920870ecbd21e6ced655c5d903350b0b7b4..693e5ab9eff0c721e207acecbf6c75941acb8d70 100644
--- a/dumux/material/fluidsystems/simplesteamaircao2h2.hh
+++ b/dumux/material/fluidsystems/simplesteamaircao2h2.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::FluidSystems::SteamAirCaO2H2
*/
#ifndef DUMUX_STEAM_AIR_CAO2H2_SYSTEM_HH
@@ -42,7 +42,6 @@ namespace Dumux {
namespace FluidSystems {
/*!
* \ingroup Fluidsystems
- *
* \brief A compositional one-phase fluid system with \f$H_2O\f$ \f$Air\f$ as gaseous components
* and \f$CaO\f$ and \f$Ca(OH)_2\f$ as solid components drawn for thermo-chemical
* heat storage.
@@ -62,7 +61,6 @@ class SteamAirCaO2H2
public:
using H2O = Dumux::SimpleH2O<Scalar>;
-// using H2O = H2Otype;
using H2O_Air = Dumux::BinaryCoeff::H2O_Air;
using Air = Dumux::Air<Scalar>;
@@ -103,7 +101,7 @@ public:
DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
}
- /*!
+ /*!
* \brief Return whether a phase is liquid
*
* \param phaseIdx The index of the fluid phase to consider
@@ -181,7 +179,7 @@ public:
static const int CaO2H2Idx = 3;
- /*!
+ /*!
* \brief Return the human readable name of a component
*
* \param compIdx The index of the component to consider
@@ -199,7 +197,7 @@ public:
DUNE_THROW(Dune::InvalidStateException, "Invalid component index " << compIdx);
}
- /*!
+ /*!
* \brief Return the molar mass of a component in \f$\mathrm{[kg/mol]}\f$.
*
* \param compIdx The index of the component to consider
@@ -216,7 +214,7 @@ public:
DUNE_THROW(Dune::InvalidStateException, "Invalid component index " << compIdx);
}
- /*!
+ /*!
* \brief Return the mass density of the solid \f$\mathrm{[kg/m^3]}\f$.
*
* \param phaseIdx The index of the solid phase to consider
@@ -235,12 +233,11 @@ public:
// DUNE_THROW(Dune::InvalidStateException, "Invalid solid phase index " << sPhaseIdx);
}
- /*!
+ /*!
* \brief Return the salt specific heat capacity \f$\mathrm{[J/molK]}\f$.
*
* \param phaseIdx The index of the solid phase to consider
*/
-
static Scalar precipitateHeatCapacity(int phaseIdx)
{
if(phaseIdx==cPhaseIdx)
@@ -287,18 +284,17 @@ public:
/*pressureSteps=*/200);
}
- /*!
- * \brief Initialize the fluid system's static parameters using
- * problem specific temperature and pressure ranges
- *
- * \param tempMin The minimum temperature used for tabulation of water \f$\mathrm{[K]}\f$
- * \param tempMax The maximum temperature used for tabulation of water \f$\mathrm{[K]}\f$
- * \param nTemp The number of ticks on the temperature axis of the table of water
- * \param pressMin The minimum pressure used for tabulation of water \f$\mathrm{[Pa]}\f$
- * \param pressMax The maximum pressure used for tabulation of water \f$\mathrm{[Pa]}\f$
- * \param nPress The number of ticks on the pressure axis of the table of water
- */
-
+ /*!
+ * \brief Initialize the fluid system's static parameters using
+ * problem specific temperature and pressure ranges
+ *
+ * \param tempMin The minimum temperature used for tabulation of water \f$\mathrm{[K]}\f$
+ * \param tempMax The maximum temperature used for tabulation of water \f$\mathrm{[K]}\f$
+ * \param nTemp The number of ticks on the temperature axis of the table of water
+ * \param pressMin The minimum pressure used for tabulation of water \f$\mathrm{[Pa]}\f$
+ * \param pressMax The maximum pressure used for tabulation of water \f$\mathrm{[Pa]}\f$
+ * \param nPress The number of ticks on the pressure axis of the table of water
+ */
static void init(Scalar tempMin, Scalar tempMax, unsigned nTemp,
Scalar pressMin, Scalar pressMax, unsigned nPress)
{
@@ -481,11 +477,11 @@ public:
}
/*!
- * \brief Returns the specific enthalpy \f$\mathrm{[J/kg]}\f$ of a component in a specific phase
- * \param fluidState The fluid state
- * \param phaseIdx The index of the phase
- * \param componentIdx The index of the component
- */
+ * \brief Returns the specific enthalpy \f$\mathrm{[J/kg]}\f$ of a component in a specific phase
+ * \param fluidState The fluid state
+ * \param phaseIdx The index of the phase
+ * \param componentIdx The index of the component
+ */
template <class FluidState>
static Scalar componentEnthalpy(const FluidState &fluidState,
int phaseIdx,
diff --git a/dumux/material/fluidsystems/spe5.hh b/dumux/material/fluidsystems/spe5.hh
index d41ce9fd12b3b986e2f0fef3271a9a85ff741501..f56eb96016653fc6e1c08c9be801bce31c97eefc 100644
--- a/dumux/material/fluidsystems/spe5.hh
+++ b/dumux/material/fluidsystems/spe5.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \brief @copybrief Dumux::FluidSystems::Spe5
*/
#ifndef DUMUX_SPE5_FLUID_SYSTEM_HH
diff --git a/dumux/material/fluidsystems/spe5parametercache.hh b/dumux/material/fluidsystems/spe5parametercache.hh
index 1abf914531df2243e0c8122542241ad6db26288c..92e2efa94d62e35d8e83e2f571d5957dfdd0d16b 100644
--- a/dumux/material/fluidsystems/spe5parametercache.hh
+++ b/dumux/material/fluidsystems/spe5parametercache.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Fluidsystems
* \brief @copybrief Dumux::Spe5ParameterCache
*/
#ifndef SPE5_PARAMETER_CACHE_HH
diff --git a/dumux/material/idealgas.hh b/dumux/material/idealgas.hh
index a713b01907aa57d9866ca4cf91ad93729646817a..b2f2c92a3edee69958881d9320307b51599093ec 100644
--- a/dumux/material/idealgas.hh
+++ b/dumux/material/idealgas.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Material
* \brief Relations valid for an ideal gas.
*/
#ifndef DUMUX_IDEAL_GAS_HH
@@ -30,6 +30,7 @@ namespace Dumux
{
/*!
+ * \ingroup Material
* \brief Relations valid for an ideal gas.
*/
template <class Scalar>
diff --git a/dumux/material/spatialparams/CMakeLists.txt b/dumux/material/spatialparams/CMakeLists.txt
index 5d3a46d6518ca96f8d7840873ef44c7e83036d2e..bd834d827b3a1dfb6bc85ce0ad2af95cf00cc76e 100644
--- a/dumux/material/spatialparams/CMakeLists.txt
+++ b/dumux/material/spatialparams/CMakeLists.txt
@@ -1,8 +1,9 @@
#install headers
install(FILES
-fv1p.hh
fv.hh
-implicit1p.hh
-implicit.hh
+fv1p.hh
+gstatrandomfield.hh
+sequentialfv.hh
+sequentialfv1p.hh
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/spatialparams)
diff --git a/dumux/material/spatialparams/fv.hh b/dumux/material/spatialparams/fv.hh
index b0e710206108c9239e8c58f03d08e410e60f506f..d53477d5ab2ba40ff7dddc4f8a0c79972653de46 100644
--- a/dumux/material/spatialparams/fv.hh
+++ b/dumux/material/spatialparams/fv.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of multi-phase problems
* using a fully implicit discretization method.
@@ -34,10 +33,6 @@ namespace Dumux {
/*!
* \ingroup SpatialParameters
- */
-
-
-/**
* \brief The base class for spatial parameters of multi-phase problems
* using a fully implicit discretization method.
*/
diff --git a/dumux/material/spatialparams/fv1p.hh b/dumux/material/spatialparams/fv1p.hh
index b5d73a51a431ca773f1ae7805ca442cd4250a5f4..5ee11e11853de82c43e022e1bf620c6d85283d41 100644
--- a/dumux/material/spatialparams/fv1p.hh
+++ b/dumux/material/spatialparams/fv1p.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of one-phase problems
* using a fully implicit discretization method.
@@ -37,9 +36,6 @@ namespace Dumux {
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of one-phase problems
* using a fully implicit discretization method.
*/
diff --git a/dumux/material/spatialparams/gstatrandomfield.hh b/dumux/material/spatialparams/gstatrandomfield.hh
index c6c51b8aea3da2ddc286f24bcf2888fcff829c65..a3611abd25de38b78552c6ab78bb0c4973e61075 100644
--- a/dumux/material/spatialparams/gstatrandomfield.hh
+++ b/dumux/material/spatialparams/gstatrandomfield.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief Creating random fields using gstat
*/
@@ -77,23 +76,22 @@ public:
, data_(gridView.size(0))
{}
- /*!
- * \brief Creates a new field with random variables, if desired.
- * Otherwise creates a data field from already available data.
- * For the random field generation three files are necessary.
- *
- * A \a gstatControlFile in which all commands and in/output files for gstat are specified.
- * A \a gstatInputFile contains all coordinates (cell centers) of the grid, so that
- * gstat can perform its random realization. The filename must be same as in the gstatControlFile.
- * A \a gstatOutputFile in which gstat writes the random values to this file.
- * The filename must be the same as in the gstatControlFile.
- * \param fieldType
- * \param gstatControlFile name of control file for gstat
- * \param gstatInputFile name of input file for gstat
- * \param gstatOutputFile name of the gstat output file
- * \param createNew set true to create a new field
- */
-
+ /*!
+ * \brief Creates a new field with random variables, if desired.
+ * Otherwise creates a data field from already available data.
+ * For the random field generation three files are necessary.
+ *
+ * A \a gstatControlFile in which all commands and in/output files for gstat are specified.
+ * A \a gstatInputFile contains all coordinates (cell centers) of the grid, so that
+ * gstat can perform its random realization. The filename must be same as in the gstatControlFile.
+ * A \a gstatOutputFile in which gstat writes the random values to this file.
+ * The filename must be the same as in the gstatControlFile.
+ * \param fieldType
+ * \param gstatControlFile name of control file for gstat
+ * \param gstatInputFile name of input file for gstat
+ * \param gstatOutputFile name of the gstat output file
+ * \param createNew set true to create a new field
+ */
void create(const std::string& gstatControlFile,
const std::string& gstatInputFile = "gstatInput.txt",
const std::string& gstatOutputFile = "permeab.dat",
diff --git a/dumux/material/spatialparams/sequentialfv.hh b/dumux/material/spatialparams/sequentialfv.hh
index fafa8a703bfa4906aa9ab2b9d9727fe1f8201836..1f214c28db3d3fbc66d47e72b16b5c9c0ed7ea4d 100644
--- a/dumux/material/spatialparams/sequentialfv.hh
+++ b/dumux/material/spatialparams/sequentialfv.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of problems using the
* fv method.
@@ -33,9 +32,6 @@ namespace Dumux
{
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of a multi-phase problem using the
* fv method.
*/
diff --git a/dumux/material/spatialparams/sequentialfv1p.hh b/dumux/material/spatialparams/sequentialfv1p.hh
index 211389183ce651a93043b5540195f27ae7329d99..1f19e64005f771bb62e494a8b83bdaeb4a0f2abb 100644
--- a/dumux/material/spatialparams/sequentialfv1p.hh
+++ b/dumux/material/spatialparams/sequentialfv1p.hh
@@ -18,7 +18,6 @@
*****************************************************************************/
/*!
* \file
- *
* \ingroup SpatialParameters
* \brief The base class for spatial parameters of problems using the
* fv method.
@@ -39,12 +38,8 @@ namespace Properties
NEW_PROP_TAG(SpatialParams);
}
-
/*!
* \ingroup SpatialParameters
- */
-
-/**
* \brief The base class for spatial parameters of problems using the
* fv method.
*/