Commit 39e90e2b authored by Simon Scholz's avatar Simon Scholz
Browse files

Reviewed the units of the functions in the component folder.

Reviewed by Alex

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@14369 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 8c1bfe0b
......@@ -72,7 +72,7 @@ public:
{ return 37.86e5; /* [Pa] */ }
/*!
* \brief The density of \f$AIR\f$ at a given pressure and temperature [kg/m^3].
* \brief The density of \f$AIR\f$ 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 phase in \f$\mathrm{[Pa]}\f$
......@@ -204,7 +204,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity \f$\mathrm{[J/(kg*K)}\f$ of pure
* \brief Specific isobaric heat capacity \f$\mathrm{[J/(kg*K)]}\f$ of pure
* air.
*
* This methods uses the formula for "zero-pressure" heat capacity that
......@@ -220,7 +220,7 @@ public:
static const Scalar gasHeatCapacity(Scalar temperature,
Scalar pressure)
{
// scale temperature with referenence temp of 100K
// scale temperature with reference temp of 100K
Scalar phi = temperature/100;
Scalar c_p = 0.661738E+01
......
......@@ -78,7 +78,7 @@ public:
* \brief Returns the critical pressure \f$\mathrm{[Pa]}\f$ of brine.
*/
static Scalar criticalPressure()
{ return H2O::criticalPressure(); /* [N/m^2] */ }
{ return H2O::criticalPressure(); /* [Pa] */ }
/*!
* \brief Returns the temperature \f$\mathrm{[K]}\f$ at brine's triple point.
......@@ -90,7 +90,7 @@ public:
* \brief Returns the pressure \f$\mathrm{[Pa]}\f$ at brine's triple point.
*/
static Scalar triplePressure()
{ return H2O::triplePressure(); /* [N/m^2] */ }
{ return H2O::triplePressure(); /* [Pa] */ }
/*!
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure brine
......@@ -100,7 +100,7 @@ public:
*/
static Scalar vaporPressure(Scalar T)
{ return H2O::vaporPressure(T); /* [N/m^2] */ }
{ return H2O::vaporPressure(T); /* [Pa] */ }
/*!
* \brief Specific enthalpy of gaseous brine \f$\mathrm{[J/kg]}\f$.
......
......@@ -58,7 +58,7 @@ public:
* \brief The molar mass in \f$\mathrm{[kg/mol]}\f$ of molecular methane.
*/
static Scalar molarMass()
{ return 16.043e-3;}
{ return 16.043e-3; /* [kg/mol] */}
/*!
* \brief Returns the critical temperature \f$\mathrm{[K]}\f$ of molecular methane
......@@ -70,7 +70,7 @@ public:
* \brief Returns the critical pressure \f$\mathrm{[Pa]}\f$ of molecular methane
*/
static Scalar criticalPressure()
{ return 46e5; /* [N/m^2] */ }
{ return 46e5; /* [Pa] */ }
/*!
* \brief Returns the temperature \f$\mathrm{[K]}\f$ at molecular methane's triple point.
......@@ -82,7 +82,7 @@ public:
* \brief Returns the pressure \f$\mathrm{[Pa]}\f$ at molecular methane's triple point.
*/
static Scalar triplePressure()
{ return 0; /* [N/m^2] */ }
{ return 0; /* [Pa] */ }
/*!
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure molecular methane
......
......@@ -59,61 +59,61 @@ public:
{ return "CO2"; }
/*!
* \brief The mass in [kg] of one mole of CO2.
* \brief The mass in \f$\mathrm{[kg/mol]}\f$ of one mole of CO2.
*/
static Scalar molarMass()
{ return 44e-3; }
{ return 44e-3; /* [kg/mol] */ }
/*!
* \brief Returns the critical temperature [K] of CO2
* \brief Returns the critical temperature \f$\mathrm{[K]}\f$ of CO2
*/
static Scalar criticalTemperature()
{ return 273.15 + 30.95; /* [K] */ }
/*!
* \brief Returns the critical pressure [Pa] of CO2
* \brief Returns the critical pressure \f$\mathrm{[Pa]}\f$ of CO2
*/
static Scalar criticalPressure()
{ return 73.8e5; /* [N/m^2] */ }
{ return 73.8e5; /* [Pa] */ }
/*!
* \brief Returns the temperature [K]at CO2's triple point.
* \brief Returns the temperature \f$\mathrm{[K]}\f$ at CO2's triple point.
*/
static Scalar tripleTemperature()
{ return 273.15 - 56.35; /* [K] */ }
/*!
* \brief Returns the pressure [Pa] at CO2's triple point.
* \brief Returns the pressure \f$\mathrm{[Pa]}\f$ at CO2's triple point.
*/
static Scalar triplePressure()
{ return 5.11e5; /* [N/m^2] */ }
/*!
* \brief Returns the pressure [Pa] at CO2's triple point.
* \brief Returns the pressure \f$\mathrm{[Pa]}\f$ at CO2's triple point.
*/
static Scalar minTabulatedPressure()
{ return CO2Tables::tabulatedEnthalpy.minPress(); /* [N/m^2] */ }
{ return CO2Tables::tabulatedEnthalpy.minPress(); /* [Pa] */ }
/*!
* \brief Returns the pressure [Pa] at CO2's triple point.
* \brief Returns the pressure \f$\mathrm{[Pa]}\f$ at CO2's triple point.
*/
static Scalar maxTabulatedPressure()
{ return CO2Tables::tabulatedEnthalpy.maxPress(); /* [N/m^2] */ }
{ return CO2Tables::tabulatedEnthalpy.maxPress(); /* [Pa] */ }
/*!
* \brief Returns the pressure [Pa] at CO2's triple point.
* \brief Returns the temperature \f$\mathrm{[K]}\f$ at CO2's triple point.
*/
static Scalar minTabulatedTemperature()
{ return CO2Tables::tabulatedEnthalpy.minTemp(); /* [N/m^2] */ }
{ return CO2Tables::tabulatedEnthalpy.minTemp(); /* [K] */ }
/*!
* \brief Returns the pressure [Pa] at CO2's triple point.
* \brief Returns the temperature \f$\mathrm{[K]}\f$ at CO2's triple point.
*/
static Scalar maxTabulatedTemperature()
{ return CO2Tables::tabulatedEnthalpy.maxTemp(); /* [N/m^2] */ }
{ return CO2Tables::tabulatedEnthalpy.maxTemp(); /* [K] */ }
/*!
* \brief The vapor pressure in [N/m^2] of pure CO2
* \brief The vapor pressure in \f$\mathrm{[Pa]}\f$ of pure CO2
* at a given temperature.
*
* See:
......@@ -143,7 +143,7 @@ public:
}
/*!
* \brief Specific enthalpy of gaseous CO2 [J/kg].
* \brief Specific enthalpy of gaseous CO2 \f$\mathrm{[J/kg]}\f$.
*/
static Scalar gasEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -159,7 +159,7 @@ public:
}
/*!
* \brief Specific enthalpy of liquid CO2 [J/kg].
* \brief Specific enthalpy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
*/
static Scalar liquidEnthalpy(Scalar temperature,
Scalar pressure)
......@@ -175,7 +175,7 @@ public:
}
/*!
* \brief Specific internal energy of CO2 [J/kg].
* \brief Specific internal energy of CO2 \f$\mathrm{[J/kg]}\f$.
*/
static Scalar gasInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -187,7 +187,7 @@ public:
}
/*!
* \brief Specific internal energy of liquid CO2 [J/kg].
* \brief Specific internal energy of liquid CO2 \f$\mathrm{[J/kg]}\f$.
*/
static Scalar liquidInternalEnergy(Scalar temperature,
Scalar pressure)
......@@ -199,7 +199,7 @@ public:
}
/*!
* \brief The density of CO2 at a given pressure and temperature [kg/m^3].
* \brief The density of CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......@@ -214,7 +214,7 @@ public:
}
/*!
* \brief The density of pure CO2 at a given pressure and temperature [kg/m^3].
* \brief The density of pure CO2 at a given pressure and temperature \f$\mathrm{[kg/m^3]}\f$.
*/
static Scalar liquidDensity(Scalar temperature, Scalar pressure)
{
......@@ -230,7 +230,7 @@ public:
* \brief The pressure of steam in \f$\mathrm{[Pa]}\f$ at a given density and temperature.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param density denstiy of component in \f$\mathrm{[kg/m^3]}\f$
* \param density density of component in \f$\mathrm{[kg/m^3]}\f$
*/
static Scalar gasPressure(Scalar temperature, Scalar density)
{
......@@ -250,7 +250,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of the component [J/kg] as a liquid.
* \brief Specific isobaric heat capacity of the component \f$\mathrm{[J/kg*K]}\f$ as a liquid.
* USE WITH CAUTION! Exploits enthalpy function with artificial increment
* of the temperature!
* Equation with which the specific heat capacity is calculated : \f$ c_p = \frac{dh}{dT}\f$
......@@ -274,7 +274,7 @@ public:
/*!
* \brief The dynamic viscosity [N/m^3*s] of CO2.
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of CO2.
* Equations given in: - Vesovic et al., 1990
* - Fenhour et al., 1998
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
......@@ -339,7 +339,9 @@ public:
};
/*!
* \brief The dynamic viscosity [N/m^3*s] of pure CO2.
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of pure CO2.
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{
......
......@@ -85,7 +85,7 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "Component::name()"); }
/*!
* \brief The molar mass in \f$\mathrm{[kg]}\f$ of the component.
* \brief The molar mass in \f$\mathrm{[kg/mol]}\f$ of the component.
*/
static Scalar molarMass()
{ DUNE_THROW(Dune::NotImplemented, "Component::molarMass()"); }
......@@ -199,25 +199,33 @@ public:
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidViscosity()"); }
/*!
* \brief Thermal conductivity of the component [W/(m^2 K/m)] as a gas.
* \brief Thermal conductivity of the component \f$\mathrm{[W/(m*K)]}\f$ as a gas.
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar gasThermalConductivity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::gasThermalConductivity()"); }
/*!
* \brief Thermal conductivity of the component [W/(m^2 K/m)] as a liquid.
* \brief Thermal conductivity of the component \f$\mathrm{[W/(m*K)]}\f$ as a liquid.
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidThermalConductivity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidThermalConductivity()"); }
/*!
* \brief Specific isobaric heat capacity of the component [J/kg] as a gas.
* \brief Specific isobaric heat capacity of the component \f$\mathrm{[J/(kg*K)]}\f$ as a gas.
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar gasHeatCapacity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::gasHeatCapacity()"); }
/*!
* \brief Specific isobaric heat capacity of the component [J/kg] as a liquid.
* \brief Specific isobaric heat capacity of the component \f$\mathrm{[J/(kg*K)]}\f$ as a liquid.
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*/
static Scalar liquidHeatCapacity(Scalar temperature, Scalar pressure)
{ DUNE_THROW(Dune::NotImplemented, "Component::liquidHeatCapacity()"); }
......
......@@ -52,7 +52,7 @@ public:
*/
static Scalar molarMass()
{
return 131.39e-3; // kg/mol
return 131.39e-3; // [kg/mol]
};
/*!
......@@ -148,7 +148,7 @@ public:
*/
static Scalar liquidViscosity(Scalar temperature, Scalar pressure)
{
return 5.7e-4;// [Pa s]
return 5.7e-4;// [Pa*s]
};
};
......
......@@ -137,7 +137,7 @@ public:
return Region4::saturationPressure(T);
}
/*!
* \brief The vapor temperature in \f$\mathrm{[Ka]}\f$ of pure water
* \brief The vapor temperature in \f$\mathrm{[K]}\f$ of pure water
* at a given pressure.
*
*\param pressure pressure in \f$\mathrm{[Pa]}\f$
......@@ -286,7 +286,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of liquid water \f$\mathrm{[J/kg]}\f$.
* \brief Specific isobaric heat capacity of liquid water \f$\mathrm{[J/(kg*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -449,7 +449,7 @@ public:
}
/*!
* \brief Specific isochoric heat capacity of liquid water \f$\mathrm{[J/m^3]}\f$.
* \brief Specific isochoric heat capacity of liquid water \f$\mathrm{[J/(m^3*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -798,7 +798,7 @@ public:
}
/*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m K)]}\f$ of water (IAPWS) .
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of water (IAPWS) .
*
* Implementation taken from:
* freesteam - IAPWS-IF97 steam tables library
......@@ -807,8 +807,8 @@ public:
* Appendix B: Recommended Interpolating equation for Industrial Use
* see http://www.iapws.org/relguide/thcond.pdf
*
* \param temperature absolute temperature in K
* \param pressure of the phase in Pa
* \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)
{
......@@ -827,7 +827,7 @@ public:
}
/*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m K)]}\f$ of water (IAPWS) .
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ of water (IAPWS) .
*
* Implementation taken from:
* freesteam - IAPWS-IF97 steam tables library
......@@ -836,8 +836,8 @@ public:
* Appendix B: Recommended Interpolating equation for Industrial Use
* see http://www.iapws.org/relguide/thcond.pdf
*
* \param temperature absolute temperature in K
* \param pressure of the phase in Pa
* \param temperature absolute temperature in \f$\mathrm{[K]}\f$
* \param pressure of the phase in \f$\mathrm{[Pa]}\f$
*/
static Scalar gasThermalConductivity(const Scalar temperature, const Scalar pressure)
{
......
......@@ -90,7 +90,7 @@ public:
static const Scalar triplePressure;
/*!
* \brief The dynamic viscosity \f$\mathrm{[(N/m^2)*s]}\f$of pure water.
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of pure water.
*
* This relation is valid for all regions of the IAPWS '97
* formulation.
......@@ -150,7 +150,7 @@ public:
}
/*!
* \brief Thermal conductivity \f$\mathrm{[[W/(m^2 K/m)]}\f$ water (IAPWS) .
* \brief Thermal conductivity \f$\mathrm{[[W/(m*K)]}\f$ water (IAPWS) .
*
* Implementation taken from:
* freesteam - IAPWS-IF97 steam tables library
......@@ -159,8 +159,8 @@ public:
* Appendix B: Recommended Interpolating equation for Industrial Use
* see http://www.iapws.org/relguide/thcond.pdf
*
* \param T absolute temperature in K
* \param rho density of water in kg/m^3
* \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)
{
......
......@@ -82,7 +82,7 @@ public:
/*!
* \brief Returns the reduced temperature (dimensionless) for IAPWS region 2.
*
* \param temperature temperature of component
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
*/
static Scalar tau(Scalar temperature)
{ return 540.0 / temperature; }
......@@ -293,7 +293,7 @@ public:
/*!
* \brief The second partial derivative of the Gibbs free energy to the
* normalized temperature for IAPWS region 2 (i.e. sub-critical
* steam) dimensionless).
* steam) (dimensionless).
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......
......@@ -189,7 +189,7 @@ public:
}
/*!
* \brief
* \brief The density of mesitylene 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$
......@@ -274,7 +274,7 @@ public:
}
/*!
* \brief Specific heat cap of liquid mesitylene \f$\mathrm{[J/kg]}\f$.
* \brief Specific heat capacity of liquid mesitylene \f$\mathrm{[J/(kg*K)]}\f$.
*
* source : Reid et al. (fourth edition): Missenard group contrib. method (chap 5-7, Table 5-11, s. example 5-8)
*
......
......@@ -217,7 +217,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity \f$[J/(kg K)]\f$ of pure
* \brief Specific isobaric heat capacity \f$\mathrm{[J/(kg*K)]}\f$ of pure
* nitrogen gas.
*
* This is equivalent to the partial derivative of the specific
......
......@@ -133,7 +133,7 @@ public:
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
*
* \todo density liquid oxygen
* \TODO: density liquid oxygen
*/
static Scalar gasDensity(Scalar temperature, Scalar pressure)
{
......
......@@ -132,7 +132,7 @@ public:
{ return true; }
/*!
* \brief The density of \f$CO_2\f$ at a given pressure and temperature [kg/m^3].
* \brief The density of \f$CO_2\f$ 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$
......
......@@ -269,7 +269,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of the component [J/(kg K)] as a liquid.
* \brief Specific isobaric heat capacity of the component \f$\mathrm{[J/(kg*K)]}\f$ as a liquid.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......
......@@ -325,7 +325,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of the gas \f$\mathrm{[J/(kg K)]}\f$.
* \brief Specific isobaric heat capacity of the gas \f$\mathrm{[J/(kg*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -343,7 +343,7 @@ public:
}
/*!
* \brief Specific isobaric heat capacity of the liquid \f$\mathrm{[J/(kg K)]}\f$.
* \brief Specific isobaric heat capacity of the liquid \f$\mathrm{[J/(kg*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -518,7 +518,7 @@ public:
};
/*!
* \brief The thermal conductivity of gaseous water \f$\mathrm{[W / (m K)]}\f$.
* \brief The thermal conductivity of gaseous water \f$\mathrm{[W/(m*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -536,7 +536,7 @@ public:
};
/*!
* \brief The thermal conductivity of liquid water \f$\mathrm{[W / (m K)]}\f$.
* \brief The thermal conductivity of liquid water \f$\mathrm{[W/(m*K)]}\f$.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......
......@@ -244,7 +244,7 @@ public:
}
/*!
* \brief The density \f$\mathrm{[mol/m^3]}\f$ of xylene gas at a given pressure and temperature.
* \brief The molar gas density \f$\mathrm{[mol/m^3]}\f$ of xylene gas at a given pressure and temperature.
*
* \param temperature temperature of component in \f$\mathrm{[K]}\f$
* \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
......@@ -255,7 +255,7 @@ public:
}
/*!
* \brief The molar density of pure xylene at a given pressure and temperature
* \brief The molar liquid density of pure xylene at a given pressure and temperature
* \f$\mathrm{[mol/m^3]}\f$.
*
* source : Reid et al. (fourth edition): Modified Racket technique (chap. 3-11, eq. 3-11.9)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment