From 7802d338d3b67698af038729008c9b16171f894e Mon Sep 17 00:00:00 2001
From: Martin Schneider <martin.schneider@iws.uni-stuttgart.de>
Date: Wed, 2 Apr 2014 09:39:35 +0000
Subject: [PATCH] Changed doxygen of 2pdfm model: Renamed TwoPDFMBoxModel to
TwoPDFMModel.
(reviewed Christoph and Alex)
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@12710 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/doxygen/modules | 14 +++++++++++++-
dumux/implicit/2pdfm/2pdfmfluxvariables.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmindices.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmlocalresidual.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmmodel.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmproblem.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmproperties.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmpropertydefaults.hh | 8 ++++----
dumux/implicit/2pdfm/2pdfmvolumevariables.hh | 8 ++++----
test/implicit/2pdfm/2pdfmspatialparams.hh | 4 ++--
test/implicit/2pdfm/2pdfmtestproblem.hh | 2 +-
11 files changed, 48 insertions(+), 36 deletions(-)
diff --git a/doc/doxygen/modules b/doc/doxygen/modules
index 97faf33be3..1b931656fa 100644
--- a/doc/doxygen/modules
+++ b/doc/doxygen/modules
@@ -155,7 +155,7 @@
*/
/*!
* \ingroup ImplicitModels
- * \defgroup TwoPDFMBoxModel Two-phase flow in discrete fracture-matrix
+ * \defgroup TwoPDFMModel Two-phase flow in discrete fracture-matrix
*
* \copydetails Dumux::TwoPDFMModel
*/
@@ -201,6 +201,18 @@
*
* \copydetails Dumux::Stokes2cniModel
*/
+ /*!
+ * \ingroup ImplicitModels
+ * \defgroup BoxStokesncModel N-component Stokes
+ *
+ * \copydetails Dumux::StokesncModel
+ */
+ /*!
+ * \ingroup ImplicitModels
+ * \defgroup BoxStokesncniModel Non-isothermal N-component Stokes
+ *
+ * \copydetails Dumux::StokesncniModel
+ */
/*!
* \ingroup ImplicitModels
* \defgroup ElasticBoxModel Linear elastic
diff --git a/dumux/implicit/2pdfm/2pdfmfluxvariables.hh b/dumux/implicit/2pdfm/2pdfmfluxvariables.hh
index 6f167ede6a..2917668d14 100644
--- a/dumux/implicit/2pdfm/2pdfmfluxvariables.hh
+++ b/dumux/implicit/2pdfm/2pdfmfluxvariables.hh
@@ -20,8 +20,8 @@
* all fluxes of fluid phases over a face of a finite volume in the
* two phase discrete fracture-matrix model.
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_FLUX_VARIABLES_HH
-#define DUMUX_BOXMODELS_2PDFM_FLUX_VARIABLES_HH
+#ifndef DUMUX_MODELS_2PDFM_FLUX_VARIABLES_HH
+#define DUMUX_MODELS_2PDFM_FLUX_VARIABLES_HH
#include <dumux/common/math.hh>
#include <dumux/common/parameters.hh>
@@ -34,7 +34,7 @@ namespace Dumux
{
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitFluxVariables
* \brief Contains the data which is required to calculate the fluxes of
* the fluid phases over a face of a finite volume for the two-phase
@@ -226,4 +226,4 @@ private:
} // end namespace
-#endif // DUMUX_BOXMODELS_2PDFM_FLUX_VARIABLES_HH
+#endif // DUMUX_MODELS_2PDFM_FLUX_VARIABLES_HH
diff --git a/dumux/implicit/2pdfm/2pdfmindices.hh b/dumux/implicit/2pdfm/2pdfmindices.hh
index 6eafb196a9..c9ca0611c0 100644
--- a/dumux/implicit/2pdfm/2pdfmindices.hh
+++ b/dumux/implicit/2pdfm/2pdfmindices.hh
@@ -20,8 +20,8 @@
* \brief Defines the indices required for the finite volume in the
* two phase discrete fracture-matrix model.
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_INDICES_HH
-#define DUMUX_BOXMODELS_2PDFM_INDICES_HH
+#ifndef DUMUX_MODELS_2PDFM_INDICES_HH
+#define DUMUX_MODELS_2PDFM_INDICES_HH
#include<dumux/implicit/2p/2pindices.hh>
@@ -30,7 +30,7 @@ namespace Dumux
// \{
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitIndices
* \brief The common indices for the \f$p_w-S_n\f$ formulation of the
* isothermal two-phase discrete fracture-matrix model.
@@ -60,4 +60,4 @@ struct TwoPDFMIndices : public TwoPIndices <TypeTag, formulation, PVOffset>
// \}
} // namespace Dumux
-#endif // DUMUX_BOXMODELS_2PDFM_INDICES_HH
+#endif // DUMUX_MODELS_2PDFM_INDICES_HH
diff --git a/dumux/implicit/2pdfm/2pdfmlocalresidual.hh b/dumux/implicit/2pdfm/2pdfmlocalresidual.hh
index f78b05b00b..16c087a6fc 100644
--- a/dumux/implicit/2pdfm/2pdfmlocalresidual.hh
+++ b/dumux/implicit/2pdfm/2pdfmlocalresidual.hh
@@ -20,8 +20,8 @@
* \brief Element-wise calculation of the residual for the finite volume in the
* two phase discrete fracture-matrix model.
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_LOCAL_RESIDUAL_HH
-#define DUMUX_BOXMODELS_2PDFM_LOCAL_RESIDUAL_HH
+#ifndef DUMUX_MODELS_2PDFM_LOCAL_RESIDUAL_HH
+#define DUMUX_MODELS_2PDFM_LOCAL_RESIDUAL_HH
#include <dumux/implicit/2p/2plocalresidual.hh>
#include "2pdfmproperties.hh"
@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase discrete fracture fully implicit model.
@@ -333,4 +333,4 @@ private:
} // end namespace
-#endif // DUMUX_BOXMODELS_2PDFM_LOCAL_RESIDUAL_HH
+#endif // DUMUX_MODELS_2PDFM_LOCAL_RESIDUAL_HH
diff --git a/dumux/implicit/2pdfm/2pdfmmodel.hh b/dumux/implicit/2pdfm/2pdfmmodel.hh
index 9156cc08b6..7a14d3c397 100644
--- a/dumux/implicit/2pdfm/2pdfmmodel.hh
+++ b/dumux/implicit/2pdfm/2pdfmmodel.hh
@@ -22,8 +22,8 @@
* model.
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_MODEL_HH
-#define DUMUX_BOXMODELS_2PDFM_MODEL_HH
+#ifndef DUMUX_MODELS_2PDFM_MODEL_HH
+#define DUMUX_MODELS_2PDFM_MODEL_HH
#include <dumux/implicit/2p/2pmodel.hh>
#include "2pdfmproperties.hh"
@@ -32,7 +32,7 @@ namespace Dumux
{
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \brief A two-phase, isothermal flow model using the fully implicit scheme.
*
* This model implements two-phase flow of two immiscible fluids
@@ -75,4 +75,4 @@ class TwoPDFMModel : public TwoPModel<TypeTag>
#include "2pdfmpropertydefaults.hh"
-#endif // DUMUX_BOXMODELS_2PDFM_MODEL_HH
+#endif // DUMUX_MODELS_2PDFM_MODEL_HH
diff --git a/dumux/implicit/2pdfm/2pdfmproblem.hh b/dumux/implicit/2pdfm/2pdfmproblem.hh
index 68aef46399..62b71d2fe7 100644
--- a/dumux/implicit/2pdfm/2pdfmproblem.hh
+++ b/dumux/implicit/2pdfm/2pdfmproblem.hh
@@ -18,8 +18,8 @@
* \file
* \brief Base class for all problems which use the two-phase DFM fully implicit model
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_PROBLEM_HH
-#define DUMUX_BOXMODELS_2PDFM_PROBLEM_HH
+#ifndef DUMUX_MODELS_2PDFM_PROBLEM_HH
+#define DUMUX_MODELS_2PDFM_PROBLEM_HH
#include <dumux/implicit/common/implicitporousmediaproblem.hh>
#include "2pdfmproperties.hh"
@@ -28,7 +28,7 @@ namespace Dumux
{
/*!
* \ingroup ImplicitBaseProblems
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \brief Base class for all problems which use the two-phase DFM fully implicit model
*/
template<class TypeTag>
@@ -60,4 +60,4 @@ public:
};
} // end namespace
-#endif // DUMUX_BOXMODELS_2PDFM_PROBLEM_HH
+#endif // DUMUX_MODELS_2PDFM_PROBLEM_HH
diff --git a/dumux/implicit/2pdfm/2pdfmproperties.hh b/dumux/implicit/2pdfm/2pdfmproperties.hh
index 8cacb817cc..0a2e38fc66 100644
--- a/dumux/implicit/2pdfm/2pdfmproperties.hh
+++ b/dumux/implicit/2pdfm/2pdfmproperties.hh
@@ -21,11 +21,11 @@
*
* \ingroup Properties
* \ingroup ImplicitProperties
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_PROPERTIES_HH
-#define DUMUX_BOXMODELS_2PDFM_PROPERTIES_HH
+#ifndef DUMUX_MODELS_2PDFM_PROPERTIES_HH
+#define DUMUX_MODELS_2PDFM_PROPERTIES_HH
#include <dumux/implicit/box/boxproperties.hh>
#include <dumux/implicit/cellcentered/ccproperties.hh>
@@ -69,4 +69,4 @@ NEW_PROP_TAG(VtkAddVelocity); //!< Returns whether velocity vectors are written
} // end namespace Properties
} // end namespace Dumux
-#endif // DUMUX_BOXMODELS_2PDFM_PROPERTIES_HH
+#endif // DUMUX_MODELS_2PDFM_PROPERTIES_HH
diff --git a/dumux/implicit/2pdfm/2pdfmpropertydefaults.hh b/dumux/implicit/2pdfm/2pdfmpropertydefaults.hh
index 232bd09e4c..3070bef52a 100644
--- a/dumux/implicit/2pdfm/2pdfmpropertydefaults.hh
+++ b/dumux/implicit/2pdfm/2pdfmpropertydefaults.hh
@@ -21,11 +21,11 @@
* 2pDFM fully implicit model.
*
* \ingroup Properties
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitProperties
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_PROPERTY_DEFAULTS_HH
-#define DUMUX_BOXMODELS_2PDFM_PROPERTY_DEFAULTS_HH
+#ifndef DUMUX_MODELS_2PDFM_PROPERTY_DEFAULTS_HH
+#define DUMUX_MODELS_2PDFM_PROPERTY_DEFAULTS_HH
#include <dumux/implicit/common/implicitdarcyfluxvariables.hh>
#include <dumux/material/components/nullcomponent.hh>
@@ -142,4 +142,4 @@ SET_BOOL_PROP(TwoPDFM, ProblemEnableGravity, true);
} // end namespace Properties
} // end namespace Dumux
-#endif // DUMUX_BOXMODELS_2PDFM_PROPERTY_DEFAULTS_HH
+#endif // DUMUX_MODELS_2PDFM_PROPERTY_DEFAULTS_HH
diff --git a/dumux/implicit/2pdfm/2pdfmvolumevariables.hh b/dumux/implicit/2pdfm/2pdfmvolumevariables.hh
index 4a4a065cca..8ec6e8e638 100644
--- a/dumux/implicit/2pdfm/2pdfmvolumevariables.hh
+++ b/dumux/implicit/2pdfm/2pdfmvolumevariables.hh
@@ -20,8 +20,8 @@
* \brief Contains the quantities which are constant within a
* finite volume in the two-phase discrete fracture-matrix model.
*/
-#ifndef DUMUX_BOXMODELS_2PDFM_VOLUME_VARIABLES_HH
-#define DUMUX_BOXMODELS_2PDFM_VOLUME_VARIABLES_HH
+#ifndef DUMUX_MODELS_2PDFM_VOLUME_VARIABLES_HH
+#define DUMUX_MODELS_2PDFM_VOLUME_VARIABLES_HH
#include <dune/common/fvector.hh>
@@ -32,7 +32,7 @@
namespace Dumux
{
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the two-phase discrete fracture-matrix model.
@@ -387,4 +387,4 @@ private:
};
} // end namespace
-#endif // DUMUX_BOXMODELS_2PDFM_VOLUME_VARIABLES_HH
+#endif // DUMUX_MODELS_2PDFM_VOLUME_VARIABLES_HH
diff --git a/test/implicit/2pdfm/2pdfmspatialparams.hh b/test/implicit/2pdfm/2pdfmspatialparams.hh
index 39f2a7b0b4..2a5886ca06 100644
--- a/test/implicit/2pdfm/2pdfmspatialparams.hh
+++ b/test/implicit/2pdfm/2pdfmspatialparams.hh
@@ -58,10 +58,10 @@ public:
};
}
/*!
- * \ingroup TwoPBoxModel
+ * \ingroup TwoPModel
* \ingroup ImplicitTestProblems
* \brief The spatial parameters for the 2PDFMProblem which uses the
- * twophase box model
+ * twophase model
*/
template<class TypeTag>
class TwoPDFMSpatialParams : public ImplicitSpatialParams<TypeTag>
diff --git a/test/implicit/2pdfm/2pdfmtestproblem.hh b/test/implicit/2pdfm/2pdfmtestproblem.hh
index 05c6b451bb..1641a4226b 100644
--- a/test/implicit/2pdfm/2pdfmtestproblem.hh
+++ b/test/implicit/2pdfm/2pdfmtestproblem.hh
@@ -105,7 +105,7 @@ SET_BOOL_PROP(TwoPDFMTestProblem, ProblemEnableGravity, false);
}
/*!
- * \ingroup TwoPDFMBoxModel
+ * \ingroup TwoPDFMModel
* \ingroup ImplicitTestProblems
* \brief Soil contamination problem involving a DNAPL migration into a
* fully water saturated media
--
GitLab