From db660bc69aff9b3a96e7d3f59de4bc76612ff8f6 Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Sun, 3 Jun 2012 17:27:40 +0000
Subject: [PATCH] [Documentation] Use copydoc for BoxVolumeVariables::update.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@8421 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/1p/1pvolumevariables.hh | 9 +--------
dumux/boxmodels/1p2c/1p2cvolumevariables.hh | 9 +--------
dumux/boxmodels/2p/2pvolumevariables.hh | 9 +--------
dumux/boxmodels/2p2c/2p2cvolumevariables.hh | 9 +--------
dumux/boxmodels/3p3c/3p3cvolumevariables.hh | 9 +--------
dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh | 9 +--------
dumux/boxmodels/common/boxvolumevariables.hh | 4 ++--
dumux/boxmodels/mpnc/mpncvolumevariables.hh | 2 +-
dumux/boxmodels/richards/richardsvolumevariables.hh | 12 +-----------
9 files changed, 10 insertions(+), 62 deletions(-)
diff --git a/dumux/boxmodels/1p/1pvolumevariables.hh b/dumux/boxmodels/1p/1pvolumevariables.hh
index ea25e13f2c..c55e20d576 100644
--- a/dumux/boxmodels/1p/1pvolumevariables.hh
+++ b/dumux/boxmodels/1p/1pvolumevariables.hh
@@ -63,14 +63,7 @@ public:
typedef Dumux::ImmiscibleFluidState<Scalar, FluidSystem> FluidState;
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The local primary variable vector
- * \param problem The problem object
- * \param element The current element
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The local index of the SCV (sub-control volume)
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
index 293f8d6a8e..0993ccfb28 100644
--- a/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
+++ b/dumux/boxmodels/1p2c/1p2cvolumevariables.hh
@@ -79,14 +79,7 @@ public:
typedef Dumux::CompositionalFluidState<Scalar, FluidSystem> FluidState;
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars A vector containing the primary variables
- * \param problem The considered problem
- * \param element The considered element of the grid
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The index of the considered sub-control volume
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/2p/2pvolumevariables.hh b/dumux/boxmodels/2p/2pvolumevariables.hh
index 297ebd85d4..e48a552160 100644
--- a/dumux/boxmodels/2p/2pvolumevariables.hh
+++ b/dumux/boxmodels/2p/2pvolumevariables.hh
@@ -75,14 +75,7 @@ class TwoPVolumeVariables : public BoxVolumeVariables<TypeTag>
public:
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The local primary variable vector
- * \param problem The problem object
- * \param element The current element
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The local index of the SCV (sub-control volume)
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/2p2c/2p2cvolumevariables.hh b/dumux/boxmodels/2p2c/2p2cvolumevariables.hh
index 6237a19654..9e21c42e9f 100644
--- a/dumux/boxmodels/2p2c/2p2cvolumevariables.hh
+++ b/dumux/boxmodels/2p2c/2p2cvolumevariables.hh
@@ -111,14 +111,7 @@ public:
typedef Dumux::CompositionalFluidState<Scalar, FluidSystem> FluidState;
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The primary variables
- * \param problem The problem
- * \param element The element
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The local index of the SCV (sub-control volume)
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/3p3c/3p3cvolumevariables.hh b/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
index 42a427f0e5..c43f398654 100644
--- a/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
+++ b/dumux/boxmodels/3p3c/3p3cvolumevariables.hh
@@ -112,14 +112,7 @@ public:
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The primary variables
- * \param problem The problem
- * \param element The element
- * \param fvGeometry The finite-volume geometry in the box scheme
- * \param scvIdx The local index of the SCV (sub-control volume)
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh b/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
index 1a1742937a..445e3a29d6 100644
--- a/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
+++ b/dumux/boxmodels/3p3cni/3p3cnivolumevariables.hh
@@ -70,14 +70,7 @@ class ThreePThreeCNIVolumeVariables : public ThreePThreeCVolumeVariables<TypeTag
public:
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The solution primary variables
- * \param problem The problem
- * \param element The element
- * \param fvGeomtry Evaluate function with solution of current or previous time step
- * \param scvIdx The local index of the SCV (sub-control volume)
- * \param isOldSol Evaluate function with solution of current or previous time step
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/common/boxvolumevariables.hh b/dumux/boxmodels/common/boxvolumevariables.hh
index a3cce87299..c45e270c37 100644
--- a/dumux/boxmodels/common/boxvolumevariables.hh
+++ b/dumux/boxmodels/common/boxvolumevariables.hh
@@ -106,9 +106,9 @@ public:
{};
/*!
- * \brief Update all quantities for a given control volume.
+ * \brief Update all quantities for a given control volume
*
- * \param priVars The primary variables for the control volume
+ * \param priVars A vector containing the primary variables for the control volume
* \param problem The object specifying the problem which ought to
* be simulated
* \param element An element which contains part of the control volume
diff --git a/dumux/boxmodels/mpnc/mpncvolumevariables.hh b/dumux/boxmodels/mpnc/mpncvolumevariables.hh
index 6bb8e2b5ef..3d65ee0a40 100644
--- a/dumux/boxmodels/mpnc/mpncvolumevariables.hh
+++ b/dumux/boxmodels/mpnc/mpncvolumevariables.hh
@@ -98,7 +98,7 @@ public:
}
/*!
- * \brief Update all quantities for a given control volume.
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
diff --git a/dumux/boxmodels/richards/richardsvolumevariables.hh b/dumux/boxmodels/richards/richardsvolumevariables.hh
index 7f823f3127..abf73f8d6b 100644
--- a/dumux/boxmodels/richards/richardsvolumevariables.hh
+++ b/dumux/boxmodels/richards/richardsvolumevariables.hh
@@ -73,17 +73,7 @@ public:
typedef Dumux::ImmiscibleFluidState<Scalar, FluidSystem> FluidState;
/*!
- * \brief Update all quantities for a given control volume.
- *
- * \param priVars The primary variables as a vector for the finite
- * volume.
- * \param problem The physical problem which needs to be solved.
- * \param element The DUNE Codim<0> enitity which intersects
- * the control volume of the box method
- * \param fvGeometry The element's finite volume geometry
- * \param scvIdx The local index of the sub control volume inside the element
- * \param isOldSol Specifies whether the solution is from
- * the previous time step or from the current one
+ * \copydoc BoxVolumeVariables::update
*/
void update(const PrimaryVariables &priVars,
const Problem &problem,
--
GitLab