Commit af5b8e92 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

Worked further on the Doxygen modules. The structure seems quite ok now,

and the classes seem to be associated with the correct groups. 

Also improved documentation by getting rid of more than 250 Doxygen
warnings.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@6794 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 0e1baf94
......@@ -12,6 +12,14 @@
* \ingroup Common
* \defgroup Properties Property System
*/
/*!
* \ingroup Common
* \defgroup Parameter Parameters
*/
/*!
* \ingroup Common
* \defgroup Start Starting the Simulation
*/
/*!
* \ingroup Common
* \defgroup SimControl Time Manager
......@@ -24,6 +32,26 @@
* \ingroup Common
* \defgroup Linear Linear Solver Backends
*/
/*!
* \ingroup Common
* \defgroup BC Boundary Conditions
*/
/*!
* \ingroup Common
* \defgroup Valgrind Valgrind
*/
/*!
* \ingroup Common
* \defgroup Exception Exceptions
*/
/*!
* \ingroup Common
* \defgroup Spline Splines
*/
/*!
* \ingroup Common
* \defgroup Math Elementary Math Functions
*/
/****************** Material ******************/
/*!
......
......@@ -40,6 +40,7 @@ namespace Dumux
/*!
* \ingroup OnePBoxModel
* \ingroup BoxFluxVariables
* \brief This template class contains the data which is required to
* calculate the flux of the fluid over a face of a
* finite volume for the one-phase model.
......
......@@ -28,12 +28,11 @@
namespace Dumux
{
/*!
* \ingroup OnePBoxModel
*/
// \{
/*!
* \ingroup OnePBoxModel
* \ingroup BoxIndices
* \brief Indices for the one-phase model.
*/
struct OnePIndices
......
......@@ -37,6 +37,7 @@ namespace Dumux
{
/*!
* \ingroup OnePBoxModel
* \ingroup BoxLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the one-phase box model.
*/
......
......@@ -31,7 +31,8 @@
namespace Dumux
{
/*!
* \ingroup OnePProblems
* \ingroup OnePBoxModel
* \ingroup BoxBaseProblems
* \brief Base class for all problems which use the single-phase box model
*
*/
......
......@@ -19,6 +19,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Properties
* \ingroup BoxProperties
* \ingroup OnePBoxModel
* \file
*
* \brief Defines the properties required for the onephase BOX model.
......@@ -30,9 +33,6 @@
namespace Dumux
{
/*!
* \ingroup OnePBoxModel
*/
// \{
///////////////////////////////////////////////////////////////////////////
// properties for the isothermal single phase model
......
......@@ -19,6 +19,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Properties
* \ingroup BoxProperties
* \ingroup OnePBoxModel
* \file
*
* \brief Defines the properties required for the one-phase BOX model.
......@@ -36,9 +39,6 @@
namespace Dumux
{
/*!
* \ingroup OnePBoxModel
*/
// \{
///////////////////////////////////////////////////////////////////////////
......
......@@ -34,6 +34,7 @@ namespace Dumux
/*!
* \ingroup OnePBoxModel
* \ingroup BoxVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the one-phase model.
*/
......
......@@ -108,7 +108,7 @@ public:
/*!
* \brief Returns the molar fraction of a component in a fluid phase.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
* \param compIdx The index of the considered component
*/
Scalar moleFrac(int phaseIndex, int compIdx) const
......@@ -145,7 +145,7 @@ public:
* \brief Returns the total concentration of a phase \f$\mathrm{[mol/m^3]}\f$.
*
* This is equivalent to the sum of all component concentrations.
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
*/
Scalar phaseConcentration(int phaseIndex) const
{
......@@ -157,7 +157,7 @@ public:
/*!
* \brief Returns the concentration of a component in a phase \f$\mathrm{[mol/m^3]}\f$.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
* \param compIdx The index of the considered component
*/
Scalar concentration(int phaseIndex, int compIdx) const
......@@ -167,7 +167,7 @@ public:
/*!
* \brief Returns the mass fraction of a component in a phase.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
* \param compIdx The index of the considered component
*/
Scalar massFrac(int phaseIndex, int compIdx) const
......@@ -196,7 +196,7 @@ public:
/*!
* \brief Returns the density of a phase \f$\mathrm{[kg/m^3]}\f$.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
*
*/
Scalar density(int phaseIndex) const
......@@ -209,7 +209,7 @@ public:
/*!
* \brief Returns the molar density of a phase \f$\mathrm{[mole/m^3]}\f$.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
*
*/
Scalar molarDensity(int phaseIndex) const
......@@ -225,7 +225,7 @@ public:
* This is equivalent to the sum of all component molar masses
* weighted by their respective mole fraction.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
*/
Scalar meanMolarMass(int phaseIndex) const
{
......@@ -237,7 +237,7 @@ public:
/*!
* \brief Returns the pressure of a fluid phase \f$\mathrm{[Pa]}\f$.
*
* \param phaseIdx The index of the considered phase
* \param phaseIndex The index of the considered phase
*/
Scalar phasePressure(int phaseIndex) const
{
......
......@@ -28,7 +28,6 @@
* This means pressure and temperature gradients, phase densities at
* the integration point, etc.
*
* \ingroup OnePTwoCBoxModel
*/
#ifndef DUMUX_1P2C_FLUX_VARIABLES_HH
#define DUMUX_1P2C_FLUX_VARIABLES_HH
......@@ -41,6 +40,8 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup BoxFluxVariables
* \brief This template class contains the data which is required to
* calculate the fluxes of the fluid phases over a face of a
* finite volume for the one-phase, two-component model.
......
......@@ -31,12 +31,11 @@
namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
*/
// \{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup BoxIndices
* \brief The indices for the isothermal single-phase, two-component model.
*/
template <int PVOffset = 0>
......
......@@ -47,7 +47,7 @@ namespace Dumux
/*!
*
* \ingroup OnePTwoCBoxModel
*
* \ingroup BoxLocalResidual
* \brief Calculate the local Jacobian for the single-phase,
* two-component model in the BOX scheme.
*
......@@ -180,7 +180,7 @@ public:
* a face of a subcontrol volume.
*
* \param flux The advective flux over the sub-control-volume face for each component
* \param vars The flux variables at the current SCV
* \param fluxVars The flux variables at the current SCV
*/
void computeAdvectiveFlux(PrimaryVariables &flux, const FluxVariables &fluxVars) const
{
......@@ -237,7 +237,7 @@ public:
* a face of a subcontrol volume.
*
* \param flux The diffusive flux over the sub-control-volume face for each component
* \param vars The flux variables at the current SCV
* \param fluxVars The flux variables at the current SCV
*/
void computeDiffusiveFlux(PrimaryVariables &flux, const FluxVariables &fluxVars) const
{
......
......@@ -33,7 +33,8 @@
namespace Dumux
{
/*!
* \ingroup OnePTwoCProblems
* \ingroup OnePTwoCBoxModel
* \ingroup BoxBaseProblems
* \brief Base class for all problems which use the single-phase, two-component box model
*
*/
......
......@@ -20,6 +20,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Properties
* \ingroup BoxProperties
* \ingroup OnePTwoCBoxModel
* \file
*
* \brief Defines the properties required for the single-phase,
......@@ -34,9 +37,6 @@
namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
*/
// \{
namespace Properties
{
......
......@@ -20,6 +20,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \ingroup Properties
* \ingroup BoxProperties
* \ingroup OnePTwoCBoxModel
* \file
*
* \brief Defines some default values for the properties of the the
......@@ -40,9 +43,6 @@
namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
*/
// \{
namespace Properties
{
......
......@@ -21,8 +21,6 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTwoCBoxModel
* \brief Quantities required by the single-phase, two-component box
* model defined on a vertex.
*/
......@@ -37,6 +35,8 @@ namespace Dumux
{
/*!
* \ingroup OnePTwoCBoxModel
* \ingroup BoxVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the single-phase, two-component model.
*/
......
......@@ -40,6 +40,7 @@ namespace Dumux
/*!
* \ingroup TwoPBoxModel
* \ingroup BoxFluxVariables
* \brief This template class contains the data which is required to
* calculate the fluxes of the fluid phases over a face of a
* finite volume for the two-phase model.
......
......@@ -29,12 +29,11 @@
namespace Dumux
{
/*!
* \ingroup TwoPBoxModel
*/
// \{
/*!
* \ingroup TwoPBoxModel
* \ingroup BoxIndices
* \brief The common indices for the isothermal two-phase model.
*/
struct TwoPCommonIndices
......
......@@ -34,6 +34,7 @@ namespace Dumux
{
/*!
* \ingroup TwoPBoxModel
* \ingroup BoxLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase box model.
*
......
......@@ -31,6 +31,7 @@
namespace Dumux
{
/*!
* \ingroup BoxBaseProblems
* \ingroup TwoPBoxModel
* \brief Base class for all problems which use the two-phase box model
*/
......
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