Commit 820573e3 authored by Kilian Weishaupt's avatar Kilian Weishaupt
Browse files

[2p1c][doxygen] Improve docu

*Fix errors
*Add .bib entry for citation
parent 72f91921
......@@ -54,6 +54,12 @@
* # Saturation
* \copydetails Dumux::FVSaturation2P
*/
/*!
* \ingroup Porousmediaflow
* \defgroup TwoPOneCModel 2p1c (two-phase, one-component Darcy flow)
*
* \copydetails Dumux::TwoPOneCModel
*/
/*!
* \ingroup Porousmediaflow
* \defgroup TwoPTwoCModels 2p2c (two-phase, two-component Darcy flow)
......
......@@ -608,6 +608,18 @@
edition = {1}
}
@article{gudbjerg2004,
title = {{On spurious water flow during numerical simulation of steam injection into water-saturated soil}},
author = {{J. Gudbjerg and O. Trötschler and A. Färber and T.O. Sonnenborg and K.H. Jensen}},
journal = {{Journal of Contaminant Hydrology}},
volume = {75},
number = {3–4},
pages = {297 - 318},
year = {2004},
doi = {http://dx.doi.org/10.1016/j.jconhyd.2004.07.003},
url = {http://www.sciencedirect.com/science/article/pii/S0169772204001160}
}
@INPROCEEDINGS{A3:freiboth:2004,
author = {S. H\"olzemann and H. Class and R. Helmig},
title = {{A New Concept for the Numerical Simulation and Parameter Identification
......
......@@ -19,7 +19,7 @@
/*!
* \file
*
* \brief A two-phase fluid system with only one component.
* \brief @copybrief Dumux::FluidSystems::TwoPLiquidVaporFluidsystem
*/
#ifndef DUMUX_2P_LIQUID_VAPOR_FLUID_SYSTEM_HH
#define DUMUX_2P_LIQUID_VAPOR_FLUID_SYSTEM_HHH
......@@ -561,9 +561,9 @@ NEW_PROP_TAG(Scalar);
NEW_PROP_TAG(Components);
}
/*!
* \brief A two-phase fluid system with water as the only component.
* \brief A two-phase fluid system with only one component.
*
* This is an adapter to use Dumux::H2ON2FluidSystem<TypeTag>, as is
* This is an adapter to use Dumux::TwoPLiquidVaporFluidsystem<TypeTag>, as is
* done with most other classes in Dumux.
*/
template<class TypeTag>
......
......@@ -31,7 +31,7 @@ namespace Dumux
{
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
* \ingroup ImplicitIndices
* \brief The indices for the isothermal 2p1cni model.
*
......
......@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
* \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase one-component fully implicit model.
......@@ -207,7 +207,7 @@ public:
protected:
/*!
* \brief Calculate the blocking factor which prevents spurious cold water fluxes into the steam zone (Gudbjerg et al., 2005) \cite gudbjerg <BR>
* \brief Calculate the blocking factor which prevents spurious cold water fluxes into the steam zone (Gudbjerg et al., 2005) \cite gudbjerg2004 <BR>
*
* \param up The upstream volume variables
* \param dn The downstream volume variables
......
......@@ -21,10 +21,6 @@
*
* \brief Adaption of the fully implicit scheme to the two-phase one-component flow model.
*
* Important note: The 2p1c model requires the use of the non-isothermal extension found in dumux/implicit/nonisothermal
*
* The model is designed for simulating two fluid phases with water as the only component.
* This model is particularly suitable for the simulation of steam injection in saturated conditions.
*/
#ifndef DUMUX_2P1C_MODEL_HH
#define DUMUX_2P1C_MODEL_HH
......@@ -35,10 +31,15 @@
namespace Dumux
{
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
* \brief Adaption of the fully implicit scheme to the two-phase one-component flow model.
*
* This model implements the flow of two phases and one component, i.e. a pure liquid (e.g. water)
* \note The 2p1c model requires the use of the non-isothermal extension found in dumux/implicit/nonisothermal.
*
* This model is designed for simulating two fluid phases with water as the only component.
* It is particularly suitable for the simulation of steam injection in saturated conditions.
*
* The model implements the flow of two phases and one component, i.e. a pure liquid (e.g. water)
* and its vapor (e.g. steam),
* \f$\alpha \in \{ w, n \}\f$ using a standard multiphase Darcy
* approach as the equation for the conservation of momentum, i.e.
......@@ -62,7 +63,7 @@ namespace Dumux
* p_n - p_w\f$ and relative permeability \f$k_{r\alpha}\f$ and taking
* advantage of the fact that \f$S_w + S_n = 1\f$, the number of
* unknowns can be reduced to two. The model features a primary variable switch.
* If only one phase is present, \f$p_g\f$ and \fT\f$ are the primary variables.
* If only one phase is present, \f$p_g\f$ and \f$T\f$ are the primary variables.
* In the presence of two phases, \f$p_g\f$ and \f$S_w\f$ become the new primary variables.
*/
template<class TypeTag>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \brief A 2p1cni specific controller for the newton solver.
* \brief A 2p1c specific controller for the newton solver.
*
* This controller 'knows' what a 'physically meaningful' solution is
* which allows the newton method to abort quicker if the solution is
......@@ -34,7 +34,7 @@
namespace Dumux {
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
* \brief A 2p1cni specific controller for the newton solver.
*
* This controller 'knows' what a 'physically meaningful' solution is
......
......@@ -17,7 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
*/
/*!
* \file
......
......@@ -17,7 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
*/
/*!
* \file
......
......@@ -22,7 +22,7 @@
* \brief Contains the quantities which are constant within a
* finite volume in the two-phase, one-component model.
*
*Important note: The 2p1c model requires the use of the non-isothermal extension found in dumux/implicit/nonisothermal
* \note The 2p1c model requires the use of the non-isothermal extension found in dumux/implicit/nonisothermal
*/
#ifndef DUMUX_2P1C_VOLUME_VARIABLES_HH
#define DUMUX_2P1C_VOLUME_VARIABLES_HH
......@@ -35,7 +35,8 @@ namespace Dumux
{
/*!
* \ingroup TwoPOneCNIModel
* \ingroup TwoPOneCModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the two-phase, two-component model.
*/
......@@ -278,7 +279,7 @@ public:
Scalar porosity() const
{ return porosity_; }
/*!
/*!
* \brief Returns the vapor temperature (T_{vap}(p_g) of the fluid within the control volume.
*/
Scalar vaporTemperature() const
......
Supports Markdown
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