From 781e1a36982a52de98638cfe8173d572a2f1cb3b Mon Sep 17 00:00:00 2001
From: Melanie Lipp <melaniel@darth.iws.uni-stuttgart.de>
Date: Tue, 19 Dec 2017 15:54:10 +0100
Subject: [PATCH] [docu compositional and immiscible]
---
.../compositional/localresidual.hh | 19 ++++++++++---------
.../compositional/primaryvariableswitch.hh | 5 ++++-
.../privarswitchnewtoncontroller.hh | 1 +
.../switchableprimaryvariables.hh | 2 +-
.../immiscible/localresidual.hh | 10 ++++++++--
5 files changed, 24 insertions(+), 13 deletions(-)
diff --git a/dumux/porousmediumflow/compositional/localresidual.hh b/dumux/porousmediumflow/compositional/localresidual.hh
index 90613b92b8..61b48ca321 100644
--- a/dumux/porousmediumflow/compositional/localresidual.hh
+++ b/dumux/porousmediumflow/compositional/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup Implicit
* \brief Element-wise calculation of the local residual for problems
* using compositional fully implicit model.
*/
@@ -35,7 +35,6 @@ NEW_PROP_TAG(ReplaceCompEqIdx);
/*!
* \ingroup Implicit
- * \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the local residual for problems
* using compositional fully implicit model.
*
@@ -84,9 +83,9 @@ public:
* The result should be averaged over the volume (e.g. phase mass
* inside a sub control volume divided by the volume)
*
- * \param storage The mass of the component within the sub-control volume
- * \param scvIdx The SCV (sub-control-volume) index
- * \param usePrevSol Evaluate function with solution of current or previous time step
+ * \param problem The problem
+ * \param scv The sub control volume
+ * \param volVars The current or previous volVars
*/
ResidualVector computeStorage(const Problem& problem,
const SubControlVolume& scv,
@@ -133,10 +132,12 @@ public:
* \brief Evaluates the total flux of all conservation quantities
* over a face of a sub-control volume.
*
- * \param flux The flux over the SCV (sub-control-volume) face for each component
- * \param fIdx The index of the SCV face
- * \param onBoundary A boolean variable to specify whether the flux variables
- * are calculated for interior SCV faces or boundary faces, default=false
+ * \param problem The problem
+ * \param element The current element.
+ * \param fvGeometry The finite-volume geometry
+ * \param elemVolVars The volume variables of the current element
+ * \param scvf The sub control volume face to compute the flux on
+ * \param elemFluxVarsCache The cache related to flux compuation
*/
ResidualVector computeFlux(const Problem& problem,
const Element& element,
diff --git a/dumux/porousmediumflow/compositional/primaryvariableswitch.hh b/dumux/porousmediumflow/compositional/primaryvariableswitch.hh
index 188b1879dc..17b6e473c3 100644
--- a/dumux/porousmediumflow/compositional/primaryvariableswitch.hh
+++ b/dumux/porousmediumflow/compositional/primaryvariableswitch.hh
@@ -97,8 +97,11 @@ public:
/*!
* \brief Update the variable switch / phase presence
- * \param problem The problem
+ *
* \param curSol The current solution to be updated / modified
+ * \param gridVariables The secondary variables on the grid
+ * \param problem The problem
+ * \param fvGridGeometry The finite-volume grid geometry
*/
bool update(SolutionVector& curSol,
GridVariables& gridVariables,
diff --git a/dumux/porousmediumflow/compositional/privarswitchnewtoncontroller.hh b/dumux/porousmediumflow/compositional/privarswitchnewtoncontroller.hh
index 42aeefc5d5..68df67718b 100644
--- a/dumux/porousmediumflow/compositional/privarswitchnewtoncontroller.hh
+++ b/dumux/porousmediumflow/compositional/privarswitchnewtoncontroller.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup Newton
* \brief Reference implementation of a controller class for the Newton solver.
*
* Usually this controller should be sufficient.
diff --git a/dumux/porousmediumflow/compositional/switchableprimaryvariables.hh b/dumux/porousmediumflow/compositional/switchableprimaryvariables.hh
index 1043b4d40e..f86a0717dd 100644
--- a/dumux/porousmediumflow/compositional/switchableprimaryvariables.hh
+++ b/dumux/porousmediumflow/compositional/switchableprimaryvariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup ImplicitModel
* \brief A primary variable vector with a state to allow variable switches
*/
#ifndef DUMUX_SWITCHABLE_PRIMARY_VARIABLES_HH
diff --git a/dumux/porousmediumflow/immiscible/localresidual.hh b/dumux/porousmediumflow/immiscible/localresidual.hh
index a2c295e760..ee8ca9bbc0 100644
--- a/dumux/porousmediumflow/immiscible/localresidual.hh
+++ b/dumux/porousmediumflow/immiscible/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup OnePModel
* \brief Element-wise calculation of the residual for problems
* using the n-phase immiscible fully implicit models.
*/
@@ -29,7 +29,6 @@ namespace Dumux
{
/*!
* \ingroup OnePModel
- * \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the residual for problems
* using the n-phase immiscible fully implicit models.
*/
@@ -64,6 +63,7 @@ public:
* \brief Evaluate the rate of change of all conservation
* quantites (e.g. phase mass) within a sub-control
* volume of a finite volume element for the immiscible models.
+ * \param problem TODO docme!
* \param scv The sub control volume
* \param volVars The current or previous volVars
* \note This function should not include the source and sink terms.
@@ -96,7 +96,13 @@ public:
/*!
* \brief Evaluate the mass flux over a face of a sub control volume
+ *
+ * \param problem TODO docme!
+ * \param element The element
+ * \param fvGeometry The finite volume geometry context
+ * \param elemVolVars The volume variables for all flux stencil elements
* \param scvf The sub control volume face to compute the flux on
+ * \param elemFluxVarsCache The cache related to flux compuation
*/
ResidualVector computeFlux(const Problem& problem,
const Element& element,
--
GitLab