Commit 5be87d09 authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

[doxygen] Adjust documentation for 1p and 1p2c model.

Add units to comments, fix doxygen groups.
(reviewed by martins)


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12704 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent e80f0410
......@@ -101,15 +101,15 @@
*/
/*!
* \ingroup ImplicitModels
* \defgroup OnePBoxModel One-phase
* \defgroup OnePModel One-phase
*
* \copydetails Dumux::OnePBoxModel
* \copydetails Dumux::OnePModel
*/
/*!
* \ingroup ImplicitModels
* \defgroup OnePTwoCBoxModel One-phase Two-component
* \defgroup OnePTwoCModel One-phase Two-component
*
* \copydetails Dumux::OnePTwoCBoxModel
* \copydetails Dumux::OnePTwoCModel
*/
/*!
* \ingroup ImplicitModels
......
......@@ -28,7 +28,7 @@ namespace Dumux
// \{
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \ingroup ImplicitIndices
* \brief Indices for the one-phase model.
*/
......
......@@ -30,7 +30,7 @@
namespace Dumux
{
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the one-phase fully implicit model.
......
......@@ -33,7 +33,7 @@
namespace Dumux
{
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \brief A single-phase, isothermal flow model using the fully implicit scheme.
*
* Single-phase, isothermal flow model, which uses a standard Darcy approach as the
......
......@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \file
*
* \brief Defines the properties required for the one-phase fully implicit model.
......
......@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \file
*
* \brief Defines the properties required for the one-phase fully implicit model.
......
......@@ -33,7 +33,7 @@ namespace Dumux
{
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are constant within a
* finite volume in the one-phase model.
......@@ -143,7 +143,7 @@ public:
{ return fluidState_.viscosity(/*phaseIdx=*/0); }
/*!
* \brief Returns the mobility.
* \brief Returns the mobility \f$\mathrm{[1/(Pa s)]}\f$.
*
* This function enables the use of ImplicitDarcyFluxVariables
* with the 1p fully implicit model, ALTHOUGH the term mobility is
......
......@@ -37,7 +37,7 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitFluxVariables
* \brief This template class contains the data which is required to
* calculate the fluxes of the fluid phases over a face of a
......@@ -381,11 +381,11 @@ protected:
const Element& elementI = *fvGeometry_.neighbors[face().i];
FVElementGeometry fvGeometryI;
fvGeometryI.subContVol[0].global = elementI.geometry().center();
const Element& elementJ = *fvGeometry_.neighbors[face().j];
FVElementGeometry fvGeometryJ;
fvGeometryJ.subContVol[0].global = elementJ.geometry().center();
sp.meanK(K_,
sp.intrinsicPermeability(elementI, fvGeometryI, 0),
sp.intrinsicPermeability(elementJ, fvGeometryJ, 0));
......
......@@ -32,7 +32,7 @@ namespace Dumux
// \{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitIndices
* \brief The indices for the isothermal single-phase, two-component model.
*/
......
......@@ -32,7 +32,7 @@ namespace Dumux
{
/*!
*
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitLocalResidual
* \brief Calculate the local Jacobian for the single-phase,
* two-component model in the fully implicit scheme.
......
......@@ -34,7 +34,7 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \brief Adaption of the fully implicit scheme to the one-phase two-component flow model.
*
* This model implements a one-phase flow of a compressible fluid, that consists of two components,
......
......@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \file
*
* \brief Defines the properties required for the single-phase,
......@@ -62,8 +62,8 @@ NEW_PROP_TAG(FluidSystem); //!< Type of the multi-component relations
NEW_PROP_TAG(ImplicitMassUpwindWeight); //!< The default value of the upwind weight
NEW_PROP_TAG(ImplicitMobilityUpwindWeight); //!< Weight for the upwind mobility in the velocity calculation
NEW_PROP_TAG(ProblemEnableGravity); //!< Returns whether gravity is considered in the problem
NEW_PROP_TAG(UseMoles); //!Defines whether mole (true) or mass (false) fractions are used
NEW_PROP_TAG(Scaling); //!Defines Scaling of the model
NEW_PROP_TAG(UseMoles); //!< Defines whether mole (true) or mass (false) fractions are used
NEW_PROP_TAG(Scaling); //!< Defines Scaling of the model
NEW_PROP_TAG(SpatialParamsForchCoeff); //!< Property for the forchheimer coefficient
NEW_PROP_TAG(VtkAddVelocity); //!< Returns whether velocity vectors are written into the vtk output
}
......
......@@ -19,7 +19,7 @@
/*!
* \ingroup Properties
* \ingroup ImplicitProperties
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \file
*
* \brief Defines some default values for the properties of the the
......
......@@ -33,7 +33,7 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are constant within a
* finite volume in the single-phase, two-component model.
......
......@@ -106,7 +106,7 @@ SET_BOOL_PROP(OnePTestProblem, ProblemEnableGravity, true);
}
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
* \brief Test problem for the one-phase model:
* water is flowing from bottom to top through and around a low permeable lens.
......@@ -185,7 +185,7 @@ public:
}
/*!
* \brief Return the temperature within the domain.
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
*/
......
......@@ -31,7 +31,7 @@ namespace Dumux
{
/*!
* \ingroup OnePBoxModel
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
*
* \brief The spatial parameters class for the test problem using the
......@@ -86,7 +86,7 @@ public:
}
/*!
* \brief Return the intrinsic permeability for the current sub-control volume.
* \brief Return the intrinsic permeability for the current sub-control volume in [m^2].
*
* \param element The current finite element
* \param fvGeometry The current finite volume geometry of the element
......@@ -105,7 +105,7 @@ public:
return permeability_;
}
/*! \brief Define the porosity.
/*! \brief Define the porosity in [-].
*
* \param element The finite element
* \param fvGeometry The finite volume geometry
......
......@@ -90,7 +90,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, ProblemEnableGravity, false);
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitTestProblems
*
* \brief Definition of a problem, for the 1p2c problem:
......@@ -111,7 +111,7 @@ SET_BOOL_PROP(OnePTwoCOutflowProblem, ProblemEnableGravity, false);
* The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false in the
* problem file. Make sure that the according units are used in the problem setup. The default setting for useMoles is true.
*
* This problem uses the \ref OnePTwoCBoxModel model.
* This problem uses the \ref OnePTwoCModel model.
*
* To run the simulation execute the following line in shell:
* <tt>./test_box1p2c -parameterFile ./test_box1p2c.input</tt> or
......@@ -195,7 +195,7 @@ public:
}
/*!
* \brief Returns the temperature within the domain.
* \brief Returns the temperature within the domain [K].
*
* This problem assumes a temperature of 20 degrees Celsius.
*/
......@@ -227,7 +227,7 @@ public:
{
values.setAllNeumann();
}
// outflow condition for the transport equation at right boundary
if(globalPos[0] > this->bBoxMax()[0] - eps_)
values.setOutflow(transportEqIdx);
......
......@@ -34,7 +34,7 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup OnePTwoCModel
* \ingroup ImplicitTestProblems
*
* \brief Definition of the spatial parameters for the 1p2c
......
......@@ -252,7 +252,7 @@ public:
{ return name_; }
/*!
* \brief Returns the temperature \f$ K \f$
* \brief Returns the temperature [K]
*/
Scalar temperature() const
{ return temperature_; };
......
......@@ -122,7 +122,7 @@ SET_BOOL_PROP(HeterogeneousProblem, UseMoles, false);
* The model is able to use either mole or mass fractions. The property useMoles can be set to either true or false in the
* problem file. Make sure that the according units are used in the problem setup. The default setting for useMoles is false.
*
* This problem uses the \ref OnePTwoCBoxModel model.
* This problem uses the \ref OnePTwoCModel model.
*
* To run the simulation execute the following line in shell (works with the box and cell centered spatial discretization method):
* <tt>./test_ccco2 </tt> or <tt>./test_boxco2 </tt>
......
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