[doxygen] Adapt documentation for geomechanics tests

test/geomechanics/elastic/main.cc

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief test for the one-phase CC model
+ * \ingroup GeomechanicsTests
+ * \brief Test for the linear elastic model.
  */
+
 #include <config.h>
 
 #include <ctime>

test/geomechanics/elastic/problem.hh

@@ -16,10 +16,12 @@
  *   You should have received a copy of the GNU General Public License       *
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
  *****************************************************************************/
-/**
+/*!
  * \file
- * \brief Definition of a test problem for the linear elastic model
+ * \ingroup GeomechanicsTests
+ * \brief Definition of a test problem for the linear elastic model.
  */
+
 #ifndef DUMUX_ELASTICPROBLEM_HH
 #define DUMUX_ELASTICPROBLEM_HH
 
@@ -54,13 +56,11 @@ struct SpatialParams<TypeTag, TTag::TestElastic>
 { using type = ElasticSpatialParams< GetPropType<TypeTag, Properties::Scalar>,
                                      GetPropType<TypeTag, Properties::FVGridGeometry> >;
 };
-}
+} // end namespace Properties
 
 /*!
- * \ingroup Geomechanics
- * \ingroup Elastic
- *
- * \brief Problem definition for the deformation of an elastic body
+ * \ingroup GeomechanicsTests
+ * \brief Problem definition for the deformation of an elastic body.
  */
 template<class TypeTag>
 class ElasticProblem : public GeomechanicsFVProblem<TypeTag>
@@ -89,19 +89,18 @@ class ElasticProblem : public GeomechanicsFVProblem<TypeTag>
     using GradU = Dune::FieldMatrix<Scalar, dim, dimWorld>;
 
 public:
-    //! The constructor
     ElasticProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
     : ParentType(fvGridGeometry) {}
 
-    //! The temperature in the domain
+    //! Returns the temperature in the domain.
     static constexpr Scalar temperature()
     { return 273.15; }
 
-    //! Evaluate the initial value for a control volume.
+    //! Evaluates the initial value for a control volume.
     PrimaryVariables initialAtPos(const GlobalPosition& globalPos) const
     { return PrimaryVariables(0.0); }
 
-    //! Evaluate the boundary conditions for a Dirichlet boundary segment.
+    //! Evaluates the boundary conditions for a Dirichlet boundary segment.
     PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const
     { return PrimaryVariables(0.0); }
 
@@ -124,6 +123,7 @@ public:
         return values;
     }
 
+    //! Evaluates the boundary conditions for a Neumann boundary segment.
     NumEqVector neumann(const Element& element,
                         const FVElementGeometry& fvGeometry,
                         const ElementVolumeVariables& elemVolvars,
@@ -152,8 +152,8 @@ public:
     }
 
     /*!
-     * \brief Evaluate the source term for all phases within a given
-     *        sub-control-volume.
+     * \brief Evaluates the source term for all phases within a given
+     *        sub-control volume.
      */
     NumEqVector source(const Element& element,
                        const FVElementGeometry& fvGeometry,
@@ -195,7 +195,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the exact displacement to this problem at a given position.
+     * \brief Evaluates the exact displacement to this problem at a given position.
      */
     PrimaryVariables exactSolution(const GlobalPosition& globalPos) const
     {
@@ -211,7 +211,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the exact displacement gradient to this problem at a given position.
+     * \brief Evaluates the exact displacement gradient to this problem at a given position.
      */
     GradU exactGradient(const GlobalPosition& globalPos) const
     {
@@ -236,6 +236,6 @@ private:
     static constexpr Scalar eps_ = 3e-6;
 };
 
-} //end namespace
+} // end namespace Dumux
 
 #endif

test/geomechanics/elastic/spatialparams.hh

@@ -18,21 +18,21 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Definition of the spatial parameters for the linear elasticity problem
+ * \ingroup GeomechanicsTests
+ * \brief Definition of the spatial parameters for the linear elasticity problem.
  */
+
 #ifndef DUMUX_ELASTIC_SPATIAL_PARAMS_HH
 #define DUMUX_ELASTIC_SPATIAL_PARAMS_HH
 
 #include <dumux/geomechanics/lameparams.hh>
 #include <dumux/material/spatialparams/fvelastic.hh>
 
-namespace Dumux
-{
+namespace Dumux {
 
 /*!
- * \ingroup Geomechanics
- * \ingroup Elastic
- * \brief Definition of the spatial parameters for the linear elasticity problem
+ * \ingroup GeomechanicsTests
+ * \brief Definition of the spatial parameters for the linear elasticity problem.
  */
 template<class Scalar, class FVGridGeometry>
 class ElasticSpatialParams : public FVSpatialParamsElastic< Scalar,
@@ -48,10 +48,9 @@ class ElasticSpatialParams : public FVSpatialParamsElastic< Scalar,
     using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
 
 public:
-    //! export the type of the lame parameters
+    //! Export the type of the lame parameters
     using LameParams = Dumux::LameParams<Scalar>;
 
-    //! The constructor
     ElasticSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
     : ParentType(fvGridGeometry)
     {
@@ -59,12 +58,12 @@ public:
         lameParams_.setMu(3e9);
     }
 
-    //! Define the Lame parameters
+    //! Defines the Lame parameters.
     const LameParams& lameParamsAtPos(const GlobalPosition& globalPos) const
     { return lameParams_; }
 
 private:
     LameParams lameParams_;
 };
-}
+} // end namespace Dumux
 #endif

test/geomechanics/poroelastic/main.cc

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief test for the one-phase CC model
+ * \ingroup GeomechanicsTests
+ * \brief Test for the poro-elastic model.
  */
+
 #include <config.h>
 
 #include <ctime>

test/geomechanics/poroelastic/problem.hh

@@ -16,10 +16,12 @@
  *   You should have received a copy of the GNU General Public License       *
  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
  *****************************************************************************/
-/**
+/*!
  * \file
- * \brief Definition of a test problem for the poro-elastic model
+ * \ingroup GeomechanicsTests
+ * \brief Definition of a test problem for the poro-elastic model.
  */
+
 #ifndef DUMUX_POROELASTIC_PROBLEM_HH
 #define DUMUX_POROELASTIC_PROBLEM_HH
 
@@ -65,13 +67,11 @@ struct SpatialParams<TypeTag, TTag::TestPoroElastic>
     using type = PoroElasticSpatialParams< GetPropType<TypeTag, Properties::Scalar>,
                                            GetPropType<TypeTag, Properties::FVGridGeometry> >;
 };
-}
+} // end namespace Properties
 
 /*!
- * \ingroup Geomechanics
- * \ingroup PoroElastic
- *
- * \brief Problem definition for the deformation of a poro-elastic body
+ * \ingroup GeomechanicsTests
+ * \brief Problem definition for the deformation of a poro-elastic body.
  */
 template<class TypeTag>
 class PoroElasticProblem : public GeomechanicsFVProblem<TypeTag>
@@ -100,25 +100,25 @@ class PoroElasticProblem : public GeomechanicsFVProblem<TypeTag>
     using GradU = Dune::FieldMatrix<Scalar, dim, dimWorld>;
 
 public:
-    //! The constructor
     PoroElasticProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
     : ParentType(fvGridGeometry)
     {}
 
-    //! The temperature in the domain
+    //! Returns the temperature in the domain.
     static constexpr Scalar temperature()
     { return 273.15; }
 
-    //! Evaluate the initial value for a control volume.
+    //! Evaluates the initial value for a control volume.
     PrimaryVariables initialAtPos(const GlobalPosition& globalPos) const
     { return PrimaryVariables(0.0); }
 
-    //! Evaluate the boundary conditions for a Dirichlet boundary segment.
+    //! Evaluates the boundary conditions for a Dirichlet boundary segment.
     PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const
     { return PrimaryVariables(0.0); }
 
     /*!
-     * \brief Returns the effective fluid density
+     * \brief Returns the effective fluid density.
+     *
      * \param globalPos The global position
      */
     Scalar effectiveFluidDensityAtPos(const GlobalPosition& globalPos) const
@@ -131,6 +131,7 @@ public:
 
     /*!
      * \brief Returns the effective pore pressure
+     *
      * \note We use the x-displacement as pressure solution. The shift to
      *       higher values is done to see a mor pronounced effect in stresses.
      *
@@ -142,6 +143,7 @@ public:
     /*!
      * \brief Specifies which kind of boundary condition should be
      *        used for which equation on a given boundary segment.
+     *
      * \param globalPos The global position
      */
     BoundaryTypes boundaryTypesAtPos(const GlobalPosition& globalPos) const
@@ -152,8 +154,8 @@ public:
     }
 
     /*!
-     * \brief Evaluate the source term for all phases within a given
-     *        sub-control-volume.
+     * \brief Evaluates the source term for all phases within a given
+     *        sub-control volume.
      */
     NumEqVector source(const Element& element,
                        const FVElementGeometry& fvGeometry,
@@ -195,7 +197,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the exact displacement to this problem at a given position.
+     * \brief Evaluates the exact displacement to this problem at a given position.
      */
     PrimaryVariables exactSolution(const GlobalPosition& globalPos) const
     {
@@ -211,7 +213,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the exact displacement gradient to this problem at a given position.
+     * \brief Evaluates the exact displacement gradient to this problem at a given position.
      */
     GradU exactGradient(const GlobalPosition& globalPos) const
     {
@@ -236,6 +238,6 @@ private:
     static constexpr Scalar eps_ = 3e-6;
 };
 
-} //end namespace
+} // end namespace Dumux
 
 #endif

test/geomechanics/poroelastic/spatialparams.hh

@@ -18,8 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \brief Definition of the spatial parameters for the poro-elastic problem
+ * \ingroup GeomechanicsTests
+ * \brief Definition of the spatial parameters for the poro-elastic problem.
  */
+
 #ifndef DUMUX_POROELASTIC_SPATIAL_PARAMS_HH
 #define DUMUX_POROELASTIC_SPATIAL_PARAMS_HH
 
@@ -30,9 +32,8 @@
 namespace Dumux {
 
 /*!
- * \ingroup Geomechanics
- * \ingroup PoroElastic
- * \brief Definition of the spatial parameters for the poro-elastic problem
+ * \ingroup GeomechanicsTests
+ * \brief Definition of the spatial parameters for the poro-elastic problem.
  */
 template<class Scalar, class FVGridGeometry>
 class PoroElasticSpatialParams : public FVSpatialParamsPoroElastic< Scalar,
@@ -48,10 +49,9 @@ class PoroElasticSpatialParams : public FVSpatialParamsPoroElastic< Scalar,
     using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
 
 public:
-    //! export the type of the lame parameters
+    //! Export the type of the lame parameters
     using LameParams = Dumux::LameParams<Scalar>;
 
-    //! The constructor
     PoroElasticSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
     : ParentType(fvGridGeometry)
     {
@@ -59,11 +59,11 @@ public:
         lameParams_.setMu(2);
     }
 
-    //! Define the Lame parameters
+    //! Defines the Lame parameters.
     const LameParams& lameParamsAtPos(const GlobalPosition& globalPos) const
     { return lameParams_; }
 
-    //! Return the porosity of the porous medium
+    //! Returns the porosity of the porous medium.
     template< class ElemSol >
     Scalar porosity(const Element& element,
                     const SubControlVolume& scv,
@@ -73,7 +73,7 @@ public:
         return poroLaw.evaluatePorosity(this->fvGridGeometry(), element, scv, elemSol, /*refPoro*/0.3);
     }
 
-    //! Return the biot coefficient of the porous medium
+    //! Returns the Biot coefficient of the porous medium.
     Scalar biotCoefficientAtPos(const GlobalPosition& globalPos) const
     { return 1.0; }