Commit a4f9e6bd authored by Andreas Lauser's avatar Andreas Lauser
Browse files

documentation simplify the doxygen groups for the box models

also put the problems into the group for their respective model

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4560 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent ed3e885a
......@@ -32,11 +32,6 @@
namespace Dumux
{
/*!
* \ingroup BoxProblems
* \defgroup OnePBoxProblems One-phase box problems
*/
/*!
* \ingroup BoxModels
* \defgroup OnePBoxModel One-phase box model
......
......@@ -35,11 +35,6 @@
namespace Dumux
{
/*!
* \ingroup BoxProblems
* \defgroup OnePTwoCBoxProblems One-phase Two-component box problems
*/
/*!
* \ingroup BoxModels
* \defgroup OnePTwoCBoxModel One-phase Two-component box model
......
......@@ -36,11 +36,6 @@
namespace Dumux
{
/*!
* \ingroup BoxProblems
* \defgroup TwoPProblems Two-phase box problems
*/
/*!
* \ingroup BoxModels
* \defgroup TwoPBoxModel Two-phase box model
......
......@@ -29,11 +29,6 @@
namespace Dumux
{
/*!
* \ingroup BoxProblems
* \defgroup TwoPTwoCProblems Two-phase two-component box problems
*/
/*!
* \ingroup BoxModels
* \defgroup TwoPTwoCModel Two-phase two-component box model
......
......@@ -27,11 +27,6 @@
#include <dumux/boxmodels/2p2c/2p2cmodel.hh>
namespace Dumux {
/*!
* \ingroup BoxProblems
* \defgroup TwoPTwoCNIProblems Non-isothermal two-phase two-component box problems
*/
/*!
* \ingroup BoxModels
* \defgroup TwoPTwoCNIModel Non-isothermal two-phase two-component box model
......
......@@ -31,11 +31,6 @@
namespace Dumux {
/*!
* \ingroup BoxProblems
* \defgroup TwoPNIProblems Non-isothermal two-phase box problems
*/
/*!
* \ingroup BoxModels
* \defgroup TwoPNIBoxModel Non-isothermal two-phase box model
......
......@@ -33,15 +33,11 @@ namespace Dumux
{
/*!
* \defgroup BoxModel Box-Scheme
* \defgroup BoxModel The core infrastructure of the box scheme
*/
/*!
* \ingroup BoxModel
* \defgroup BoxProblems Box-Problems
*/
/*!
* \ingroup BoxModel
* \defgroup BoxModels Box-Models
* \defgroup BoxModels Physical models and problems which use the box scheme
*/
......
......@@ -25,7 +25,6 @@
*
* \brief Adaption of the box scheme to the Richards model.
*/
#ifndef DUMUX_RICHARDS_MODEL_HH
#define DUMUX_RICHARDS_MODEL_HH
......
......@@ -31,7 +31,7 @@
#include <dumux/material/components/simpleh2o.hh>
#include <dumux/material/fluidsystems/liquidphase.hh>
#include "1pspatialparameters.hh"
#include "1ptestspatialparameters.hh"
namespace Dumux
{
......@@ -72,14 +72,14 @@ SET_PROP(OnePTestProblem, Problem)
// Set the spatial parameters
SET_PROP(OnePTestProblem, SpatialParameters)
{ typedef Dumux::OnePSpatialParameters<TypeTag> type; };
{ typedef Dumux::OnePTestSpatialParameters<TypeTag> type; };
// Enable gravity
SET_BOOL_PROP(OnePTestProblem, EnableGravity, true);
}
/*!
* \ingroup OnePBoxProblems
* \ingroup OnePBoxModel
* \brief Air flow in porous media
*
* The domain is box shaped. All sides are closed (Neumann 0 boundary)
......
......@@ -13,21 +13,28 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
#ifndef DUMUX_1PSPATIALPARAMETERS_HH
#define DUMUX_1PSPATIALPARAMETERS_HH
/*!
* \file
*
* \brief The spatial parameters class for the test problem using the
* 1p box model
*/
#ifndef DUMUX_1P_TEST_SPATIALPARAMETERS_HH
#define DUMUX_1P_TEST_SPATIALPARAMETERS_HH
#include <dumux/material/spatialparameters/boxspatialparameters.hh>
namespace Dumux
{
/**
* \file
/*!
* \ingroup OnePBoxModel
*
* \brief Class for defining spatial parameters
* \brief The spatial parameters class for the test problem using the
* 1p box model
*/
template<class TypeTag>
class OnePSpatialParameters : public BoxSpatialParameters<TypeTag>
class OnePTestSpatialParameters : public BoxSpatialParameters<TypeTag>
{
typedef BoxSpatialParameters<TypeTag> ParentType;
......@@ -38,7 +45,7 @@ class OnePSpatialParameters : public BoxSpatialParameters<TypeTag>
typedef typename GridView::template Codim<0>::Entity Element;
public:
OnePSpatialParameters(const GridView& gridView)
OnePTestSpatialParameters(const GridView& gridView)
: ParentType(gridView)
{}
......
......@@ -90,7 +90,9 @@ SET_BOOL_PROP(TissueTumorProblem, EnableGravity, false);
}
/**
/*!
* \ingroup OnePTwoCBoxModel
*
* \brief Definition of a problem, where the distribution of a therapeutic agent
* within pulmonary tissue is described
*
......
......@@ -14,6 +14,12 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Definition of the spatial parameters for the 1p2c
* tissue-tumor problem
*/
#ifndef DUMUX_TISSUE_TUMOR_SPATIAL_PARAMETERS_HH
#define DUMUX_TISSUE_TUMOR_SPATIAL_PARAMETERS_HH
......@@ -25,11 +31,11 @@
namespace Dumux
{
/**
* \file
*
* \brief Definition of the spatial parameters for the problem
/*!
* \ingroup OnePTwoCBoxModel
*
* \brief Definition of the spatial parameters for the 1p2c
* tissue-tumor problem
*/
template<class TypeTag>
class TissueTumorSpatialParameters : public BoxSpatialParameters<TypeTag>
......
......@@ -125,7 +125,7 @@ SET_BOOL_PROP(LensProblem, EnableGravity, true);
}
/*!
* \ingroup TwoPBoxProblems
* \ingroup TwoPBoxModel
* \brief Soil contamination problem where DNAPL infiltrates a fully
* water saturated medium.
*
......
......@@ -16,6 +16,12 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief The spatial parameters for the LensProblem which uses the
* twophase box model
*/
#ifndef DUMUX_LENSSPATIALPARAMETERS_HH
#define DUMUX_LENSSPATIALPARAMETERS_HH
......@@ -26,17 +32,15 @@
#include <dumux/boxmodels/2p/2pmodel.hh>
/**
* @file
* @brief Class for defining spatial parameters
* @author Bernd Flemisch, Klaus Mosthaf, Markus Wolff
*/
namespace Dumux
{
/** \todo Please doc me! */
/*!
* \ingroup TwoPBoxModel
*
* \brief The spatial parameters for the LensProblem which uses the
* twophase box model
*/
template<class TypeTag>
class LensSpatialParameters : public BoxSpatialParameters<TypeTag>
{
......
......@@ -96,7 +96,7 @@ SET_BOOL_PROP(InjectionProblem, EnablePartialReassemble, true);
/*!
* \ingroup TwoPBoxProblems
* \ingroup TwoPTwoCModel
* \brief Problem where air is injected under a low permeable layer in a depth of 800m.
*
* The domain is sized 60m times 40m and consists of two layers, a moderately
......
......@@ -17,7 +17,8 @@
/*!
* \file
*
* \brief Definition of the spatial parameters for the injection problem
* \brief Definition of the spatial parameters for the injection
* problem which uses the isothermal 2p2c box model
*/
#ifndef DUMUX_INJECTION_SPATIAL_PARAMETERS_HH
......@@ -32,10 +33,10 @@ namespace Dumux
{
/*!
* \ingroup SpatialParameters
*
* \brief Definition of the spatial parameters for the injection problem
* \ingroup TwoPTwoCModel
*
* \brief Definition of the spatial parameters for the injection
* problem which uses the isothermal 2p2c box model
*/
template<class TypeTag>
class InjectionSpatialParameters : public BoxSpatialParameters<TypeTag>
......
......@@ -14,11 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief TwoPTwoCNIBoxProblems Non-isothermal two-phase two-component box problems.
* \brief Non-isothermal gas injection problem where a gas (e.g. air)
* is injected into a fully water saturated medium.
*/
#ifndef DUMUX_WATERAIRPROBLEM_HH
#define DUMUX_WATERAIRPROBLEM_HH
......@@ -39,11 +39,6 @@
#define ISOTHERMAL 0
/*!
* \ingroup BoxProblems
* \brief TwoPTwoCNIBoxProblems Non-isothermal two-phase two-component box problems
*/
namespace Dumux
{
template <class TypeTag>
......@@ -93,13 +88,16 @@ SET_BOOL_PROP(WaterAirProblem, NewtonWriteConvergence, false);
/*!
* \ingroup TwoPTwoCNIBoxProblems
* \brief Nonisothermal 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.
* \ingroup TwoPTwoCNIBoxModel
*
* \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.
*
* The domain is sized 40 m times 40 m. The rectangular area with the increased temperature (380 K)
* starts at (20 m, 5 m) and ends at (30 m, 35 m).
* The domain is sized 40 m times 40 m. The rectangular area with the
* increased temperature (380 K) starts at (20 m, 5 m) and ends at (30
* m, 35 m).
*
* For the mass conservation equation neumann boundary conditions are used on
* the top and on the bottom of the domain, while dirichlet conditions
......
......@@ -14,7 +14,6 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
......@@ -32,10 +31,9 @@ namespace Dumux
{
/*!
* \ingroup SpatialParameters
*
* \brief Definition of the spatial parameters for the water-air problem
* \ingroup TwoPTwoCNIModel
*
* \brief Definition of the spatial parameters for the water-air problem
*/
template<class TypeTag>
class WaterAirSpatialParameters : public BoxSpatialParameters<TypeTag>
......
......@@ -119,7 +119,7 @@ SET_BOOL_PROP(InjectionProblem2PNI, NewtonWriteConvergence, true);
}
/*!
* \ingroup TwoPNIBoxProblems
* \ingroup TwoPNIBoxModel
* \brief Nonisothermal 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.
......
......@@ -31,6 +31,7 @@ namespace Dumux
{
/*!
* \ingroup RichardsModel
* \brief The spatial parameters for the RichardsLensProblem
*/
template<class TypeTag>
......
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