[doxygen] Adapt documentation for multidomain tests

test/multidomain/boundary/darcydarcy/1p_1p/main.cc

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief Test for the equal dimension boundary coupling model
+ * \ingroup BoundaryTests
+ * \brief Test for the equal dimension boundary coupling model.
  */
+
 #include <config.h>
 
 #include <ctime>

test/multidomain/boundary/darcydarcy/1p_1p/problem.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup OnePTests
- * \brief The properties for the incompressible test
+ * \ingroup BoundaryTests
+ * \brief The properties for the incompressible test.
  */
+
 #ifndef DUMUX_ONEP_SUB_TEST_PROBLEM_HH
 #define DUMUX_ONEP_SUB_TEST_PROBLEM_HH
 
@@ -31,8 +32,8 @@
 namespace Dumux {
 
 /*!
- * \ingroup OnePTests
- * \brief  Multidomain test problem for the incompressible one-phase model
+ * \ingroup BoundaryTests
+ * \brief Multidomain test problem for the incompressible one-phase model.
  *
  * Two possibilities to divide the model domain are given:
  * half: a horizontal interface splits the domain in two equally sized subdomains
@@ -103,11 +104,10 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a neumann
-     *        boundary segment.
+     * \brief Evaluates the boundary conditions for a Neumann boundary segment.
      *
      * This is the method for the case where the Neumann condition is
-     * potentially solution dependent
+     * potentially solution dependent.
      *
      * \param element The finite element
      * \param fvGeometry The finite-volume geometry
@@ -132,8 +132,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a dirichlet
-     *        control volume.
+     * \brief Evaluates the boundary conditions for a Dirichlet control volume.
      *
      * \param globalPos The center of the finite volume which ought to be set.
      *
@@ -159,7 +158,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the initial value for a control volume.
+     * \brief Evaluates the initial value for a control volume.
      *
      * \param globalPos The global position
      */

test/multidomain/boundary/darcydarcy/1p_1p/spatialparams.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup OnePTests
- * \brief The spatial params the incompressible test
+ * \ingroup BoundaryTests
+ * \brief The spatial parameters for the incompressible test.
  */
+
 #ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
 #define DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
 
@@ -30,11 +31,11 @@
 namespace Dumux {
 namespace LensSpatialParams {
 /*!
- * \brief If a point is in a lens with a given bounding box
+ * \brief Returns if a point is in a lens with a given bounding box
  *
- * \param globalPos the position of the point
- * \param lensLowerLeft the lower left corner of the lens
- * \param lensUpperRight the upper right corner of the lens
+ * \param globalPos The position of the point
+ * \param lensLowerLeft The lower left corner of the lens
+ * \param lensUpperRight The upper right corner of the lens
  */
 template<class GlobalPosition>
 bool pointInLens(const GlobalPosition& globalPos,
@@ -51,9 +52,9 @@ bool pointInLens(const GlobalPosition& globalPos,
 } // end namespace LensSpatialParams
 
 /*!
- * \ingroup OnePTests
+ * \ingroup BoundaryTests
  * \brief The spatial parameters class for the test problem using the
- *        incompressible 1p model
+ *        incompressible 1p model.
  */
 template<class FVGridGeometry, class Scalar>
 class OnePTestSpatialParams
@@ -82,13 +83,14 @@ public:
 
     /*!
      * \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
-     * \return the intrinsic permeability
+     *
+     * \return The intrinsic permeability
      */
     PermeabilityType permeabilityAtPos(const GlobalPosition& globalPos) const
     { return isInLens_(globalPos) ? permeabilityLens_ : permeability_; }
 
     /*!
-     * \brief Define the porosity \f$\mathrm{[-]}\f$.
+     * \brief Defines the porosity \f$\mathrm{[-]}\f$.
      *
      * \param globalPos The global position
      */

test/multidomain/boundary/darcydarcy/1p_2p/main.cc

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief Test for the equal dimension boundary coupling model
+ * \ingroup BoundaryTests
+ * \brief Test for the equal dimension boundary coupling model.
  */
+
 #include <config.h>
 
 #include <ctime>

test/multidomain/boundary/darcydarcy/1p_2p/problem.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup OnePTests
- * \brief The properties for the incompressible test
+ * \ingroup BoundaryTests
+ * \brief The properties for the incompressible test.
  */
+
 #ifndef DUMUX_ONEP_SUB_TEST_PROBLEM_HH
 #define DUMUX_ONEP_SUB_TEST_PROBLEM_HH
 
@@ -31,8 +32,8 @@
 namespace Dumux {
 
 /*!
- * \ingroup OnePTests
- * \brief  Multidomain test problem for the incompressible one-phase model
+ * \ingroup BoundaryTests
+ * \brief  Multidomain test problem for the incompressible one-phase model.
  *
  * The circular model domain consists of two subdomains:
  * an inner circle and an outer ring.
@@ -99,11 +100,10 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a neumann
-     *        boundary segment.
+     * \brief Evaluates the boundary conditions for a Neumann boundary segment.
      *
      * This is the method for the case where the Neumann condition is
-     * potentially solution dependent
+     * potentially solution dependent.
      *
      * \param element The finite element
      * \param fvGeometry The finite-volume geometry
@@ -128,8 +128,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a dirichlet
-     *        control volume.
+     * \brief Evaluates the boundary conditions for a Dirichlet control volume.
      *
      * \param globalPos The center of the finite volume which ought to be set.
      *
@@ -145,8 +144,7 @@ public:
     }
 
     /*!
-     * \brief Applies a vector of point sources. The point sources
-     *        are possibly solution dependent.
+     * \brief Applies a vector of point sources which are possibly solution dependent.
      *
      * \param pointSources A vector of PointSource s that contain
               source values for all phases and space positions.
@@ -180,7 +178,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the initial value for a control volume.
+     * \brief Evaluates the initial value for a control volume.
      *
      * \param globalPos The global position
      */

test/multidomain/boundary/darcydarcy/1p_2p/spatialparams.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup OnePTests
- * \brief The spatial params the incompressible test
+ * \ingroup BoundaryTests
+ * \brief The spatial parameters for the incompressible test.
  */
+
 #ifndef DUMUX_MULTIDOMAIN_1P_2P_TEST_SPATIAL_PARAMS_HH
 #define DUMUX_MULTIDOMAIN_1P_2P_TEST_SPATIAL_PARAMS_HH
 
@@ -31,9 +32,9 @@
 namespace Dumux {
 
 /*!
- * \ingroup OnePTests
+ * \ingroup BoundaryTests
  * \brief The spatial parameters class for the test problem using the
- *        incompressible 1p model
+ *        incompressible 1p model.
  */
 template<class FVGridGeometry, class Scalar>
 class TestSpatialParams
@@ -74,7 +75,7 @@ public:
     }
 
     /*!
-     * \brief Define the porosity \f$\mathrm{[-]}\f$.
+     * \brief Defines the porosity \f$\mathrm{[-]}\f$.
      *
      * \param globalPos The global position
      */

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/main.cc

@@ -18,9 +18,11 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief A test problem for the coupled Stokes/Darcy problem (1p2c) comparing different diffusion laws
+ * \ingroup BoundaryTests
+ * \brief A test problem for the coupled Stokes/Darcy problem (1p2c)
+ *        comparing different diffusion laws.
  */
+
 #include <config.h>
 
 #include <ctime>

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_darcy.hh

@@ -18,9 +18,11 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief A simple Darcy test problem (cell-centered finite volume method) for the comparison of different diffusion laws.
+ * \ingroup BoundaryTests
+ * \brief A simple Darcy test problem (cell-centered finite volume method) for
+ *        the comparison of different diffusion laws.
  */
+
 #ifndef DUMUX_DARCY_SUBPROBLEM_DIFFUSION_COMPARISON_HH
 #define DUMUX_DARCY_SUBPROBLEM_DIFFUSION_COMPARISON_HH
 
@@ -45,13 +47,11 @@
 #define DIFFUSIONTYPE FicksLaw<TypeTag>
 #endif
 
-namespace Dumux
-{
+namespace Dumux {
 template <class TypeTag>
 class DarcySubProblem;
 
-namespace Properties
-{
+namespace Properties {
 // Create new type tags
 namespace TTag {
 struct DarcyOnePTwoC { using InheritsFrom = std::tuple<OnePNC, CCTpfaModel>; };
@@ -98,7 +98,7 @@ struct SpatialParams<TypeTag, TTag::DarcyOnePTwoC>
     using Scalar = GetPropType<TypeTag, Properties::Scalar>;
     using type = OnePSpatialParams<FVGridGeometry, Scalar>;
 };
-}
+} // end namespace Properties
 
 template <class TypeTag>
 class DarcySubProblem : public PorousMediumFlowProblem<TypeTag>
@@ -148,8 +148,7 @@ public:
     // \{
 
     /*!
-     * \brief Returns true if a restart file should be written to
-     *        disk.
+     * \brief Returns true if a restart file should be written to disk.
      */
     bool shouldWriteRestartFile() const
     { return false; }
@@ -163,7 +162,7 @@ public:
     { return true; }
 
     /*!
-     * \brief Return the temperature within the domain in [K].
+     * \brief Returns the temperature within the domain in [K].
      *
      */
     Scalar temperature() const
@@ -194,7 +193,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a Neumann control volume.
+     * \brief Evaluates the boundary conditions for a Neumann control volume.
      *
      * \param element The element for which the Neumann boundary condition is set
      * \param fvGeometry The fvGeometry
@@ -224,13 +223,13 @@ 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.
      *
      * \param element The element for which the source term is set
      * \param fvGeometry The fvGeometry
      * \param elemVolVars The element volume variables
-     * \param scv The subcontrolvolume
+     * \param scv The sub control volume
      */
     template<class ElementVolumeVariables>
     NumEqVector source(const Element &element,
@@ -242,7 +241,7 @@ public:
     // \}
 
     /*!
-     * \brief Evaluate the initial value for a control volume.
+     * \brief Evaluates the initial value for a control volume.
      *
      * \param element The element
      *
@@ -283,6 +282,6 @@ private:
 
     std::shared_ptr<CouplingManager> couplingManager_;
 };
-} //end namespace
+} // end namespace Dumux
 
 #endif //DUMUX_DARCY_SUBPROBLEM_HH

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/diffusionlawcomparison/problem_stokes.hh

@@ -18,9 +18,15 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup NavierStokesTests
- * \brief A simple Navier-Stokes test problem for the staggered grid (Navier-)Stokes model. This test uses the same set-up as the horizontal test but uses a harmonic averaging of the diffusion coefficients at the interface for ficks law and comares the solution with the maxwell stefan coupling
+ * \ingroup BoundaryTests
+ * \brief A simple Navier-Stokes test problem for the staggered grid
+ *        (Navier-)Stokes model.
+ *
+ * This test uses the same set-up as the horizontal test but uses a harmonic
+ * averaging of the diffusion coefficients at the interface for Fick's law and
+ * compares the solution with the Maxwell-Stefan coupling.
  */
+
 #ifndef DUMUX_STOKES_SUBPROBLEM_DIFFUSION_COMPARISON_HH
 #define DUMUX_STOKES_SUBPROBLEM_DIFFUSION_COMPARISON_HH
 
@@ -41,13 +47,11 @@
 #define DIFFUSIONTYPE FicksLaw<TypeTag>
 #endif
 
-namespace Dumux
-{
+namespace Dumux {
 template <class TypeTag>
 class StokesSubProblem;
 
-namespace Properties
-{
+namespace Properties {
 // Create new type tags
 namespace TTag {
 struct StokesOnePTwoC { using InheritsFrom = std::tuple<NavierStokesNC, StaggeredFreeFlowModel>; };
@@ -88,11 +92,11 @@ struct MolecularDiffusionType<TypeTag, TTag::StokesOnePTwoC> { using type = DIFF
 // Do not replace one equation with a total mass balance
 template<class TypeTag>
 struct ReplaceCompEqIdx<TypeTag, TTag::StokesOnePTwoC> { static constexpr int value = 3; };
-}
+} // end namespace Properties
 
 /*!
- * \ingroup NavierStokesTests
- * \brief  Test problem for the 1pnc (Navier-) Stokes problem.
+ * \ingroup BoundaryTests
+ * \brief Test problem for the 1pnc (Navier-) Stokes problem.
  *
  * Horizontal flow from left to right with a parabolic velocity profile.
  */
@@ -135,7 +139,7 @@ public:
     { return false; }
 
    /*!
-     * \brief Return the temperature within the domain in [K].
+     * \brief Returns the temperature within the domain in [K].
      *
      * This problem assumes a temperature of 10 degrees Celsius.
      */
@@ -143,7 +147,7 @@ public:
     { return 273.15 + 10; } // 10°C
 
    /*!
-     * \brief Return the sources within the domain.
+     * \brief Returns the sources within the domain.
      *
      * \param globalPos The global position
      */
@@ -201,7 +205,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a Dirichlet control volume.
+     * \brief Evaluates the boundary conditions for a Dirichlet control volume.
      */
     PrimaryVariables dirichletAtPos(const GlobalPosition& globalPos) const
     {
@@ -216,7 +220,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a Neumann control volume.
+     * \brief Evaluates the boundary conditions for a Neumann control volume.
      *
      * \param element The element for which the Neumann boundary condition is set
      * \param fvGeometry The fvGeometry
@@ -256,7 +260,7 @@ public:
     // \{
 
    /*!
-     * \brief Evaluate the initial value for a control volume.
+     * \brief Evaluates the initial value for a control volume.
      *
      * \param globalPos The global position
      */
@@ -273,7 +277,8 @@ public:
     }
 
     /*!
-     * \brief Returns the intrinsic permeability of required as input parameter for the Beavers-Joseph-Saffman boundary condition
+     * \brief Returns the intrinsic permeability of required as input parameter
+     *        for the Beavers-Joseph-Saffman boundary condition.
      */
     Scalar permeability(const Element& element, const SubControlVolumeFace& scvf) const
     {
@@ -281,7 +286,8 @@ public:
     }
 
     /*!
-     * \brief Returns the alpha value required as input parameter for the Beavers-Joseph-Saffman boundary condition
+     * \brief Returns the alpha value required as input parameter for the
+     *        Beavers-Joseph-Saffman boundary condition.
      */
     Scalar alphaBJ(const SubControlVolumeFace& scvf) const
     {
@@ -321,6 +327,6 @@ private:
 
     std::shared_ptr<CouplingManager> couplingManager_;
 };
-} //end namespace
+} // end namespace Dumux
 
 #endif // DUMUX_STOKES_SUBPROBLEM_HH

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/main.cc

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
- * \brief A test problem for the coupled Stokes/Darcy problem (1p)
+ * \ingroup BoundaryTests
+ * \brief A test problem for the coupled Stokes/Darcy problem (1p).
  */
+
 #include <config.h>
 
 #include <ctime>

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_darcy.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- *
+ * \ingroup BoundaryTests
  * \brief A simple Darcy test problem (cell-centered finite volume method).
  */
+
 #ifndef DUMUX_DARCY_SUBPROBLEM_HH
 #define DUMUX_DARCY_SUBPROBLEM_HH
 
@@ -37,13 +38,11 @@
 #include <dumux/material/fluidsystems/h2oair.hh>
 #include <dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh>
 
-namespace Dumux
-{
+namespace Dumux {
 template <class TypeTag>
 class DarcySubProblem;
 
-namespace Properties
-{
+namespace Properties {
 // Create new type tags
 namespace TTag {
 struct DarcyOnePTwoC { using InheritsFrom = std::tuple<OnePNC, CCTpfaModel>; };
@@ -87,7 +86,7 @@ struct SpatialParams<TypeTag, TTag::DarcyOnePTwoC>
     using Scalar = GetPropType<TypeTag, Properties::Scalar>;
     using type = OnePSpatialParams<FVGridGeometry, Scalar>;
 };
-}
+} // end namespace Dumux
 
 template <class TypeTag>
 class DarcySubProblem : public PorousMediumFlowProblem<TypeTag>
@@ -130,7 +129,7 @@ public:
     }
 
     /*!
-     * \brief Return the temperature within the domain in [K].
+     * \brief Returns the temperature within the domain in [K].
      *
      */
     Scalar temperature() const
@@ -167,7 +166,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a Dirichlet control volume.
+     * \brief Evaluates the boundary conditions for a Dirichlet control volume.
      *
      * \param element The element for which the Dirichlet boundary condition is set
      * \param scvf The boundary subcontrolvolumeface
@@ -201,7 +200,7 @@ public:
     }
 
     /*!
-     * \brief Evaluate the boundary conditions for a Neumann control volume.
+     * \brief Evaluates the boundary conditions for a Neumann control volume.
      *
      * \param element The element for which the Neumann boundary condition is set
      * \param fvGeometry The fvGeometry
@@ -231,13 +230,13 @@ 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.
      *
      * \param element The element for which the source term is set
      * \param fvGeometry The fvGeometry
      * \param elemVolVars The element volume variables
-     * \param scv The subcontrolvolume
+     * \param scv The sub control volume
      */
     template<class ElementVolumeVariables>
     NumEqVector source(const Element &element,
@@ -249,7 +248,7 @@ public:
     // \}
 
     /*!
-     * \brief Evaluate the initial value for a control volume.
+     * \brief Evaluates the initial value for a control volume.
      *
      * \param element The element
      *
@@ -271,13 +270,13 @@ public:
     { return *couplingManager_; }
 
     /*!
-     * \brief Sets the time loop pointer
+     * \brief Sets the time loop pointer.
      */
     void setTimeLoop(TimeLoopPtr timeLoop)
     { timeLoop_ = timeLoop; }
 
     /*!
-     * \brief Returns the time
+     * \brief Returns the time.
      */
     Scalar time() const
     { return timeLoop_->time(); }
@@ -301,6 +300,6 @@ private:
     std::shared_ptr<CouplingManager> couplingManager_;
     TimeLoopPtr timeLoop_;
 };
-} //end namespace
+} // end namespace Dumux
 
 #endif //DUMUX_DARCY_SUBPROBLEM_HH

test/multidomain/boundary/stokesdarcy/1p2c_1p2c/problem_stokes.hh

@@ -18,9 +18,10 @@
  *****************************************************************************/
 /*!
  * \file
- * \ingroup NavierStokesTests
+ * \ingroup BoundaryTests
  * \brief A simple Navier-Stokes test problem for the staggered grid (Navier-)Stokes model.
  */
+
 #ifndef DUMUX_STOKES_SUBPROBLEM_HH
 #define DUMUX_STOKES_SUBPROBLEM_HH
 
@@ -33,13 +34,11 @@
 #include <dumux/discretization/staggered/freeflow/properties.hh>
 #include <dumux/freeflow/compositional/navierstokesncmodel.hh>
 
-namespace Dumux
-{
+namespace Dumux {
 template <class TypeTag>
 class StokesSubProblem;