From 31d9c4c7a5e439f446e609a660974e5687581457 Mon Sep 17 00:00:00 2001
From: Alexander Kissinger <alexander.kissinger@iws.uni-stuttgart.de>
Date: Thu, 13 Mar 2014 16:26:32 +0000
Subject: [PATCH] Updated the doxygen documentation of the 2p,2pni, co2ni,
2p2cni models and the 2p and 2pni tests according to FS#209. Also adjusted
the doxygen/modules file and replaced group TwoPBoxModel with TwoPModel.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12617 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/doxygen/modules | 2 +-
dumux/implicit/2p/2pindices.hh | 12 ++--
dumux/implicit/2p/2plocalresidual.hh | 24 ++++---
dumux/implicit/2p/2pmodel.hh | 4 +-
dumux/implicit/2p/2pproperties.hh | 2 +-
dumux/implicit/2p/2ppropertydefaults.hh | 9 ++-
dumux/implicit/2p/2pvolumevariables.hh | 22 ++++---
.../implicit/2p2cni/2p2cnipropertydefaults.hh | 2 +-
.../implicit/2p2cni/2p2cnivolumevariables.hh | 4 +-
dumux/implicit/2pni/2pnifluxvariables.hh | 19 +++---
dumux/implicit/2pni/2pniindices.hh | 6 +-
dumux/implicit/2pni/2pnilocalresidual.hh | 3 +-
dumux/implicit/2pni/2pnimodel.hh | 6 +-
dumux/implicit/2pni/2pniproperties.hh | 2 +-
dumux/implicit/2pni/2pnipropertydefaults.hh | 8 +--
dumux/implicit/2pni/2pnivolumevariables.hh | 4 +-
dumux/implicit/co2ni/co2nivolumevariables.hh | 4 +-
test/implicit/2p/lensproblem.hh | 51 +++++++--------
test/implicit/2p/lensspatialparams.hh | 31 ++++-----
test/implicit/2pni/injectionproblem2pni.hh | 64 +++++++++----------
20 files changed, 143 insertions(+), 136 deletions(-)
diff --git a/doc/doxygen/modules b/doc/doxygen/modules
index 186582d2aa..ec4868c8b6 100644
--- a/doc/doxygen/modules
+++ b/doc/doxygen/modules
@@ -119,7 +119,7 @@
*/
/*!
* \ingroup ImplicitModels
- * \defgroup TwoPBoxModel Two-phase
+ * \defgroup TwoPModel Two-phase
*
* \copydetails Dumux::TwoPModel
*/
diff --git a/dumux/implicit/2p/2pindices.hh b/dumux/implicit/2p/2pindices.hh
index 61f6496eea..a85e63837b 100644
--- a/dumux/implicit/2p/2pindices.hh
+++ b/dumux/implicit/2p/2pindices.hh
@@ -32,9 +32,9 @@ namespace Dumux
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitIndices
- * \brief Specificy whether a pw-sn or a pn-sw formulation is used.
+ * \brief Enumerates the formulations which the two-phase model accepts.
*/
struct TwoPFormulation
{
@@ -43,9 +43,11 @@ struct TwoPFormulation
};
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitIndices
- * \brief The common indices for the isothermal two-phase model.
+ * \brief Defines the indices required for the two-phase fully implicit model.
+ *
+ * \tparam TypeTag The problem type tag
*/
template <class TypeTag>
struct TwoPCommonIndices
@@ -87,7 +89,7 @@ struct TwoPIndices
};
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitIndices
* \brief The indices for the \f$p_n-S_w\f$ formulation of the
* isothermal two-phase model.
diff --git a/dumux/implicit/2p/2plocalresidual.hh b/dumux/implicit/2p/2plocalresidual.hh
index 7eab2394d7..9382cdceb1 100644
--- a/dumux/implicit/2p/2plocalresidual.hh
+++ b/dumux/implicit/2p/2plocalresidual.hh
@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase fully implicit model.
@@ -61,7 +61,9 @@ protected:
public:
/*!
- * \brief Constructor. Sets the upwind weight.
+ * \brief Constructor
+ *
+ * Sets the upwind weight.
*/
TwoPLocalResidual()
{
@@ -73,11 +75,14 @@ public:
/*!
* \brief Evaluate the amount of all conservation quantities
- * (e.g. phase mass) within a finite sub-control volume.
+ * (e.g. phase mass) within a sub-control volume.
*
* \param storage The phase mass within the sub-control volume
* \param scvIdx The SCV (sub-control-volume) index
* \param usePrevSol Evaluate function with solution of current or previous time step
+ *
+ * The result should be averaged over the volume (e.g. phase mass
+ * inside a sub-control volume divided by the volume)
*/
void computeStorage(PrimaryVariables &storage, int scvIdx, bool usePrevSol) const
{
@@ -99,13 +104,12 @@ public:
}
/*!
- * \brief Evaluates the mass flux over a face of a sub-control
- * volume.
+ * \brief Evaluates the total flux of all conservation quantities
+ * over a face of a sub-control volume.
*
- * \param flux The flux over the SCV (sub-control-volume) face for each phase
- * \param faceIdx The index of the SCV face
- * \param onBoundary A boolean variable to specify whether the flux variables
- * are calculated for interior SCV faces or boundary faces, default=false
+ * \param flux The flux over the sub-control-volume face for each component
+ * \param faceIdx The index of the sub-control-volume face
+ * \param onBoundary Evaluate flux at inner sub-control-volume face or on a boundary face
*/
void computeFlux(PrimaryVariables &flux, int faceIdx, const bool onBoundary=false) const
{
@@ -156,7 +160,7 @@ public:
* the face of a sub-control volume.
*
* \param flux The diffusive flux over the sub-control-volume face for each phase
- * \param fluxVars The flux variables at the current SCV
+ * \param fluxVars The flux variables at the current sub-control-volume
*
* It doesn't do anything in two-phase model but is used by the
* non-isothermal two-phase models to calculate diffusive heat
diff --git a/dumux/implicit/2p/2pmodel.hh b/dumux/implicit/2p/2pmodel.hh
index 5d349b4b01..ed79bd4af0 100644
--- a/dumux/implicit/2p/2pmodel.hh
+++ b/dumux/implicit/2p/2pmodel.hh
@@ -33,8 +33,8 @@ namespace Dumux
{
/*!
- * \ingroup TwoPBoxModel
- * \brief A two-phase, isothermal flow model using the fully implicit scheme.
+ * \ingroup TwoPModel
+ * \brief Adaption of the fully implicit scheme to the two-phase flow model.
*
* This model implements two-phase flow of two immiscible fluids
* \f$\alpha \in \{ w, n \}\f$ using a standard multiphase Darcy
diff --git a/dumux/implicit/2p/2pproperties.hh b/dumux/implicit/2p/2pproperties.hh
index 0e29f942dc..ce26f72f85 100644
--- a/dumux/implicit/2p/2pproperties.hh
+++ b/dumux/implicit/2p/2pproperties.hh
@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
*/
/*!
* \file
diff --git a/dumux/implicit/2p/2ppropertydefaults.hh b/dumux/implicit/2p/2ppropertydefaults.hh
index 8a38092047..d7024bffda 100644
--- a/dumux/implicit/2p/2ppropertydefaults.hh
+++ b/dumux/implicit/2p/2ppropertydefaults.hh
@@ -17,7 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitProperties
* \ingroup Properties
* \file
@@ -49,8 +49,11 @@ namespace Properties
//////////////////////////////////////////////////////////////////
// Property defaults
//////////////////////////////////////////////////////////////////
-SET_INT_PROP(TwoP, NumEq, 2); //!< set the number of equations to 2
-SET_INT_PROP(TwoP, NumPhases, 2); //!< The number of phases in the 2p model is 2
+//! Set the number of equations to 2
+SET_INT_PROP(TwoP, NumEq, 2);
+
+//! The number of phases in the 2p model is 2
+SET_INT_PROP(TwoP, NumPhases, 2);
//! Set the default formulation to pWsN
SET_INT_PROP(TwoP,
diff --git a/dumux/implicit/2p/2pvolumevariables.hh b/dumux/implicit/2p/2pvolumevariables.hh
index b783f6406f..deadd6be55 100644
--- a/dumux/implicit/2p/2pvolumevariables.hh
+++ b/dumux/implicit/2p/2pvolumevariables.hh
@@ -34,7 +34,7 @@
namespace Dumux
{
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the two-phase model.
@@ -167,14 +167,14 @@ public:
}
/*!
- * \brief Returns the phase state for the control-volume.
+ * \brief Returns the phase state for the control volume.
*/
const FluidState &fluidState() const
{ return fluidState_; }
/*!
- * \brief Returns the effective saturation of a given phase within
- * the control volume.
+ * \brief Returns the saturation of a given phase within
+ * the control volume in \f$[-]\f$.
*
* \param phaseIdx The phase index
*/
@@ -183,7 +183,7 @@ public:
/*!
* \brief Returns the mass density of a given phase within the
- * control volume.
+ * control volume in \f$[kg/m^3]\f$.
*
* \param phaseIdx The phase index
*/
@@ -192,7 +192,7 @@ public:
/*!
* \brief Returns the effective pressure of a given phase within
- * the control volume.
+ * the control volume in \f$[kg/(m*s^2)=N/m^2=Pa]\f$.
*
* \param phaseIdx The phase index
*/
@@ -200,13 +200,15 @@ public:
{ return fluidState_.pressure(phaseIdx); }
/*!
- * \brief Returns the capillary pressure within the control volume [Pa].
+ * \brief Returns the capillary pressure within the control volume
+ * in \f$[kg/(m*s^2)=N/m^2=Pa]\f$.
*/
Scalar capillaryPressure() const
{ return fluidState_.pressure(nPhaseIdx) - fluidState_.pressure(wPhaseIdx); }
/*!
- * \brief Returns temperature inside the sub-control volume.
+ * \brief Returns temperature inside the sub-control volume
+ * in \f$[K]\f$.
*
* Note that we assume thermodynamic equilibrium, i.e. the
* temperature of the rock matrix and of all fluid phases are
@@ -217,7 +219,7 @@ public:
/*!
* \brief Returns the effective mobility of a given phase within
- * the control volume.
+ * the control volume in \f$[s*m/kg]\f$.
*
* \param phaseIdx The phase index
*/
@@ -225,7 +227,7 @@ public:
{ return mobility_[phaseIdx]; }
/*!
- * \brief Returns the average porosity within the control volume.
+ * \brief Returns the average porosity within the control volume in \f$[-]\f$.
*/
Scalar porosity() const
{ return porosity_; }
diff --git a/dumux/implicit/2p2cni/2p2cnipropertydefaults.hh b/dumux/implicit/2p2cni/2p2cnipropertydefaults.hh
index 6bd415e8d6..6b3359270b 100644
--- a/dumux/implicit/2p2cni/2p2cnipropertydefaults.hh
+++ b/dumux/implicit/2p2cni/2p2cnipropertydefaults.hh
@@ -46,7 +46,7 @@ namespace Properties
//////////////////////////////////////////////////////////////////
// Property values
//////////////////////////////////////////////////////////////////
-
+//! Set the number of equations to 3
SET_INT_PROP(TwoPTwoCNI, NumEq, 3); //!< set the number of equations to 3
//! Use the 2p2cni local jacobian operator for the 2p2cni model
diff --git a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
index 457ae863d7..b3cf39e589 100644
--- a/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
+++ b/dumux/implicit/2p2cni/2p2cnivolumevariables.hh
@@ -61,7 +61,7 @@ class TwoPTwoCNIVolumeVariables : public TwoPTwoCVolumeVariables<TypeTag>
public:
/*!
* \brief Returns the total internal energy of a phase in the
- * sub-control volume.
+ * sub-control volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*/
@@ -70,7 +70,7 @@ public:
/*!
* \brief Returns the total enthalpy of a phase in the sub-control
- * volume.
+ * volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*/
diff --git a/dumux/implicit/2pni/2pnifluxvariables.hh b/dumux/implicit/2pni/2pnifluxvariables.hh
index 5bebb91dfd..fc6513da71 100644
--- a/dumux/implicit/2pni/2pnifluxvariables.hh
+++ b/dumux/implicit/2pni/2pnifluxvariables.hh
@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \file
- * \brief This file contains the data which is required to calculate
- * all fluxes (mass and energy) of all phases over a face of a finite volume.
+ * \brief This file contains data which is required to calculate
+ * the heat fluxes over a face of a finite volume for the non-isothermal
+ * two-phase model.
*
* This means pressure and temperature gradients, phase densities at
* the integration point, etc.
@@ -38,12 +39,9 @@ namespace Dumux
/*!
* \ingroup TwoPNIModel
* \ingroup ImplicitFluxVariables
- * \brief This template class contains the data which is required to
- * calculate all fluxes (mass and energy) of all phases over a
- * face of a finite volume for the non-isothermal two-phase model.
- *
- * This means pressure and concentration gradients, phase densities at
- * the integration point, etc.
+ * \brief This file contains data which is required to calculate
+ * the heat fluxes over a face of a finite volume for the non-isothermal
+ * two-phase model.
*/
template <class TypeTag>
class TwoPNIFluxVariables : public ImplicitDarcyFluxVariables<TypeTag>
@@ -71,7 +69,7 @@ class TwoPNIFluxVariables : public ImplicitDarcyFluxVariables<TypeTag>
public:
- /*
+ /*!
* \brief The constructor
*
* \param problem The problem
@@ -79,8 +77,7 @@ public:
* \param fvGeometry The finite-volume geometry in the fully implicit scheme
* \param faceIdx The local index of the SCV (sub-control-volume) face
* \param elemVolVars The volume variables of the current element
- * \param onBoundary A boolean variable to specify whether the flux variables
- * are calculated for interior SCV faces or boundary faces, default=false
+ * \param onBoundary Distinguishes if we are on a sub-control-volume face or on a boundary face
*/
TwoPNIFluxVariables(const Problem &problem,
diff --git a/dumux/implicit/2pni/2pniindices.hh b/dumux/implicit/2pni/2pniindices.hh
index ed4d472626..92c36752da 100644
--- a/dumux/implicit/2pni/2pniindices.hh
+++ b/dumux/implicit/2pni/2pniindices.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \brief Defines the indices used by the non-isotherm two-phase fully implicit model.
+ * \brief Defines the indices used by the non-isothermal two-phase fully implicit model.
*/
#ifndef DUMUX_2PNI_INDICES_HH
#define DUMUX_2PNI_INDICES_HH
@@ -32,7 +32,9 @@ namespace Dumux
/*!
* \ingroup TwoPNIModel
* \ingroup ImplicitIndices
- * \brief Enumerations for the non-isothermal two-phase model
+ * \brief Defines the indices used by the non-isothermal two-phase fully implicit model.
+ *
+ * \tparam PVOffset The first index in a primary variable vector.
*/
template <class TypeTag, int PVOffset = 0>
class TwoPNIIndices : public TwoPIndices<TypeTag, PVOffset>
diff --git a/dumux/implicit/2pni/2pnilocalresidual.hh b/dumux/implicit/2pni/2pnilocalresidual.hh
index 5a5b974d7a..705fbd1caa 100644
--- a/dumux/implicit/2pni/2pnilocalresidual.hh
+++ b/dumux/implicit/2pni/2pnilocalresidual.hh
@@ -79,7 +79,7 @@ public:
* inside a sub control volume divided by the volume)
*
* \param storage The phase mass within the sub-control volume
- * \param scvIdx The SCV (sub-control-volume) index
+ * \param scvIdx The sub-control volume index
* \param usePrevSol Evaluate function with solution of current or previous time step
*/
void computeStorage(PrimaryVariables &storage, int scvIdx, bool usePrevSol) const
@@ -153,6 +153,7 @@ public:
* \param flux The diffusive flux over the sub-control-volume face for each phase
* \param fluxVars The flux variables at the current SCV
*
+ * This method is called by compute flux (base class).
*/
void computeDiffusiveFlux(PrimaryVariables &flux,
const FluxVariables &fluxVars) const
diff --git a/dumux/implicit/2pni/2pnimodel.hh b/dumux/implicit/2pni/2pnimodel.hh
index 51ec8dcb8c..f2ef063a21 100644
--- a/dumux/implicit/2pni/2pnimodel.hh
+++ b/dumux/implicit/2pni/2pnimodel.hh
@@ -19,7 +19,7 @@
/*!
* \file
*
- * \brief Adaption of the fully implicit scheme to the non-isothermal twophase flow model.
+ * \brief Adaption of the fully implicit scheme to the non-isothermal two-phase flow model.
*/
#ifndef DUMUX_2PNI_MODEL_HH
#define DUMUX_2PNI_MODEL_HH
@@ -30,8 +30,8 @@
namespace Dumux {
/*!
- * \ingroup TwoPNIBoxModel
- * \brief A two-phase, non-isothermal flow model using the fully implicit scheme.
+ * \ingroup TwoPNIModel
+ * \brief Adaption of the fully implicit scheme to the non-isothermal two-phase flow model.
*
* This model implements a non-isothermal two-phase flow for two
* immiscible fluids \f$\alpha \in \{ w, n \}\f$. Using the standard
diff --git a/dumux/implicit/2pni/2pniproperties.hh b/dumux/implicit/2pni/2pniproperties.hh
index f9dda91131..db1cde97b9 100644
--- a/dumux/implicit/2pni/2pniproperties.hh
+++ b/dumux/implicit/2pni/2pniproperties.hh
@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
- * \ingroup TwoPNIBoxModel
+ * \ingroup TwoPNIModel
* \file
*
* \brief Defines the properties required for the non-isotherm two-phase fully implicit model.
diff --git a/dumux/implicit/2pni/2pnipropertydefaults.hh b/dumux/implicit/2pni/2pnipropertydefaults.hh
index 2c22762f27..ddcdac848c 100644
--- a/dumux/implicit/2pni/2pnipropertydefaults.hh
+++ b/dumux/implicit/2pni/2pnipropertydefaults.hh
@@ -19,11 +19,11 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
- * \ingroup TwoPNIBoxModel
+ * \ingroup TwoPNIModel
* \file
*
* \brief Defines the default values for most of the properties
- * required by the non-isotherm two-phase fully implicit model.
+ * required by the non-isothermal two-phase fully implicit model.
*/
#ifndef DUMUX_2PNI_PROPERTY_DEFAULTS_HH
@@ -47,8 +47,8 @@ namespace Properties
//////////////////////////////////////////////////////////////////
// Property values
//////////////////////////////////////////////////////////////////
-
-SET_INT_PROP(TwoPNI, NumEq, 3); //!< set the number of equations to 3
+//! Set the number of equations to 3
+SET_INT_PROP(TwoPNI, NumEq, 3);
//! Use the 2pni local jacobian operator for the 2pni model
SET_TYPE_PROP(TwoPNI,
diff --git a/dumux/implicit/2pni/2pnivolumevariables.hh b/dumux/implicit/2pni/2pnivolumevariables.hh
index 5a48621893..c890811c40 100644
--- a/dumux/implicit/2pni/2pnivolumevariables.hh
+++ b/dumux/implicit/2pni/2pnivolumevariables.hh
@@ -55,7 +55,7 @@ class TwoPNIVolumeVariables : public TwoPVolumeVariables<TypeTag>
public:
/*!
* \brief Returns the total internal energy of a phase in the
- * sub-control volume.
+ * sub-control volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*
@@ -65,7 +65,7 @@ public:
/*!
* \brief Returns the total enthalpy of a phase in the sub-control
- * volume.
+ * volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*/
diff --git a/dumux/implicit/co2ni/co2nivolumevariables.hh b/dumux/implicit/co2ni/co2nivolumevariables.hh
index ae0679b8d9..e15567efef 100644
--- a/dumux/implicit/co2ni/co2nivolumevariables.hh
+++ b/dumux/implicit/co2ni/co2nivolumevariables.hh
@@ -61,7 +61,7 @@ class CO2NIVolumeVariables : public CO2VolumeVariables<TypeTag>
public:
/*!
* \brief Returns the total internal energy of a phase in the
- * sub-control volume.
+ * sub-control volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*/
@@ -70,7 +70,7 @@ public:
/*!
* \brief Returns the total enthalpy of a phase in the control
- * volume.
+ * volume in \f$\mathrm{[J/kg]}\f$.
*
* \param phaseIdx The phase index
*/
diff --git a/test/implicit/2p/lensproblem.hh b/test/implicit/2p/lensproblem.hh
index cfa311568d..d36f1a9912 100644
--- a/test/implicit/2p/lensproblem.hh
+++ b/test/implicit/2p/lensproblem.hh
@@ -120,7 +120,7 @@ SET_TYPE_PROP(LensCCProblem, BaseProblem, ImplicitPorousMediaProblem<TypeTag>);
}
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitTestProblems
* \brief Soil contamination problem where DNAPL infiltrates a fully
* water saturated medium.
@@ -145,7 +145,7 @@ SET_TYPE_PROP(LensCCProblem, BaseProblem, ImplicitPorousMediaProblem<TypeTag>);
* just the hydrostatic pressure. The DNAPL saturation on both sides
* is zero.
*
- * This problem uses the \ref TwoPBoxModel.
+ * This problem uses the \ref TwoPModel.
*
* This problem should typically be simulated until \f$t_{\text{end}}
* \approx 20\,000\;s\f$ is reached. A good choice for the initial time step
@@ -218,7 +218,7 @@ public:
// \{
/*!
- * \brief The problem name.
+ * \brief Returns the problem name
*
* This is used as a prefix for files generated by the simulation.
*/
@@ -228,7 +228,9 @@ public:
}
/*!
- * \brief Called directly after the time integration.
+ * \brief User defined output after the time integration
+ *
+ * Will be called diretly after the time integration.
*/
void postTimeStep()
{
@@ -243,18 +245,19 @@ public:
}
/*!
- * \brief Returns the temperature within the domain.
+ * \brief Returns the temperature \f$ K \f$
*
- * This problem assumes a uniform temperature of 10 degrees Celsius.
+ * This problem assumes a uniform temperature of 20 degrees Celsius.
*/
Scalar temperature() const
{ return temperature_; };
/*!
- * \brief Returns the source term at specific position in the domain.
+ * \brief Returns the source term
*
- * \param values The source values for the primary variables
- * \param globalPos The position
+ * \param values Stores the source values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variable} / (m^\textrm{dim} \cdot s )] \f$
+ * \param globalPos The global position
*/
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
@@ -271,10 +274,10 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
- * used for which equation on a given boundary control volume.
+ * used for which equation on a given boundary segment
*
- * \param values The boundary types for the conservation equations
- * \param globalPos The position of the center of the finite volume
+ * \param values Stores the value of the boundary type
+ * \param globalPos The global position
*/
void boundaryTypesAtPos(BoundaryTypes &values,
const GlobalPosition &globalPos) const
@@ -288,13 +291,12 @@ public:
}
/*!
- * \brief Evaluate the boundary conditions for a dirichlet
- * control volume.
- *
- * \param values The dirichlet values for the primary variables
- * \param globalPos The center of the finite volume which ought to be set.
+ * \brief Evaluates the boundary conditions for a Dirichlet
+ * boundary segment
*
- * For this method, the \a values parameter stores primary variables.
+ * \param values Stores the Dirichlet values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variable} ] \f$
+ * \param globalPos The global position
*/
void dirichletAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
@@ -321,7 +323,8 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values The neumann values for the conservation equations [kg / (m^2 *s )]
+ * \param values Stores the Neumann values for the conservation equations in
+ * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param globalPos The position of the integration point of the boundary segment.
*
* For this method, the \a values parameter stores the mass flux
@@ -344,13 +347,11 @@ public:
/*!
- * \brief Evaluate the initial value for a control volume.
- *
- * \param values The initial values for the primary variables
- * \param globalPos The center of the finite volume which ought to be set.
+ * \brief Evaluates the initial values for a control volume
*
- * For this method, the \a values parameter stores primary
- * variables.
+ * \param values Stores the initial values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variables} ] \f$
+ * \param globalPos The global position
*/
void initialAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
diff --git a/test/implicit/2p/lensspatialparams.hh b/test/implicit/2p/lensspatialparams.hh
index 97b479a9b7..718ea6ac83 100644
--- a/test/implicit/2p/lensspatialparams.hh
+++ b/test/implicit/2p/lensspatialparams.hh
@@ -61,10 +61,10 @@ public:
};
}
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitTestProblems
* \brief The spatial parameters for the LensProblem which uses the
- * twophase box model
+ * two-phase fully implicit model
*/
template<class TypeTag>
class LensSpatialParams : public ImplicitSpatialParams<TypeTag>
@@ -139,12 +139,11 @@ public:
}
/*!
- * \brief Intrinsic permability
+ * \brief Returns the scalar intrinsic permeability \f$[m^2]\f$
*
- * \param element The current element
- * \param fvGeometry The current finite volume geometry of the element
- * \param scvIdx The index of the sub-control volume
- * \return Intrinsic permeability
+ * \param element The finite element
+ * \param fvGeometry The finite volume geometry of the element
+ * \param scvIdx The local index of the sub-control volume
*/
Scalar intrinsicPermeability(const Element &element,
const FVElementGeometry &fvGeometry,
@@ -158,12 +157,11 @@ public:
}
/*!
- * \brief Porosity
+ * \brief Returns the porosity \f$[-]\f$
*
- * \param element The current element
- * \param fvGeometry The current finite volume geometry of the element
- * \param scvIdx The index of the sub-control volume
- * \return Porosity
+ * \param element The finite element
+ * \param fvGeometry The finite volume geometry of the element
+ * \param scvIdx The local index of the sub-control volume
*/
Scalar porosity(const Element &element,
const FVElementGeometry &fvGeometry,
@@ -171,12 +169,11 @@ public:
{ return 0.4; }
/*!
- * \brief Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.).
+ * \brief Returns the parameter object for the Brooks-Corey material law
*
- * \param element The current element
- * \param fvGeometry The current finite volume geometry of the element
- * \param scvIdx The index of the sub-control volume
- * \return the material parameters object
+ * \param element The finite element
+ * \param fvGeometry The finite volume geometry of the element
+ * \param scvIdx The local index of the sub-control volume
*/
const MaterialLawParams& materialLawParams(const Element &element,
const FVElementGeometry &fvGeometry,
diff --git a/test/implicit/2pni/injectionproblem2pni.hh b/test/implicit/2pni/injectionproblem2pni.hh
index 664429851c..9bf2e427ba 100644
--- a/test/implicit/2pni/injectionproblem2pni.hh
+++ b/test/implicit/2pni/injectionproblem2pni.hh
@@ -19,7 +19,7 @@
/*!
* \file
*
- * \brief Nonisothermal gas injection problem where a gas (e.g. air) is injected into a fully
+ * \brief Non-isothermal gas injection problem where a gas (e.g. air) is injected into a fully
* water saturated medium. During buoyancy driven upward migration the gas
* passes a high temperature area.
*/
@@ -121,7 +121,7 @@ SET_BOOL_PROP(InjectionProblem2PNI, NewtonWriteConvergence, true);
/*!
* \ingroup TwoPNIModel
* \ingroup ImplicitTestProblems
- * \brief Nonisothermal gas injection problem where a gas (e.g. air) is injected into a fully
+ * \brief Non-isothermal gas injection problem where a gas (e.g. air) is injected into a fully
* water saturated medium. During buoyancy driven upward migration the gas
* passes a high temperature area.
*
@@ -219,7 +219,7 @@ public:
// \{
/*!
- * \brief The problem name.
+ * \brief Returns the problem name
*
* This is used as a prefix for files generated by the simulation.
*/
@@ -228,22 +228,22 @@ public:
#if ISOTHERMAL
/*!
- * \brief Returns the temperature within the domain.
- *
- * \param element The element
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The local vertex index (SCV index)
- *
- * This problem assumes a temperature of 10 degrees Celsius.
+ * \brief Returns the temperature \f$ K \f$
*/
- Scalar temperature(const Element &element,
- const FVElementGeometry &fvGeometry,
- int scvIdx) const
+ Scalar temperature() const
{
return 273.15 + 30; // [K]
};
#endif
+
+ /*!
+ * \brief Returns the source term
+ *
+ * \param values Stores the source values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variable} / (m^\textrm{dim} \cdot s )] \f$
+ * \param globalPos The global position
+ */
void sourceAtPos(PrimaryVariables &values,
const GlobalPosition &globalPos) const
{
@@ -259,10 +259,10 @@ public:
/*!
* \brief Specifies which kind of boundary condition should be
- * used for which equation on a given boundary segment.
+ * used for which equation on a given boundary segment
*
- * \param values The boundary types for the conservation equations
- * \param globalPos The position for which the bc type should be evaluated
+ * \param values Stores the value of the boundary type
+ * \param globalPos The global position
*/
void boundaryTypesAtPos(BoundaryTypes &values,
const GlobalPosition &globalPos) const
@@ -280,13 +280,12 @@ public:
}
/*!
- * \brief Evaluate the boundary conditions for a dirichlet
- * boundary segment.
+ * \brief Evaluates the boundary conditions for a Dirichlet
+ * boundary segment
*
- * \param values The dirichlet values for the primary variables
- * \param globalPos The position for which the bc type should be evaluated
- *
- * For this method, the \a values parameter stores primary variables.
+ * \param values Stores the Dirichlet values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variable} ] \f$
+ * \param globalPos The global position
*/
void dirichletAtPos(PrimaryVariables &values, const GlobalPosition &globalPos) const
{
@@ -302,15 +301,16 @@ public:
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
*
- * \param values The neumann values for the conservation equations
+ * \param values Stores the Neumann values for the conservation equations in
+ * \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
* \param element The finite element
- * \param fvGeometry The finite-volume geometry in the box scheme
+ * \param fvGeometry The finite volume geometry of the element
* \param intersection The intersection between element and boundary
- * \param scvIdx The local vertex index
+ * \param scvIdx The local index of the sub-control volume
* \param boundaryFaceIdx The index of the boundary face
*
- * For this method, the \a values parameter stores the mass flux
- * in normal direction of each phase. Negative values mean influx.
+ * The \a values store the mass flux of each phase normal to the boundary.
+ * Negative values indicate an inflow.
*/
void neumann(PrimaryVariables &values,
const Element &element,
@@ -342,13 +342,11 @@ public:
// \{
/*!
- * \brief Evaluate the initial value for a control volume.
- *
- * \param values The initial values for the primary variables
- * \param globalPos The position for which the initial condition should be evaluated
+ * \brief Evaluates the initial values for a control volume
*
- * For this method, the \a values parameter stores primary
- * variables.
+ * \param values Stores the initial values for the conservation equations in
+ * \f$ [ \textnormal{unit of primary variables} ] \f$
+ * \param globalPos The global position
*/
void initialAtPos(PrimaryVariables &values, const GlobalPosition &globalPos) const
{
--
GitLab