Commit fe4b32c5 authored by Timo Koch's avatar Timo Koch
Browse files

[doc] Improve documentation for cell-centered scheme

parent a2e47c81
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup CCDiscretization
* \brief Stores the face indices corresponding to the neighbors of an element
* that contribute to the derivative calculation. This is used for
* finite-volume schemes with symmetric sparsity pattern in the global matrix.
......@@ -34,7 +35,7 @@ namespace Dumux
{
/*!
* \ingroup CellCentered
* \ingroup CCDiscretization
* \brief A simple version of the connectivity map for cellcentered schemes.
* This implementation works for schemes in which for a given cell I only
* those cells J have to be prepared in whose stencil the cell I appears.
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup CCDiscretization
* \brief Boundary types gathered on an element
*/
#ifndef DUMUX_CC_ELEMENT_BOUNDARY_TYPES_HH
......@@ -29,8 +30,9 @@ namespace Dumux
{
/*!
* \ingroup CCModel
* \brief This class exists only for compatibility purposes with the
* \ingroup CCDiscretization
* \brief Boundary types gathered on an element
* \note This class exists only for compatibility purposes with the
* box scheme. The cell-centered schemes and the box scheme use
* a common base local residual, which passes an ElementBoundaryTypes
* object to the implemented interfaces.
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup CCDiscretization
* \brief The local element solution class for cell-centered methods
*/
#ifndef DUMUX_CC_ELEMENT_SOLUTION_HH
......@@ -30,7 +31,7 @@ namespace Dumux
{
/*!
* \ingroup CCModel
* \ingroup CCDiscretization
* \brief The element solution vector
*/
template<class TypeTag>
......@@ -46,7 +47,6 @@ class CCElementSolution
public:
using PrimaryVariables = typename GET_PROP_TYPE(TypeTag, PrimaryVariables);
//! Default constructors
CCElementSolution() = default;
//! Constructor with element and solution
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup CCDiscretization
* \brief The grid volume variables class for cell centered models
*/
#ifndef DUMUX_DISCRETIZATION_CC_GRID_VOLUMEVARIABLES_HH
......@@ -29,8 +30,11 @@ namespace Dumux
{
/*!
* \ingroup CCModel
* \ingroup CCDiscretization
* \brief Base class for the grid volume variables
* \note This class has a cached version and a non-cached version
* \tparam TypeTag the TypeTag
* \tparam enableGridVolVarsCache if the cache is enabled
*/
template<class TypeTag, bool enableGridVolVarsCache>
class CCGridVolumeVariables
......
......@@ -18,7 +18,8 @@
*****************************************************************************/
/*!
* \file
* \brief Base class for a sub control volume
* \ingroup CCDiscretization
* \brief Sub control volumes for cell-centered discretization schemes
*/
#ifndef DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
#define DUMUX_DISCRETIZATION_CC_SUBCONTROLVOLUME_HH
......@@ -28,6 +29,10 @@
namespace Dumux
{
/*!
* \ingroup CCDiscretization
* \brief Sub control volumes for cell-centered discretization schemes
*/
template<class ScvGeometryTraits>
class CCSubControlVolume : public SubControlVolumeBase<CCSubControlVolume<ScvGeometryTraits>, ScvGeometryTraits>
{
......@@ -42,7 +47,6 @@ public:
//! state the traits public and thus export all types
using Traits = ScvGeometryTraits;
// the default constructor
CCSubControlVolume() = default;
// the contructor in the cc case
......
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