Commit 76f567b6 authored by Simon Emmert's avatar Simon Emmert

[doxygen] Adapt documentation in 1p sequential

parent bd292ebf
......@@ -35,7 +35,6 @@ class FluxData1P;
/*!
* \ingroup SequentialOnePModel
*
* \brief Class including data of one grid cell.
*
* The variables of one-phase flow, which are the pressure as well as
......
......@@ -192,13 +192,14 @@ private:
};
/*!
* \ingroup SequentialOnePModel
* \brief Calculates the velocity at a cell-cell interface.
*
* Calculates the velocity at a cell-cell interface from a given pressure field.
*
* \param intersection Intersection of two grid cells
* \param cellData Object containing all model relevant cell data
*/
*
* Calculates the velocity at a cell-cell interface from a given pressure field.
*
* \param intersection Intersection of two grid cells
* \param cellData Object containing all model relevant cell data
*/
template<class TypeTag>
void FVVelocity1P<TypeTag>::calculateVelocity(const Intersection& intersection, CellData& cellData)
{
......@@ -265,13 +266,14 @@ void FVVelocity1P<TypeTag>::calculateVelocity(const Intersection& intersection,
}
/*!
* \ingroup SequentialOnePModel
* \brief Calculates the velocity at a boundary.
*
* Calculates the velocity at a boundary from a given pressure field.
*
* \param intersection Boundary intersection
* \param cellData Object containing all model relevant cell data
*/
*
* Calculates the velocity at a boundary from a given pressure field.
*
* \param intersection Boundary intersection
* \param cellData Object containing all model relevant cell data
*/
template<class TypeTag>
void FVVelocity1P<TypeTag>::calculateVelocityOnBoundary(const Intersection& intersection, CellData& cellData)
{
......
......@@ -27,11 +27,9 @@
#include "properties.hh"
namespace Dumux {
/*!
* \ingroup SequentialOnePModel
*
* \brief Class storing data assigned to a cell-cell interfaces, so-called flux-data.
*
* Stores velocities and potentials at cell-cell interfaces.
......
Markdown is supported
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