From c066eb47e10088712f5dd70239c4a888272f75c8 Mon Sep 17 00:00:00 2001
From: Markus Wolff <markus.wolff@twt-gmbh.de>
Date: Tue, 21 Feb 2012 10:49:46 +0000
Subject: [PATCH] improved doxygen documentation
- added Properties as submodul of sequential models
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7840 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
doc/doxygen/modules | 2 +-
dumux/decoupled/1p/1pproperties.hh | 2 +-
.../1p/diffusion/diffusionproperties1p.hh | 2 +-
dumux/decoupled/2p/2pproperties.hh | 2 +-
.../2p/diffusion/diffusionproperties2p.hh | 2 +-
.../2p/diffusion/fv/fvpressureproperties2p.hh | 2 +-
.../fv/fvpressureproperties2padaptive.hh | 2 +-
.../fvmpfa/fvmpfaopressureproperties2p.hh | 2 +-
.../mimetic/mimeticpressureproperties2p.hh | 2 +-
dumux/decoupled/2p/impes/impesproperties2p.hh | 2 +-
.../2p/impes/impesproperties2padaptive.hh | 2 +-
.../2p/transport/fv/fvtransportproperties2p.hh | 2 +-
.../2p/transport/transportproperties2p.hh | 2 +-
dumux/decoupled/2p2c/2p2cproperties.hh | 4 +++-
dumux/decoupled/common/decoupledproperties.hh | 4 +---
.../common/fv/mpfa/fvmpfaproperties.hh | 17 ++++++++++++-----
dumux/decoupled/common/gridadapt.hh | 2 +-
dumux/decoupled/common/gridadaptproperties.hh | 4 ++--
dumux/decoupled/common/impetproperties.hh | 2 +-
.../common/mimetic/mimeticproperties.hh | 10 +++++-----
dumux/decoupled/common/pressureproperties.hh | 4 ++--
dumux/decoupled/common/transportproperties.hh | 4 ++--
.../decoupled/common/variableclass_adaptive.hh | 2 +-
23 files changed, 43 insertions(+), 36 deletions(-)
diff --git a/doc/doxygen/modules b/doc/doxygen/modules
index a63ec759f2..20f483b875 100644
--- a/doc/doxygen/modules
+++ b/doc/doxygen/modules
@@ -277,7 +277,7 @@
*/
/*!
* \ingroup Sequential
- * \defgroup IMPETbc Boundary Conditions
+ * \defgroup IMPETProperties Properties
*/
/*!
* \ingroup Sequential
diff --git a/dumux/decoupled/1p/1pproperties.hh b/dumux/decoupled/1p/1pproperties.hh
index e29115ec07..447f95ebc8 100644
--- a/dumux/decoupled/1p/1pproperties.hh
+++ b/dumux/decoupled/1p/1pproperties.hh
@@ -24,7 +24,7 @@
/*!
* \ingroup OnePhase
- * \ingroup Properties
+ * \ingroup IMPETProperties
* \file
*
* \brief Defines the properties required for the single phase sequential model.
diff --git a/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh b/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh
index fa9f414a8a..9deb0edbc6 100644
--- a/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh
+++ b/dumux/decoupled/1p/diffusion/diffusionproperties1p.hh
@@ -27,7 +27,7 @@
/*!
* \ingroup Pressure1p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/2pproperties.hh b/dumux/decoupled/2p/2pproperties.hh
index fe6e177947..ca2d46af5a 100644
--- a/dumux/decoupled/2p/2pproperties.hh
+++ b/dumux/decoupled/2p/2pproperties.hh
@@ -24,7 +24,7 @@
/*!
* \ingroup IMPES
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
index 935f50501f..f3fea85309 100644
--- a/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
+++ b/dumux/decoupled/2p/diffusion/diffusionproperties2p.hh
@@ -27,7 +27,7 @@
/*!
* \ingroup Pressure2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh
index 5a5daff52b..03b7c580d0 100644
--- a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh
+++ b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2p.hh
@@ -22,7 +22,7 @@
/*!
* \ingroup FVPressure2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh
index 2b1f643827..4e345eeb13 100644
--- a/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh
+++ b/dumux/decoupled/2p/diffusion/fv/fvpressureproperties2padaptive.hh
@@ -22,7 +22,7 @@
/*!
* \ingroup FVPressure2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh
index 04eb3d708c..5dad064608 100644
--- a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh
+++ b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressureproperties2p.hh
@@ -23,7 +23,7 @@
/*!
* \ingroup FVPressure2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
* \file
*
* \brief Properties for two-phase finite volume model with MPFA-O method.
diff --git a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh
index 7ccc632c4d..9d4e62f717 100644
--- a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh
+++ b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressureproperties2p.hh
@@ -23,7 +23,7 @@
*****************************************************************************/
/*!
* \ingroup MimeticPressure2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/impes/impesproperties2p.hh b/dumux/decoupled/2p/impes/impesproperties2p.hh
index 8676ae96d3..f6c94bfed8 100644
--- a/dumux/decoupled/2p/impes/impesproperties2p.hh
+++ b/dumux/decoupled/2p/impes/impesproperties2p.hh
@@ -27,7 +27,7 @@
/*!
* \ingroup IMPES
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
index 53c720e426..752c8b48c9 100644
--- a/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
+++ b/dumux/decoupled/2p/impes/impesproperties2padaptive.hh
@@ -27,7 +27,7 @@
/*!
* \ingroup IMPES
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh b/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh
index 0379c80ace..38bdef8d95 100644
--- a/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh
+++ b/dumux/decoupled/2p/transport/fv/fvtransportproperties2p.hh
@@ -26,7 +26,7 @@
/*!
* \ingroup FVSaturation2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p/transport/transportproperties2p.hh b/dumux/decoupled/2p/transport/transportproperties2p.hh
index 288545be09..c5326b03ad 100644
--- a/dumux/decoupled/2p/transport/transportproperties2p.hh
+++ b/dumux/decoupled/2p/transport/transportproperties2p.hh
@@ -27,7 +27,7 @@
/*!
* \ingroup Saturation2p
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/2p2c/2p2cproperties.hh b/dumux/decoupled/2p2c/2p2cproperties.hh
index a0f418bd63..ff40676991 100644
--- a/dumux/decoupled/2p2c/2p2cproperties.hh
+++ b/dumux/decoupled/2p2c/2p2cproperties.hh
@@ -21,7 +21,9 @@
*****************************************************************************/
/*!
- * \ingroup IMPEC Properties
+ * \ingroup IMPEC
+ * \ingroup IMPETProperties
+ *
* \file
*
* \brief Defines the properties required for the decoupled 2p2c models.
diff --git a/dumux/decoupled/common/decoupledproperties.hh b/dumux/decoupled/common/decoupledproperties.hh
index 68ef64e1a3..f464664e44 100644
--- a/dumux/decoupled/common/decoupledproperties.hh
+++ b/dumux/decoupled/common/decoupledproperties.hh
@@ -28,7 +28,7 @@
/*!
* \ingroup Sequential
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
@@ -196,8 +196,6 @@ public:
typedef Dumux::BoundaryTypes<numEq> type;
};
-// \}
-
}
}
diff --git a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
index 8dbe1b8539..ec669e6e32 100644
--- a/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
+++ b/dumux/decoupled/common/fv/mpfa/fvmpfaproperties.hh
@@ -22,8 +22,8 @@
*****************************************************************************/
/*!
- * \ingroup Decoupled
- * \ingroup Properties
+ * \ingroup IMPET
+ * \ingroup IMPETProperties
* \file
*
* \brief Properties for a MPFA method.
@@ -45,6 +45,8 @@
namespace Dumux
{
/*!
+ *
+ *
* \brief Indices denoting the different grid types.
*/
struct GridTypes
@@ -61,7 +63,7 @@ public:
//ALUGrid
static const int aluGrid = 4;
};
-
+//! \cond \private
template<class Grid, int dim>
struct GridImp
{
@@ -87,13 +89,15 @@ struct GridImp<Dune::UGGrid<dim>, dim>
static const int imp = GridTypes::ugGrid;
};
#endif
+//! \endcond
namespace Properties
{
+//! Basic Type tag for MFPA models
NEW_TYPE_TAG(MPFAProperties);
-NEW_PROP_TAG( GridTypeIndices );
-NEW_PROP_TAG( GridImplementation ); //returns kind of grid implementation
+NEW_PROP_TAG( GridTypeIndices );//!< The grid type indices to decide which grid is used
+NEW_PROP_TAG( GridImplementation ); //!< Gives kind of grid implementation in form of a GridType
}
}
@@ -103,6 +107,7 @@ namespace Dumux
namespace Properties
{
+//! \cond \private
SET_PROP(MPFAProperties, GridImplementation)
{
private:
@@ -110,7 +115,9 @@ private:
public:
static const int value = GridImp<Grid, Grid::dimension>::imp;
};
+//! \endcond
+//! Set grid type indices
SET_TYPE_PROP(MPFAProperties, GridTypeIndices, GridTypes);
}
diff --git a/dumux/decoupled/common/gridadapt.hh b/dumux/decoupled/common/gridadapt.hh
index 267c179f2c..cad9aed8ae 100644
--- a/dumux/decoupled/common/gridadapt.hh
+++ b/dumux/decoupled/common/gridadapt.hh
@@ -32,7 +32,7 @@
namespace Dumux
{
-/*!
+/*!\ingroup IMPET
* @brief Standard Module for h-adaptive simulations
*
* This class is created by the problem class with the template
diff --git a/dumux/decoupled/common/gridadaptproperties.hh b/dumux/decoupled/common/gridadaptproperties.hh
index 9127f7bdf8..cd8e874041 100644
--- a/dumux/decoupled/common/gridadaptproperties.hh
+++ b/dumux/decoupled/common/gridadaptproperties.hh
@@ -20,8 +20,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \ingroup Properties
- * \ingroup Linear
+ * \ingroup IMPETProperties
+ * \ingroup IMPET
* \file
*
* \brief Defines a type tag and some fundamental properties for
diff --git a/dumux/decoupled/common/impetproperties.hh b/dumux/decoupled/common/impetproperties.hh
index 56814754ee..9c56ae2e1b 100644
--- a/dumux/decoupled/common/impetproperties.hh
+++ b/dumux/decoupled/common/impetproperties.hh
@@ -28,7 +28,7 @@
/*!
* \ingroup IMPET
- * \ingroup Properties
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/common/mimetic/mimeticproperties.hh b/dumux/decoupled/common/mimetic/mimeticproperties.hh
index 73a16f5300..7a4ca6f8b0 100644
--- a/dumux/decoupled/common/mimetic/mimeticproperties.hh
+++ b/dumux/decoupled/common/mimetic/mimeticproperties.hh
@@ -22,13 +22,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \ingroup IMPES
- * \ingroup Properties
+ * \ingroup IMPET
+ * \ingroup IMPETProperties
*/
/*!
* \file
*
- * \brief Defines the properties required for (immiscible) twophase sequential models.
+ * \brief Defines the basic properties required for a mimetic method.
*/
#ifndef DUMUX_MIMETICPROPERTIES_DECOUPLED_HH
@@ -53,14 +53,14 @@ namespace Properties
// Type tags
//////////////////////////////////////////////////////////////////
-//! The type tag for the two-phase problems
+//! The type tag for models using a mimetic method
NEW_TYPE_TAG(Mimetic)
;
//////////////////////////////////////////////////////////////////
// Property tags
//////////////////////////////////////////////////////////////////
-NEW_PROP_TAG( LocalStiffness); //!< The type of communication needed for the mimetic operator
+NEW_PROP_TAG( LocalStiffness); //!< The local mimetic operator
}
}
diff --git a/dumux/decoupled/common/pressureproperties.hh b/dumux/decoupled/common/pressureproperties.hh
index 83dac9d86c..054e07636c 100644
--- a/dumux/decoupled/common/pressureproperties.hh
+++ b/dumux/decoupled/common/pressureproperties.hh
@@ -32,8 +32,8 @@
/*!
- * \ingroup IMPET
- * \ingroup Properties
+ * \ingroup Sequential
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/common/transportproperties.hh b/dumux/decoupled/common/transportproperties.hh
index 7243b933bc..eca6349902 100644
--- a/dumux/decoupled/common/transportproperties.hh
+++ b/dumux/decoupled/common/transportproperties.hh
@@ -25,8 +25,8 @@
#include "decoupledproperties.hh"
/*!
- * \ingroup Saturation2p
- * \ingroup Properties
+ * \ingroup Sequential
+ * \ingroup IMPETProperties
*/
/*!
* \file
diff --git a/dumux/decoupled/common/variableclass_adaptive.hh b/dumux/decoupled/common/variableclass_adaptive.hh
index 91d3d8de78..bb381e60ff 100644
--- a/dumux/decoupled/common/variableclass_adaptive.hh
+++ b/dumux/decoupled/common/variableclass_adaptive.hh
@@ -35,7 +35,7 @@
namespace Dumux
{
/*!
- * \ingroup Sequential
+ * \ingroup IMPET
*/
//! Base class holding the variables and discretized data for sequential models.
/*!
--
GitLab