From 7bc731ebd87f99e7c27e75ec53a9b8ce3d95d646 Mon Sep 17 00:00:00 2001
From: Klaus Mosthaf <klmos@env.dtu.dk>
Date: Mon, 8 Nov 2010 12:17:01 +0000
Subject: [PATCH] some changes in the fluidsystems docu
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4612 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/material/fluidsystems/2p_system.hh | 63 +++++++++++++++----
dumux/material/fluidsystems/gasphase.hh | 2 +-
dumux/material/fluidsystems/h2o_n2_system.hh | 28 ++++++++-
.../fluidsystems/isfluid_trail_system.hh | 45 +++++++++++--
4 files changed, 117 insertions(+), 21 deletions(-)
diff --git a/dumux/material/fluidsystems/2p_system.hh b/dumux/material/fluidsystems/2p_system.hh
index 0f60513d57..ad65252308 100644
--- a/dumux/material/fluidsystems/2p_system.hh
+++ b/dumux/material/fluidsystems/2p_system.hh
@@ -16,8 +16,8 @@
/*!
* \file
*
- * \brief A fluid system with water and gas as phases and \f$H_2O\f$ and \f$N_2\f$
- * as components.
+ * \brief An adapter call for a pure two-phase system,
+ * where the wetting and the non-wetting phase can be defined.
*/
#ifndef DUMUX_2P_SYSTEM_HH
#define DUMUX_2P_SYSTEM_HH
@@ -40,8 +40,14 @@ NEW_PROP_TAG(NonwettingPhase);
/*!
- * \brief A compositional fluid with water and molecular nitrogen as
- * components in both, the liquid and the gas phase.
+ * \ingroup Fluidsystems
+ *
+ * \brief This is an adapter class for a pure two-phase system.
+ *
+ * In this adapter class, two fluid phases of the type liquidphase or gasphase
+ * can be defined. These phases consist of one pure component. With the help of
+ * this adapter class, the phase properties can be accessed. This is suitable
+ * for pure two-phase systems without compositional effects.
*/
template <class TypeTag>
class FluidSystem2P
@@ -71,6 +77,8 @@ public:
/*!
* \brief Return the human readable name of a component
+ *
+ * \param phaseIdx index of the phase
*/
static const char *componentName(int phaseIdx)
{
@@ -83,6 +91,8 @@ public:
/*!
* \brief Return the molar mass of a component in [kg/mol].
+ *
+ * \param phaseIdx index of the phase
*/
static Scalar molarMass(int phaseIdx)
{
@@ -95,6 +105,12 @@ public:
/*!
* \brief Return the density of a component for a phase [kg/m^3].
+ *
+ * \param phaseIdx index of the phase
+ * \param compIdx index of the component
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \return density of the phase, if phaseIdx = compIdx, otherwise 0
*/
static Scalar componentDensity(int phaseIdx,
int compIdx,
@@ -114,8 +130,14 @@ public:
/*!
- * \brief Given all mole fractions in a phase, return the phase
- * density [kg/m^3].
+ * \brief Return the density of a phase [kg/m^3].
+ *
+ * \param phaseIdx index of the phase
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param phaseState The fluid state of the two-phase model
+ * \tparam FluidState the fluid state class of the two-phase model
+ * \return returns the density of the phase
*/
template <class FluidState>
static Scalar phaseDensity(int phaseIdx,
@@ -133,7 +155,14 @@ public:
}
/*!
- * \brief Return the viscosity of a phase.
+ * \brief Return the viscosity of a phase [Pa*s].
+ *
+ * \param phaseIdx index of the phase
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param phaseState The fluid state of the two-phase model
+ * \tparam FluidState the fluid state class of the two-phase model
+ * \return returns the viscosity of the phase [Pa*s]
*/
template <class FluidState>
static Scalar phaseViscosity(int phaseIdx,
@@ -151,8 +180,14 @@ public:
}
/*!
- * \brief Given all mole fractions in a phase, return the specific
- * phase enthalpy [J/kg].
+ * \brief Return the specific enthalpy of a phase [J/kg].
+ *
+ * \param phaseIdx index of the phase
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param phaseState The fluid state of the two-phase model
+ * \tparam FluidState the fluid state class of the two-phase model
+ * \return returns the specific enthalpy of the phase [J/kg]
*/
template <class FluidState>
static Scalar phaseEnthalpy(int phaseIdx,
@@ -170,8 +205,14 @@ public:
}
/*!
- * \brief Given all mole fractions in a phase, return the specific
- * internal energy of the phase [J/kg].
+ * \brief Return the specific internal energy of a phase [J/kg].
+ *
+ * \param phaseIdx index of the phase
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param phaseState The fluid state of the two-phase model
+ * \tparam FluidState the fluid state class of the two-phase model
+ * \return returns the specific internal energy of the phase [J/kg]
*/
template <class FluidState>
static Scalar phaseInternalEnergy(int phaseIdx,
diff --git a/dumux/material/fluidsystems/gasphase.hh b/dumux/material/fluidsystems/gasphase.hh
index c1e9f3bcb5..017dc5318d 100644
--- a/dumux/material/fluidsystems/gasphase.hh
+++ b/dumux/material/fluidsystems/gasphase.hh
@@ -28,7 +28,7 @@ template <class Scalar, class ComponentT> class GasPhase
public:
typedef ComponentT Component;
/*!
- * \brief A human readable name for the compoent.
+ * \brief A human readable name for the component.
*/
static const char *name()
{ return Component::name(); }
diff --git a/dumux/material/fluidsystems/h2o_n2_system.hh b/dumux/material/fluidsystems/h2o_n2_system.hh
index 5c9143ec7f..ef84c06a16 100644
--- a/dumux/material/fluidsystems/h2o_n2_system.hh
+++ b/dumux/material/fluidsystems/h2o_n2_system.hh
@@ -14,9 +14,15 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
- * \file
+ * \ingroup Material
+ * \defgroup Fluidsystems Fluidsystems
+ */
+/*!
+ * \file A compositional fluid with water and molecular nitrogen as
+ * components in both, the liquid and the gas phase.
*
- * \brief A fluid system with water and gas as phases and \f$H_2O\f$ and \f$N_2\f$
+ * \ingroup Fluidsystems
+ * \brief A fluid system with a water and a gas phase and \f$H_2O\f$ and \f$N_2\f$
* as components.
*/
#ifndef DUMUX_H2O_N2_SYSTEM_HH
@@ -40,6 +46,8 @@ NEW_PROP_TAG(Components);
};
/*!
+ * \ingroup Fluidsystems
+ *
* \brief A compositional fluid with water and molecular nitrogen as
* components in both, the liquid and the gas phase.
*/
@@ -75,6 +83,8 @@ public:
/*!
* \brief Return the human readable name of a phase
+ *
+ * \param phaseIdx index of the phase
*/
static const char *phaseName(int phaseIdx)
{
@@ -87,6 +97,8 @@ public:
/*!
* \brief Return the human readable name of a component
+ *
+ * \param compIdx index of the component
*/
static const char *componentName(int compIdx)
{
@@ -99,6 +111,8 @@ public:
/*!
* \brief Return the molar mass of a component [kg/mol].
+ *
+ * \param compIdx index of the component
*/
static Scalar molarMass(int compIdx)
{
@@ -113,6 +127,13 @@ public:
* \brief Given a phase's composition, temperature, pressure, and
* the partial pressures of all components, return its
* density [kg/m^3].
+ *
+ * \param phaseIdx index of the phase
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param fluidState the fluid state
+ *
+ * \tparam FluidState the fluid state class
*/
template <class FluidState>
static Scalar phaseDensity(int phaseIdx,
@@ -356,8 +377,9 @@ public:
/*!
* \brief Given a phase's composition, temperature and pressure,
- * return the binary diffusion coefficent for components
+ * return the binary diffusion coefficient for components
* \f$i\f$ and \f$j\f$ in this phase.
+ *
*/
template <class FluidState>
static Scalar diffCoeff(int phaseIdx,
diff --git a/dumux/material/fluidsystems/isfluid_trail_system.hh b/dumux/material/fluidsystems/isfluid_trail_system.hh
index d9ffb4acde..eba9637dcf 100644
--- a/dumux/material/fluidsystems/isfluid_trail_system.hh
+++ b/dumux/material/fluidsystems/isfluid_trail_system.hh
@@ -35,7 +35,15 @@ NEW_PROP_TAG(OnePTwoCIndices);
};
/*!
- * \brief A fluid system with one phase and an arbitrary number of components.
+ * \ingroup Fluidsystems
+ *
+ * \file A fluid system with one phase and two components representing an
+ * intersticial fluid that contains a medical trail.
+ *
+ *
+ * \brief A fluid system with one phase and two components representing an
+ * intersticial fluid that contains a medical trail. This is used for
+ * in the 1p2c model.
*/
template <class TypeTag, bool verbose=true>
class ISFluid_Trail_System
@@ -56,6 +64,7 @@ public:
/*!
* \brief Return the human readable name of a component
+ * \param compIdx the component index
*/
static const char *componentName(int compIdx)
{
@@ -72,6 +81,9 @@ public:
/*!
* \brief Return the molar mass of a component [kg/mol].
+ *
+ * \param compIdx the component index
+ *
*/
static Scalar molarMass(int compIdx)
{
@@ -87,8 +99,14 @@ public:
/*!
- * \brief Given all mole fractions in a phase, return the phase
- * density [kg/m^3].
+ * \brief Return the (constant) phase density [kg/m^3].
+ *
+ * \param phaseIdx index of the phase, only 0 is accepted (single-phase system)
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param fluidState the fluid state
+ *
+ * \tparam FluidState the fluid state class
*/
template <class FluidState>
static Scalar phaseDensity(int phaseIdx,
@@ -103,7 +121,14 @@ public:
}
/*!
- * \brief Return the dynamic viscosity of a phase.
+ * \brief Return the (constant) dynamic viscosity of a phase [Pa/s].
+ *
+ * \param phaseIdx index of the phase, only 0 is accepted (single-phase system)
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param fluidState the fluid state
+ *
+ * \tparam FluidState the fluid state class
*/
template <class FluidState>
static Scalar phaseViscosity(int phaseIdx,
@@ -118,8 +143,16 @@ public:
}
/*!
- * \brief Given all mole fractions, return the diffusion
- * coefficent of a component in a phase.
+ * \brief Return the (constant) binary diffusion coefficient [m^2/s].
+ *
+ * \param phaseIdx index of the phase, only 0 is accepted (single-phase system)
+ * \param compIIdx index of the first component in the binary mixture
+ * \param compJIdx index of second component in the binary mixture
+ * \param temperature phase temperature in [K]
+ * \param pressure phase pressure in [Pa]
+ * \param fluidState the fluid state
+ *
+ * \tparam FluidState the fluid state class
*/
template <class FluidState>
static Scalar diffCoeff(int phaseIdx,
--
GitLab