diff --git a/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh b/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh
index 8b4af3635521f9c9a4917019d6aca3c5abf654ce..66ab895733144c52796e022d7fd1459b86f2b9d3 100644
--- a/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh
+++ b/dumux/porousmediumflow/1p/incompressiblelocalresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup OnePModel
* \brief Element-wise calculation of the residual and its derivatives
* for a single-phase, incompressible, test problem.
*/
diff --git a/dumux/porousmediumflow/1p/indices.hh b/dumux/porousmediumflow/1p/indices.hh
index 59bff376183fe4ca87d76bfad4b0043405db78d6..7e68e1885691af3bb2720ce429b65d915183b812 100644
--- a/dumux/porousmediumflow/1p/indices.hh
+++ b/dumux/porousmediumflow/1p/indices.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup OnePModel
* \brief Defines the indices for the one-phase fully implicit model.
*/
#ifndef DUMUX_1P_INDICES_HH
@@ -29,7 +30,6 @@ namespace Dumux
/*!
* \ingroup OnePModel
- * \ingroup ImplicitIndices
* \brief Indices for the one-phase model.
*/
struct OnePIndices
diff --git a/dumux/porousmediumflow/1p/model.hh b/dumux/porousmediumflow/1p/model.hh
index d4832632aff9ef4d93774b27e79446cd483003e0..a41f98ec1bcd652c9fe6bdc26071a9ad931d389f 100644
--- a/dumux/porousmediumflow/1p/model.hh
+++ b/dumux/porousmediumflow/1p/model.hh
@@ -17,8 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \file OnePModel
- *
+ * \file
* \ingroup OnePModel
* \brief A single-phase, isothermal flow model using the fully implicit scheme.
*
@@ -59,23 +58,24 @@
namespace Dumux
{
namespace Properties {
-//! The type tags for the isothermal & non-isothermal single phase model
+//! The type tags for the isothermal single phase model
NEW_TYPE_TAG(OneP, INHERITS_FROM(PorousMediumFlow));
+//! The type tags for the non-isothermal single phase model
NEW_TYPE_TAG(OnePNI, INHERITS_FROM(OneP, NonIsothermal));
///////////////////////////////////////////////////////////////////////////
// properties for the isothermal single phase model
///////////////////////////////////////////////////////////////////////////
-SET_INT_PROP(OneP, NumEq, 1); //! set the number of equations to 1
-SET_INT_PROP(OneP, NumPhases, 1); //! The number of phases in the 1p model is 1
-SET_INT_PROP(OneP, NumComponents, 1); //! The number of components in the 1p model is 1
-SET_TYPE_PROP(OneP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //! The local residual function
-SET_TYPE_PROP(OneP, VolumeVariables, OnePVolumeVariables<TypeTag>); //! the VolumeVariables property
-SET_BOOL_PROP(OneP, EnableAdvection, true); //! The one-phase model considers advection
-SET_BOOL_PROP(OneP, EnableMolecularDiffusion, false); //! The one-phase model has no molecular diffusion
-SET_BOOL_PROP(OneP, EnableEnergyBalance, false); //! Isothermal model by default
-SET_TYPE_PROP(OneP, Indices, OnePIndices); //! The indices required by the isothermal single-phase model
-SET_TYPE_PROP(OneP, VtkOutputFields, OnePVtkOutputFields<TypeTag>); //! Set the vtk output fields specific to this model
+SET_INT_PROP(OneP, NumEq, 1); //!< set the number of equations to 1
+SET_INT_PROP(OneP, NumPhases, 1); //!< The number of phases in the 1p model is 1
+SET_INT_PROP(OneP, NumComponents, 1); //!< The number of components in the 1p model is 1
+SET_TYPE_PROP(OneP, LocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< The local residual function
+SET_TYPE_PROP(OneP, VolumeVariables, OnePVolumeVariables<TypeTag>); //!< the VolumeVariables property
+SET_BOOL_PROP(OneP, EnableAdvection, true); //!< The one-phase model considers advection
+SET_BOOL_PROP(OneP, EnableMolecularDiffusion, false); //!< The one-phase model has no molecular diffusion
+SET_BOOL_PROP(OneP, EnableEnergyBalance, false); //!< Isothermal model by default
+SET_TYPE_PROP(OneP, Indices, OnePIndices); //!< The indices required by the isothermal single-phase model
+SET_TYPE_PROP(OneP, VtkOutputFields, OnePVtkOutputFields<TypeTag>); //!< Set the vtk output fields specific to this model
/*!
* \brief The fluid state which is used by the volume variables to
@@ -95,15 +95,15 @@ public:
///////////////////////////////////////////////////////////////////////////
// properties for the non-isothermal single phase model
///////////////////////////////////////////////////////////////////////////
-SET_INT_PROP(OnePNI, IsothermalNumEq, 1); //! set number of equations of isothermal model
-SET_BOOL_PROP(OnePNI, EnableEnergyBalance, true); //! we do solve for the energy balance here
-SET_TYPE_PROP(OnePNI, IsothermalVtkOutputFields, OnePVtkOutputFields<TypeTag>); //! the isothermal vtk output fields
-SET_TYPE_PROP(OnePNI, IsothermalVolumeVariables, OnePVolumeVariables<TypeTag>); //! Vol vars of the isothermal model
-SET_TYPE_PROP(OnePNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //! Local residual of the isothermal model
-SET_TYPE_PROP(OnePNI, IsothermalIndices, OnePIndices); //! Indices of the isothermal model
+SET_INT_PROP(OnePNI, IsothermalNumEq, 1); //!< set number of equations of isothermal model
+SET_BOOL_PROP(OnePNI, EnableEnergyBalance, true); //!< we do solve for the energy balance here
+SET_TYPE_PROP(OnePNI, IsothermalVtkOutputFields, OnePVtkOutputFields<TypeTag>); //!< the isothermal vtk output fields
+SET_TYPE_PROP(OnePNI, IsothermalVolumeVariables, OnePVolumeVariables<TypeTag>); //!< Vol vars of the isothermal model
+SET_TYPE_PROP(OnePNI, IsothermalLocalResidual, ImmiscibleLocalResidual<TypeTag>); //!< Local residual of the isothermal model
+SET_TYPE_PROP(OnePNI, IsothermalIndices, OnePIndices); //!< Indices of the isothermal model
SET_TYPE_PROP(OnePNI,
ThermalConductivityModel,
- ThermalConductivityAverage<typename GET_PROP_TYPE(TypeTag, Scalar)>); //! Use the average for effective conductivities
+ ThermalConductivityAverage<typename GET_PROP_TYPE(TypeTag, Scalar)>); //!< Use the average for effective conductivities
} // end namespace Properties
} // end namespace Dumux
diff --git a/dumux/porousmediumflow/1p/sequential/celldata.hh b/dumux/porousmediumflow/1p/sequential/celldata.hh
index f43cefc08fdab1b27e4dbf7f8d7aa942e1603ff4..ddf7d54319e49e08e9670d4f1c0082308653f528 100644
--- a/dumux/porousmediumflow/1p/sequential/celldata.hh
+++ b/dumux/porousmediumflow/1p/sequential/celldata.hh
@@ -22,9 +22,10 @@
#include "properties.hh"
#include "fluxdata.hh"
-/**
+/*!
* \file
- * \brief Class including data of one grid cell
+ * \ingroup SequentialOnePModel
+ * \brief Class including data of one grid cell.
*/
namespace Dumux
@@ -33,11 +34,10 @@ template<class TypeTag>
class FluxData1P;
/*!
- * \ingroup OnePhase
- */
-//! Class including data of one grid cell.
-/*! The variables of one-phase flow, which are the pressure as well as additional data assigned to
- *! cell-cell interfaces, so-called flux-data, are stored.
+ * \ingroup SequentialOnePModel
+ * Class including data of one grid cell.
+ * The variables of one-phase flow, which are the pressure as well as additional data assigned to
+ * cell-cell interfaces, so-called flux-data, are stored.
*
* \tparam TypeTag The problem TypeTag
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
index 753b81367d502017f214a87380acfc2af8acd372..2426d68bb0e8cf751e290ca45705d2130ddb2c68 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
@@ -26,15 +26,16 @@
/**
* \file
- * \brief Single Phase Finite Volume Model
+ * \ingroup SequentialOnePModel
+ * \brief Sequential OneP Model solving the equations for pressure and velocity seperately.
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single Phase Finite Volume Model
-/*! This model solves equations of the form
+/*! \ingroup SequentialOnePModel
+ * \brief Sequential OneP Model solving the equations for pressure and velocity seperately.
+ * This model solves equations of the form
* \f[
* \text{div}\, \boldsymbol v = q.
* \f]
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
index f905a8b35f0426131fe4eb8c66d9b8a5c9908e0e..c5fe24e9735207d49a900033cf5b954674c705c0 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressureproperties.hh
@@ -16,14 +16,9 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
-
-/*!
- * \ingroup FV1p
- * \ingroup Properties
- */
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for finite volume pressure models
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
index a7b910dad2aca51d713c0d07c7cb9b5fc50a01c8..16c4d8081ebbf8267d785a42206663f0cf21f3e9 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocity.hh
@@ -25,17 +25,18 @@
#include <dumux/porousmediumflow/1p/sequential/properties.hh>
#include <dumux/porousmediumflow/sequential/cellcentered/velocity.hh>
-/**
+/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Single Phase Finite Volume Model
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single Phase Finite Volume Model
-/*! This model solves equations of the form
+/*! \ingroup SequentialOnePModel
+ * \brief Single Phase Finite Volume Model
+ * This model solves equations of the form
* \f[
* \textbf{div}\, \boldsymbol v = q.
* \f]
@@ -93,8 +94,8 @@ public:
velocity_.addOutputVtkFields(writer);
}
- //! Constructs a FVPressure1P object
- /**
+ /*! Constructs a FVPressure1P object
+ *
* \param problem A problem class object
*/
FVPressureVelocity1P(Problem& problem) :
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
index eaba8ee5fe2937eedeca81b013fa8fc7fbd24416..2c65f64449e60cde49153729acac96acec553e76 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/pressurevelocityproperties.hh
@@ -17,13 +17,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
-/*!
- * \ingroup FV1p
- * \ingroup Properties
- */
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for finite volume pressure models
*/
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
index 994b7b2eeeb23af43745d29a9a96f4a3920d4ea3..6a805b55e12b15e6e03a00d2ef43833b3d4f3c0c 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
@@ -21,17 +21,18 @@
#include<dumux/porousmediumflow/1p/sequential/properties.hh>
-/**
+/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Single phase finite volume velocity reconstruction
*/
namespace Dumux
{
-//! \ingroup FV1p
-//! \brief Single phase finite volume velocity reconstruction
-/*! Calculates velocities from a known pressure field applying a finite volume discretization.
+/*! \ingroup SequentialOnePModel
+ * \brief Single phase finite volume velocity reconstruction
+ * Calculates velocities from a known pressure field applying a finite volume discretization.
* The pressure has to be given as piecewise constant cell values.
* The velocity is calculated following Darcy's law as
* \f[
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh b/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
index ebc0d5824679575a82a67aebcb97c44b2938496f..796dc316ec9fac7a72325778192a91cd8821386c 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/problem.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Base class for all single phase diffusion problem
*/
#ifndef DUMUX_DIFFUSIONPROBLEM_1P_HH
@@ -35,9 +36,7 @@ namespace Properties
SET_TYPE_PROP(PressureOneP, Model, typename GET_PROP_TYPE(TypeTag, PressureModel));
}
/*!
- * \ingroup Pressure1P
- * \ingroup IMPETproblems
- *
+ * \ingroup SequentialOnePModel
* \brief Base class for all single phase diffusion problem
*
* \tparam TypeTag The Type Tag
@@ -81,6 +80,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief Constructs a DiffusionProblem1P object
*
@@ -96,6 +96,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief The constructor
*
@@ -109,6 +110,7 @@ public:
if (getParam<bool>("Problem.EnableGravity"))
gravity_[dim - 1] = -9.81;
}
+
/*!
* \brief The constructor
*
@@ -233,7 +235,7 @@ private:
Implementation &asImp_()
{ return *static_cast<Implementation *>(this); }
- //! \copydoc IMPETProblem::asImp_()
+ //! \copydoc SequentialOnePModel::asImp_()
const Implementation &asImp_() const
{ return *static_cast<const Implementation *>(this); }
diff --git a/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh b/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
index 992674d10b8038ef215fed815ffdeceafb50e9aa..102324f37e708d97c3316e428c7747df54576d9c 100644
--- a/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
+++ b/dumux/porousmediumflow/1p/sequential/diffusion/properties.hh
@@ -22,12 +22,9 @@
#include <dumux/porousmediumflow/sequential/pressureproperties.hh>
#include <dumux/porousmediumflow/1p/sequential/properties.hh>
-/*!
- * \ingroup Pressure1p
- * \ingroup IMPETProperties
- */
/*!
* \file
+ * \ingroup SequentialOnePModel
* \brief Specifies the properties for 1p pressure models
*/
namespace Dumux
diff --git a/dumux/porousmediumflow/1p/sequential/fluxdata.hh b/dumux/porousmediumflow/1p/sequential/fluxdata.hh
index 6ac753247d0471dd5bee7eb19fe384684685228b..dc8b9883a67b9ee6c44c013da262078d3502a25b 100644
--- a/dumux/porousmediumflow/1p/sequential/fluxdata.hh
+++ b/dumux/porousmediumflow/1p/sequential/fluxdata.hh
@@ -21,22 +21,22 @@
#include "properties.hh"
-/**
+/*!
* \file
- * \brief Class storing data assigned to a cell-cell interfaces, so-called flux-data
+ * \ingroup SequentialOnePModel
+ * \brief Class storing data assigned to a cell-cell interfaces, so-called flux-data.
*/
namespace Dumux
{
/*!
- * \ingroup OnePhase
+ * \ingroup SequentialOnePModel
+ * Class storing data assigned to a cell-cell interfaces, so-called flux-data.
+ * Stores velocities and potentials at cell-cell interfaces.
+ * Further it provides methods which interpret stored phase potentials for upwind decisions.
+ *
+ * \tparam TypeTag The problem TypeTag
*/
-//! Class storing data assigned to a cell-cell interfaces, so-called flux-data.
-/*! Stores velocities and potentials at cell-cell interfaces.
- * Further it provides methods which interpret stored phase potentials for upwind decisions.
-*
-* \tparam TypeTag The problem TypeTag
-*/
template<class TypeTag>
class FluxData1P
{
@@ -81,6 +81,7 @@ public:
{
return velocity_[indexInInside];
}
+
/*! \brief Returns the velocity vector at a cell-cell interface
*
* \param indexInInside Index of the cell-cell interface in this cell
@@ -89,6 +90,7 @@ public:
{
return velocity_[indexInInside];
}
+
/*! \brief Sets the velocity vector at a cell-cell interface
*
* \param indexInInside Index of the cell-cell interface in this cell
@@ -98,6 +100,7 @@ public:
{
velocity_[indexInInside] = velocity;
}
+
//!Resets velocities and potentials
void resetVelocity()
{
@@ -141,6 +144,7 @@ public:
*
* \param indexInInside Index of the cell-cell interface in this cell
*/
+
bool isUpwindCell(int indexInInside)
{
return (potential_[indexInInside] >= 0.);
diff --git a/dumux/porousmediumflow/1p/sequential/indices.hh b/dumux/porousmediumflow/1p/sequential/indices.hh
index a66924104e361cbc788518de8afda7546f945402..515ae78aef2cf6cc9f3dee09b11c5aa37d51bf1a 100644
--- a/dumux/porousmediumflow/1p/sequential/indices.hh
+++ b/dumux/porousmediumflow/1p/sequential/indices.hh
@@ -19,7 +19,7 @@
/*!
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the indices required for the sequential one-phase model.
*/
#ifndef DUMUX_SEQUENTIAL_1P_INDICES_HH
@@ -28,7 +28,7 @@
namespace Dumux
{
/*!
- * \ingroup OnePhase
+ * \ingroup SequentialOnePModel
*/
// \{
@@ -37,7 +37,7 @@ namespace Dumux
*/
struct SequentialOnePCommonIndices
{
- static const int pressureEqIdx = 0;//!< Index of the pressure equation
+ static const int pressureEqIdx = 0; //!< Index of the pressure equation
};
// \}
diff --git a/dumux/porousmediumflow/1p/sequential/properties.hh b/dumux/porousmediumflow/1p/sequential/properties.hh
index 9e9569817a7b623bf6a6a39e095d7f15646db2f0..3a31c9de05afc1c89c9dfeaed7339ea1173d5ec5 100644
--- a/dumux/porousmediumflow/1p/sequential/properties.hh
+++ b/dumux/porousmediumflow/1p/sequential/properties.hh
@@ -18,10 +18,8 @@
*****************************************************************************/
/*!
- * \ingroup OnePhase
- * \ingroup IMPETProperties
* \file
- *
+ * \ingroup SequentialOnePModel
* \brief Defines the properties required for the single phase sequential model.
*/
@@ -58,10 +56,10 @@ NEW_TYPE_TAG(SequentialOneP, INHERITS_FROM(SequentialModel));
// Property tags
//////////////////////////////////////////////////////////////////
-NEW_PROP_TAG( SpatialParams ); //!< The type of the spatial parameters object
-NEW_PROP_TAG( Fluid ); //!< The fluid for one-phase models
-NEW_PROP_TAG( Indices ); //!< Set of indices for the one-phase model
-NEW_PROP_TAG( CellData ); //!< The cell data storage class
+NEW_PROP_TAG( SpatialParams ); //!< The type of the spatial parameters object
+NEW_PROP_TAG( Fluid ); //!< The fluid for one-phase models
+NEW_PROP_TAG( Indices ); //!< Set of indices for the one-phase model
+NEW_PROP_TAG( CellData ); //!< The cell data storage class
}
}
diff --git a/dumux/porousmediumflow/1p/volumevariables.hh b/dumux/porousmediumflow/1p/volumevariables.hh
index f7ccc4daf7d98edaa265423a62bf5296042b2489..cd5dd216305e4d0f3a9d2d1c5eb1396580c12df9 100644
--- a/dumux/porousmediumflow/1p/volumevariables.hh
+++ b/dumux/porousmediumflow/1p/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup OnePModel
* \brief Quantities required by the one-phase fully implicit model defined on a vertex.
*/
#ifndef DUMUX_1P_VOLUME_VARIABLES_HH
diff --git a/dumux/porousmediumflow/1p/vtkoutputfields.hh b/dumux/porousmediumflow/1p/vtkoutputfields.hh
index 12296f473e9b81ab0b6ca393499cb4672db46f6a..c14532fee2e88e3cf3e82bc6807be8dc3a108590 100644
--- a/dumux/porousmediumflow/1p/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/1p/vtkoutputfields.hh
@@ -18,7 +18,8 @@
*****************************************************************************/
/*!
* \file
- * \brief Adds vtk output fields specific to the onep model
+ * \ingroup OnePModel
+ * \brief Adds vtk output fields specific to the one phase model
*/
#ifndef DUMUX_ONEP_VTK_OUTPUT_FIELDS_HH
#define DUMUX_ONEP_VTK_OUTPUT_FIELDS_HH
@@ -27,8 +28,8 @@ namespace Dumux
{
/*!
- * \ingroup OneP, InputOutput
- * \brief Adds vtk output fields specific to the onep model
+ * \ingroup OnePModel, InputOutput
+ * \brief Adds vtk output fields specific to the one phase model
*/
template<class TypeTag>
class OnePVtkOutputFields