From 36935f111380490512f501c381f72ea94398e48d Mon Sep 17 00:00:00 2001
From: Sina Ackermann <sina.ackermann@iws.uni-stuttgart.de>
Date: Thu, 21 Dec 2017 14:51:30 +0100
Subject: [PATCH] [doc][freeflow][test] Add ingroup NavierStokesNCTests
---
.../navierstokesnc/channeltestproblem.hh | 28 ++++++-----
.../navierstokesnc/densityflowproblem.hh | 28 ++++++-----
.../navierstokesnc/msfreeflowtestproblem.hh | 47 ++++++++++++-------
3 files changed, 61 insertions(+), 42 deletions(-)
diff --git a/test/freeflow/navierstokesnc/channeltestproblem.hh b/test/freeflow/navierstokesnc/channeltestproblem.hh
index 051e0c789f..8d862bd4a6 100644
--- a/test/freeflow/navierstokesnc/channeltestproblem.hh
+++ b/test/freeflow/navierstokesnc/channeltestproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup NavierStokesNCTests
* \brief Channel flow test for the multi-component staggered grid (Navier-)Stokes model
*/
#ifndef DUMUX_CHANNEL_NC_TEST_PROBLEM_HH
@@ -86,8 +86,9 @@ SET_BOOL_PROP(ChannelNCTestProblem, EnableInertiaTerms, true);
}
/*!
- * \brief Test problem for the one-phase model:
- \todo doc me!
+ * \ingroup NavierStokesNCTests
+ * \brief Test problem for the one-phase model.
+ * \todo doc me!
*/
template <class TypeTag>
class ChannelNCTestProblem : public NavierStokesProblem<TypeTag>
@@ -149,7 +150,7 @@ public:
deltaP_.resize(this->fvGridGeometry().numCellCenterDofs());
}
- /*!
+ /*!
* \name Problem parameters
*/
// \{
@@ -160,7 +161,7 @@ public:
return false;
}
- /*!
+ /*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
@@ -168,7 +169,7 @@ public:
Scalar temperature() const
{ return 273.15 + 10; } // 10C
- /*!
+ /*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
@@ -178,12 +179,12 @@ public:
return SourceValues(0.0);
}
// \}
- /*!
+ /*!
* \name Boundary conditions
*/
// \{
- /*!
+ /*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
@@ -226,7 +227,7 @@ public:
return values;
}
- /*!
+ /*!
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
@@ -253,12 +254,12 @@ public:
// \}
- /*!
+ /*!
* \name Volume terms
*/
// \{
- /*!
+ /*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
@@ -281,8 +282,11 @@ public:
return values;
}
- /*!
+ /*!
* \brief Adds additional VTK output data to the VTKWriter. Function is called by the output module on every write.
+ *
+ * \param gridVariables The grid variables
+ * \param sol The solution vector
*/
void calculateDeltaP(const GridVariables& gridVariables, const SolutionVector& sol)
{
diff --git a/test/freeflow/navierstokesnc/densityflowproblem.hh b/test/freeflow/navierstokesnc/densityflowproblem.hh
index 99a028b53f..ba93090c90 100644
--- a/test/freeflow/navierstokesnc/densityflowproblem.hh
+++ b/test/freeflow/navierstokesnc/densityflowproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup NavierStokesNCTests
* \brief Channel flow test for the staggered grid (Navier-)Stokes model
*/
#ifndef DUMUX_DENSITY_FLOW_NC_TEST_PROBLEM_HH
@@ -80,8 +80,9 @@ SET_BOOL_PROP(DensityDrivenFlowProblem, EnableInertiaTerms, false);
}
/*!
- * \brief Test problem for the one-phase model:
- \todo doc me!
+ * \ingroup NavierStokesNCTests
+ * \brief Test problem for the one-phase model.
+ * \todo doc me!
*/
template <class TypeTag>
class DensityDrivenFlowProblem : public NavierStokesProblem<TypeTag>
@@ -138,7 +139,7 @@ public:
cellSizeX_ = this->fvGridGeometry().bBoxMax()[0] / numCells[0];
}
- /*!
+ /*!
* \name Problem parameters
*/
// \{
@@ -148,7 +149,7 @@ public:
return false;
}
- /*!
+ /*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
@@ -156,7 +157,7 @@ public:
Scalar temperature() const
{ return 273.15 + 10; } // 10C
- /*!
+ /*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
@@ -166,12 +167,12 @@ public:
return SourceValues(0.0);
}
// \}
- /*!
+ /*!
* \name Boundary conditions
*/
// \{
- /*!
+ /*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
@@ -201,7 +202,7 @@ public:
return values;
}
- /*!
+ /*!
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
@@ -221,12 +222,12 @@ public:
// \}
- /*!
+ /*!
* \name Volume terms
*/
// \{
- /*!
+ /*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
@@ -242,8 +243,11 @@ public:
return values;
}
- /*!
+ /*!
* \brief Adds additional VTK output data to the VTKWriter. Function is called by the output module on every write.
+ *
+ * \param gridVariables The grid variables
+ * \param sol The solution vector
*/
void calculateDeltaRho(const GridVariables& gridVariables, const SolutionVector& sol)
{
diff --git a/test/freeflow/navierstokesnc/msfreeflowtestproblem.hh b/test/freeflow/navierstokesnc/msfreeflowtestproblem.hh
index a3696e846a..89607f8026 100644
--- a/test/freeflow/navierstokesnc/msfreeflowtestproblem.hh
+++ b/test/freeflow/navierstokesnc/msfreeflowtestproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup NavierStokesNCTests
* \brief Channel flow test for the multi-component staggered grid (Navier-)Stokes model
*/
#ifndef DUMUX_CHANNEL_MAXWELL_STEFAN_TEST_PROBLEM_HH
@@ -72,7 +72,11 @@ SET_BOOL_PROP(MaxwellStefanNCTestProblem, EnableInertiaTerms, true);
SET_TYPE_PROP(MaxwellStefanNCTestProblem, MolecularDiffusionType, MaxwellStefansLaw<TypeTag>);
-//! A simple fluid system with one MaxwellStefan component
+/*!
+ * \ingroup NavierStokesNCTests
+ * \brief A simple fluid system with one MaxwellStefan component.
+ * \todo doc me!
+ */
template<class TypeTag>
class MaxwellStefanFluidSystem: public FluidSystems::BaseFluidSystem<typename GET_PROP_TYPE(TypeTag, Scalar),MaxwellStefanFluidSystem<TypeTag>>
@@ -82,7 +86,7 @@ class MaxwellStefanFluidSystem: public FluidSystems::BaseFluidSystem<typename GE
typedef FluidSystems::BaseFluidSystem <Scalar, ThisType> Base;
public:
- //! The number of components
+ //! The number of phases
static constexpr int numPhases = 1;
static constexpr int numComponents = 3;
@@ -104,7 +108,7 @@ public:
using Base::binaryDiffusionCoefficient;
- /*!
+ /*!
* \brief Given a phase's composition, temperature and pressure,
* return the binary diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for components
* \f$i\f$ and \f$j\f$ in this phase.
@@ -137,7 +141,7 @@ public:
<< compIIdx << " and " << compJIdx << " is undefined!\n");
}
using Base::density;
- /*!
+ /*!
* \brief Given a phase's composition, temperature, pressure, and
* the partial pressures of all components, return its
* density \f$\mathrm{[kg/m^3]}\f$.
@@ -153,7 +157,7 @@ public:
}
using Base::viscosity;
- /*!
+ /*!
* \brief Calculate the dynamic viscosity of a fluid phase \f$\mathrm{[Pa*s]}\f$
* \param fluidState An arbitrary fluid state
* \param phaseIdx The index of the fluid phase to consider
@@ -171,7 +175,7 @@ SET_TYPE_PROP(MaxwellStefanNCTestProblem, FluidSystem, MaxwellStefanFluidSystem<
} //end namespace Property
/*!
* \brief Test problem for the maxwell stefan model
- \todo doc me!
+ * \todo doc me!
*/
template <class TypeTag>
class MaxwellStefanNCTestProblem : public NavierStokesProblem<TypeTag>
@@ -229,12 +233,12 @@ public:
plotOutput_ = false;
}
- /*!
+ /*!
* \name Problem parameters
*/
// \{
- /*!
+ /*!
* \brief The problem name.
*
* This is used as a prefix for files generated by the simulation.
@@ -249,8 +253,15 @@ public:
return false;
}
- //! Called after every time step
- //! Output the diffusion rates from left to right
+ /*!
+ * \brief Output the diffusion rates from left to right
+ *
+ * Called after every time step
+ *
+ * \param curSol Vector containing the current solution
+ * \param gridVariables The grid variables
+ * \param time The time
+ */
void postTimeStep(const SolutionVector& curSol,
const GridVariables& gridVariables,
Scalar time)
@@ -341,7 +352,7 @@ public:
}
- /*!
+ /*!
* \brief Return the temperature within the domain in [K].
*
* This problem assumes a temperature of 10 degrees Celsius.
@@ -349,7 +360,7 @@ public:
Scalar temperature() const
{ return 273.15 + 10; } // 10C
- /*!
+ /*!
* \brief Return the sources within the domain.
*
* \param globalPos The global position
@@ -360,12 +371,12 @@ public:
}
// \}
- /*!
+ /*!
* \name Boundary conditions
*/
// \{
- /*!
+ /*!
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary control volume.
*
@@ -381,7 +392,7 @@ public:
return values;
}
- /*!
+ /*!
* \brief Evaluate the boundary conditions for a dirichlet
* control volume.
*
@@ -394,12 +405,12 @@ public:
}
- /*!
+ /*!
* \name Volume terms
*/
// \{
- /*!
+ /*!
* \brief Evaluate the initial value for a control volume.
*
* \param globalPos The global position
--
GitLab