mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
tex-code in documentation
This commit is contained in:
committed by
Andreas Lauser
parent
eb22a69805
commit
b2892db7fc
@@ -79,7 +79,7 @@ public:
|
||||
* \brief Return the sum of the concentrations of all components
|
||||
* for a phase.
|
||||
*
|
||||
* Unit: [mol/m^3]
|
||||
* Unit: \f$\mathrm{[mol/m^3]}\f$
|
||||
*/
|
||||
Scalar phaseConcentration(int phaseIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::phaseConcentration()"); }
|
||||
@@ -88,7 +88,7 @@ public:
|
||||
* \brief Return the concentrations of an individual component in
|
||||
* a phase.
|
||||
*
|
||||
* Unit: [mol/m^3]
|
||||
* Unit: \f$\mathrm{[mol/m^3]}\f$
|
||||
*/
|
||||
Scalar concentration(int phaseIdx, int compIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::concentration()"); }
|
||||
@@ -96,7 +96,7 @@ public:
|
||||
/*!
|
||||
* \brief Return the density of a phase.
|
||||
*
|
||||
* Unit: [kg/m^3]
|
||||
* Unit: \f$\mathrm{[kg/m^3]}\f$
|
||||
*/
|
||||
Scalar density(int phaseIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::density()"); }
|
||||
@@ -107,7 +107,7 @@ public:
|
||||
* This is the sum of all molar masses times their respective mole
|
||||
* fractions in the phase.
|
||||
*
|
||||
* Unit: [kg/m^3]
|
||||
* Unit: \f$\mathrm{[kg/m^3]}\f$
|
||||
*/
|
||||
Scalar averageMolarMass(int phaseIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::averageMolarMass()"); }
|
||||
@@ -115,9 +115,9 @@ public:
|
||||
/*!
|
||||
* \brief Return the partial pressure of a component in the gas phase.
|
||||
*
|
||||
* For an ideal gas, this means R*T*c.
|
||||
* For an ideal gas, this means \f$R*T*c\f$.
|
||||
*
|
||||
* Unit: [Pa] = [N/m^2]
|
||||
* Unit: \f$\mathrm{[Pa] = [N/m^2]}\f$
|
||||
*/
|
||||
Scalar fugacity(int componentIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::fugacity()"); }
|
||||
@@ -125,7 +125,7 @@ public:
|
||||
/*!
|
||||
* \brief Return the total pressure of the gas phase.
|
||||
*
|
||||
* Unit: [Pa] = [N/m^2]
|
||||
* Unit: \f$\mathrm{[Pa] = [N/m^2]}\f$
|
||||
*/
|
||||
Scalar phasePressure(int phaseIdx) const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::totalPressure()"); }
|
||||
@@ -134,7 +134,7 @@ public:
|
||||
* \brief Return the temperature at which the equilibrium was
|
||||
* calculated.
|
||||
*
|
||||
* Unit: [Pa] = [N/m^2]
|
||||
* Unit: \f$\mathrm{[Pa] = [N/m^2]}\f$
|
||||
*/
|
||||
Scalar temperature() const
|
||||
{ DUNE_THROW(Dune::NotImplemented, "FluidState::temperature()"); }
|
||||
|
||||
@@ -31,11 +31,11 @@ template <class Scalar>
|
||||
class IdealGas
|
||||
{
|
||||
public:
|
||||
//! The ideal gas constant [J/mol/K]
|
||||
//! The ideal gas constant \f$\mathrm{[J/mol/K]}\f$
|
||||
static const Scalar R = 8.3144;
|
||||
|
||||
/*!
|
||||
* \brief The density of the gas in [kg/m^3], depending on
|
||||
* \brief The density of the gas in \f$\mathrm{[kg/m^3]}\f$, depending on
|
||||
* pressure, temperature and average molar mass of the gas.
|
||||
*/
|
||||
static Scalar density(Scalar avgMolarMass,
|
||||
@@ -44,7 +44,7 @@ public:
|
||||
{ return pressure*avgMolarMass/(R*temperature); }
|
||||
|
||||
/*!
|
||||
* \brief The pressure of the gas in [N/m^2], depending on
|
||||
* \brief The pressure of the gas in \f$\mathrm{[N/m^2]}\f$, depending on
|
||||
* concentration and temperature.
|
||||
*/
|
||||
static Scalar pressure(Scalar temperature,
|
||||
@@ -52,7 +52,7 @@ public:
|
||||
{ return R*temperature*concentration; }
|
||||
|
||||
/*!
|
||||
* \brief The molar concentration of the gas in [mol/m^3], depending on
|
||||
* \brief The molar concentration of the gas in \f$\mathrm{[mol/m^3]}\f$, depending on
|
||||
* pressure and temperature.
|
||||
*/
|
||||
static Scalar concentration(Scalar temperature,
|
||||
|
||||
@@ -53,7 +53,7 @@ public:
|
||||
* \brief Return the sum of the concentrations of all components
|
||||
* for a phase.
|
||||
*
|
||||
* Unit: [mol/m^3]
|
||||
* Unit: \f$\mathrm{[mol/m^3]}\f$
|
||||
*/
|
||||
Scalar phaseConcentration() const
|
||||
{ return density_/meanMolarMass_; }
|
||||
@@ -62,7 +62,7 @@ public:
|
||||
* \brief Return the concentrations of an individual component in
|
||||
* a phase.
|
||||
*
|
||||
* Unit: [mol/m^3]
|
||||
* Unit: \f$\mathrm{[mol/m^3]}\f$
|
||||
*/
|
||||
Scalar concentration(int compIdx) const
|
||||
{ return moleFrac_[compIdx]*phaseConcentration(); }
|
||||
@@ -70,7 +70,7 @@ public:
|
||||
/*!
|
||||
* \brief Return the density of a phase.
|
||||
*
|
||||
* Unit: [kg/m^3]
|
||||
* Unit: \f$\mathrm{[kg/m^3]}\f$
|
||||
*/
|
||||
Scalar density() const
|
||||
{ return density_; }
|
||||
@@ -81,7 +81,7 @@ public:
|
||||
* This is the sum of all molar masses times their respective mole
|
||||
* fractions in the phase.
|
||||
*
|
||||
* Unit: [kg/m^3]
|
||||
* Unit: \f$\mathrm{[kg/m^3]}\f$
|
||||
*/
|
||||
Scalar meanMolarMass() const
|
||||
{ return meanMolarMass_; }
|
||||
@@ -89,7 +89,7 @@ public:
|
||||
/*!
|
||||
* \brief Return the total pressure of the phase.
|
||||
*
|
||||
* Unit: [Pa] = [N/m^2]
|
||||
* Unit: \f$\mathrm{[Pa] = [N/m^2]}\f$
|
||||
*/
|
||||
Scalar pressure() const
|
||||
{ return pressure_; };
|
||||
|
||||
Reference in New Issue
Block a user