Commit af703b06 authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Emmert

[doxygen] Adapt documentation for all 2p related tests

parent aacfb75f
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the two-phase porousmedium flow model
* \ingroup TwoPTests
* \brief Test for the two-phase porous medium flow model
*/
#include <config.h>
#include <ctime>
......@@ -59,7 +60,7 @@
#include "pointsourceproblem.hh"
#include "problem.hh"
//! type tags for the adaptive versions of the two-phase incompressible problem
//! Type tags for the adaptive versions of the two-phase incompressible problem
namespace Dumux {
namespace Properties {
//! Type Tags for the adaptive tests
......
......@@ -28,9 +28,13 @@
#include "problem.hh"
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief Soil contamination problem where DNAPL infiltrates a fully
* water saturated medium.
*/
template <class TypeTag >
class PointSourceTestProblem : public TwoPTestProblemAdaptive<TypeTag>
{
......@@ -42,11 +46,10 @@ public:
using ParentType::ParentType;
/*!
* \ingroup TwoPTests
* \brief Applies a vector of point sources. The point sources
* are possibly solution dependent.
*
* \param pointSources A vector of PointSource s that contain
* \param pointSources A vector of PointSources that contain
source values for all phases and space positions.
*
* For this method, the \a values method of the point source
......
......@@ -30,9 +30,13 @@
#include <dumux/io/container.hh>
namespace Dumux
{
namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief Soil contamination problem where DNAPL infiltrates a fully
* water saturated medium.
*/
template <class TypeTag >
class TwoPTestProblemAdaptive : public TwoPTestProblem<TypeTag>
{
......@@ -57,10 +61,7 @@ public:
}
/*!
* \brief Evaluate the initial value for
* an element for cell-centered models
*
* \param element
* \brief Evaluates the initial value for an element for cell-centered models.
*/
PrimaryVariables initial(const Element& element) const
{
......@@ -74,10 +75,7 @@ public:
}
/*!
* \brief Evaluate the initial value for
* an vertex for vertex-centered models
*
* \param vertex
* \brief Evaluates the initial value for a vertex for vertex-centered models.
*/
PrimaryVariables initial(const Vertex& vertex) const
{
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the two-phase porousmedium flow model
* \ingroup TwoPTests
* \brief Test for the two-phase porous medium flow model.
*/
#include <config.h>
......
......@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The properties for the incompressible 2p-boxdfm test
* \brief The properties for the incompressible 2p-boxdfm test.
*/
#ifndef DUMUX_INCOMPRESSIBLE_TWOPBOXDFM_TEST_PROBLEM_HH
#define DUMUX_INCOMPRESSIBLE_TWOPBOXDFM_TEST_PROBLEM_HH
......@@ -143,14 +144,12 @@ class TwoPTestProblem : public PorousMediumFlowProblem<TypeTag>
static constexpr int dimWorld = GridView::dimensionworld;
public:
//! The constructor
TwoPTestProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{}
/*!
* \brief Return how much the domain is extruded at a given sub-control volume.
* \brief Returns how much the domain is extruded at a given sub-control volume.
*
* Here, we extrude the fracture scvs by half the aperture
*/
......@@ -185,8 +184,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*/
......@@ -199,8 +197,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......@@ -211,7 +208,7 @@ public:
{ return NumEqVector(0.0); }
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param globalPos The global position
*/
......
......@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test
* \brief The spatial params for the incompressible 2p test.
*/
#ifndef DUMUX_INCOMPRESSIBLE_TWOPBOXDFM_TEST_SPATIAL_PARAMS_HH
#define DUMUX_INCOMPRESSIBLE_TWOPBOXDFM_TEST_SPATIAL_PARAMS_HH
......@@ -36,7 +37,7 @@ namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test
* \brief The spatial params for the incompressible 2p test.
*/
template<class FVGridGeometry, class Scalar>
class TwoPTestSpatialParams : public FVSpatialParams< FVGridGeometry, Scalar, TwoPTestSpatialParams<FVGridGeometry, Scalar> >
......@@ -80,7 +81,7 @@ public:
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return permeability
* \return The permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -114,12 +115,13 @@ public:
/*!
* \brief Returns the parameter object for the Brooks-Corey material law.
* In this test, we use element-wise distributed material parameters.
*
* In this test, we use element-wise distributed material parameters.
*
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return the material parameters object
* \return The material parameters object
*/
template<class ElementSolution>
const MaterialLawParams& materialLawParams(const Element& element,
......@@ -135,8 +137,8 @@ public:
/*!
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The global position
* \return The wetting phase index
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the two-phase porousmedium flow model on a cornerpoint grid
* \ingroup TwoPTests
* \brief Test for the two-phase porous medium flow model on a cornerpoint grid.
*/
#include <config.h>
// As of versions Opm 2018.04 and Dune 2.6, using opm-grid and dune-uggrid
......
......@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The properties for the 2p cornerpoint test
* \brief The properties for the 2p cornerpoint test.
*/
#ifndef DUMUX_TWOP_CORNERPOINT_TEST_PROBLEM_HH
#define DUMUX_TWOP_CORNERPOINT_TEST_PROBLEM_HH
......@@ -150,8 +151,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param values Stores the Dirichlet values for the conservation equations in
* \f$ [ \textnormal{unit of primary variable} ] \f$
......@@ -163,8 +163,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
*
* \param values Stores the Neumann values for the conservation equations in
* \f$ [ \textnormal{unit of conserved quantity} / (m^(dim-1) \cdot s )] \f$
......@@ -199,7 +198,7 @@ public:
}
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param values Stores the initial values for the conservation equations in
* \f$ [ \textnormal{unit of primary variables} ] \f$
......@@ -230,7 +229,7 @@ public:
}
/*!
* \brief Append all quantities of interest which can be derived
* \brief Appends all quantities of interest which can be derived
* from the solution of the current time step to the VTK
* writer.
*/
......
......@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The spatial params for the 2p cornerpoint test
* \brief The spatial params for the 2p cornerpoint test.
*/
#ifndef DUMUX_TWOP_CORNERPOINT_TEST_SPATIAL_PARAMS_HH
#define DUMUX_TWOP_CORNERPOINT_TEST_SPATIAL_PARAMS_HH
......@@ -34,7 +35,7 @@ namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test
* \brief The spatial params for the incompressible 2p test.
*/
template<class FVGridGeometry, class Scalar>
class TwoPCornerPointTestSpatialParams
......@@ -120,12 +121,13 @@ public:
/*!
* \brief Function for defining the (intrinsic) permeability \f$[m^2]\f$.
* In this test, we use element-wise distributed permeabilities.
*
* In this test, we use element-wise distributed permeabilities.
*
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return permeability
* \return The permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -147,7 +149,7 @@ public:
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return porosity
* \return The porosity
*/
template<class ElementSolution>
Scalar porosity(const Element& element,
......@@ -164,7 +166,7 @@ public:
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return the material parameters object
* \return The material parameters object
*/
template<class ElementSolution>
const MaterialLawParams& materialLawParams(const Element& element,
......@@ -177,8 +179,8 @@ public:
/*!
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The global position
* \return The wetting phase index
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief Fracture 2d in 3d test for the two-phase box model
* \ingroup TwoPTests
* \brief Fracture 2d in 3d test for the two-phase box model.
*/
#include <config.h>
......
......@@ -20,7 +20,8 @@
* \file
* \ingroup TwoPTests
* \brief A discrete fracture network embedded in an impermeable matrix.
* The fracture is a 2D network embedded in 3D.
*
* The fracture is a 2D network embedded in 3D.
*/
#ifndef DUMUX_TWOP_FRACTURE_TEST_PROBLEM_HH
#define DUMUX_TWOP_FRACTURE_TEST_PROBLEM_HH
......@@ -186,8 +187,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*/
......@@ -203,8 +203,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......@@ -229,7 +228,7 @@ public:
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param globalPos The global position
*/
......
......@@ -20,8 +20,9 @@
* \file
* \ingroup TwoPTests
* \brief The spatial parameters for the LensProblem which uses the
* two-phase fully implicit model
* two-phase fully implicit model.
*/
#ifndef DUMUX_TWOP_FRACTURE_TEST_SPATIALPARAMS_HH
#define DUMUX_TWOP_FRACTURE_TEST_SPATIALPARAMS_HH
......@@ -37,7 +38,7 @@ namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief The spatial parameters for the LensProblem which uses the
* two-phase fully implicit model
* two-phase fully implicit model.
*/
template<class FVGridGeometry, class Scalar>
class FractureSpatialParams
......@@ -102,8 +103,8 @@ public:
/*!
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The global position
* \return The wetting phase index
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the two-phase porousmedium flow model
* \ingroup TwoPTests
* \brief Test for the two-phase porousmedium flow model.
*/
#include <config.h>
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The properties for the incompressible 2p test
* \brief The properties for the incompressible 2p test.
*/
#ifndef DUMUX_INCOMPRESSIBLE_TWOP_TEST_PROBLEM_HH
#define DUMUX_INCOMPRESSIBLE_TWOP_TEST_PROBLEM_HH
......@@ -150,8 +150,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*/
......@@ -179,8 +178,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
* \brief Evaluate the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The position of the integration point of the boundary segment.
*
......@@ -201,7 +199,7 @@ public:
}
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param globalPos The global position
*/
......
......@@ -18,8 +18,9 @@
*****************************************************************************/
/*!
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test
* \brief The spatial params for the incompressible 2p test.
*/
#ifndef DUMUX_INCOMPRESSIBLE_TWOP_TEST_SPATIAL_PARAMS_HH
#define DUMUX_INCOMPRESSIBLE_TWOP_TEST_SPATIAL_PARAMS_HH
......@@ -33,7 +34,7 @@ namespace Dumux {
/*!
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test
* \brief The spatial params for the incompressible 2p test.
*/
template<class FVGridGeometry, class Scalar>
class TwoPTestSpatialParams
......@@ -88,7 +89,7 @@ public:
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return permeability
* \return The permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -112,12 +113,13 @@ public:
/*!
* \brief Returns the parameter object for the Brooks-Corey material law.
* In this test, we use element-wise distributed material parameters.
*
* In this test, we use element-wise distributed material parameters.
*
* \param element The current element
* \param scv The sub-control volume inside the element.
* \param elemSol The solution at the dofs connected to the element.
* \return the material parameters object
* \return The material parameters object
*/
template<class ElementSolution>
const MaterialLawParams& materialLawParams(const Element& element,
......@@ -133,8 +135,8 @@ public:
/*!
* \brief Function for defining which phase is to be considered as the wetting phase.
*
* \return the wetting phase index
* \param globalPos The global position
* \return The wetting phase index
*/
template<class FluidSystem>
int wettingPhaseAtPos(const GlobalPosition& globalPos) const
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup TwoPTests
* \brief test for the 2pni CC model
*/
#include <config.h>
......
......@@ -20,8 +20,9 @@
* \file
* \ingroup TwoPTests
* \brief Non-isothermal gas injection problem where a gas (e.g. air) is injected into a fully
* water saturated medium. During buoyancy driven upward migration the gas
* passes a high temperature area.
* water saturated medium.
*
* During buoyancy driven upward migration the gas passes a high temperature area.
*/
#ifndef DUMUX_INJECTION_PROBLEM_2PNI_HH
......@@ -91,24 +92,24 @@ struct SpatialParams<TypeTag, TTag::Injection2PNITypeTag>
/*!
* \ingroup TwoPTests
* \brief Non-isothermal gas injection problem where a gas (e.g. air) is injected into a fully
* water saturated medium. During buoyancy driven upward migration the gas
* passes a high temperature area.
* water saturated medium.
*
* During buoyancy driven upward migration the gas passes a high temperature area.
*
* The domain is sized 60 m times 40 m. The rectangular area with the increased temperature (380 K)
* starts at (20 m, 5 m) and ends at (30 m, 35 m)
* The domain is sized 60m times 40m. The rectangular area with the increased
* temperature (380K) starts at (20m, 5m) and ends at (30m, 35m).
*
* For the mass conservation equation neumann boundary conditions are used on
* the top, on the bottom and on the right of the domain, while dirichlet conditions
* apply on the left boundary.
* For the energy conservation equation dirichlet boundary conditions are applied
* For the mass conservation equation Neumann boundary conditions are used on
* the top, on the bottom and on the right of the domain, while Dirichlet conditions
* are applied on the left boundary.
* For the energy conservation equation Dirichlet boundary conditions are applied
* on all boundaries.
*
* Gas is injected at the right boundary from 5 m to 15 m at a rate of
* 0.001 kg/(s m), the remaining neumann boundaries are no-flow
* boundaries.
* Gas is injected at the right boundary from 5m to 15m at a rate of
* 0.001kg/(s m), the remaining Neumann boundaries are no-flow boundaries.
*
* At the dirichlet boundaries a hydrostatic pressure, a gas saturation of zero and
* a geothermal temperature gradient of 0.03 K/m are applied.
* At the Dirichlet boundaries a hydrostatic pressure, a gas saturation of zero and
* a geothermal temperature gradient of 0.03K/m are applied.
*
* This problem uses the \ref TwoPModel and \ref NIModel model.
*
......@@ -131,16 +132,16 @@ class InjectionProblem2PNI : public PorousMediumFlowProblem<TypeTag>
enum
{
//! primary variable indices
//! Primary variable indices
pressureIdx = Indices::pressureIdx,
saturationIdx = Indices::saturationIdx,
temperatureIdx = Indices::temperatureIdx,
//! equation indices
//! Equation indices
contiN2EqIdx = Indices::conti0EqIdx + FluidSystem::N2Idx,
energyEqIdx = Indices::energyEqIdx,
//! phase indices
//! Phase indices
wPhaseIdx = FluidSystem::H2OIdx,
nPhaseIdx = FluidSystem::N2Idx,
......@@ -157,11 +158,6 @@ class InjectionProblem2PNI : public PorousMediumFlowProblem<TypeTag>
using BoundaryTypes = GetPropType<TypeTag, Properties::BoundaryTypes>;
public:
/*!
* \brief The constructor
*
* \param fvGridGeometry The fvGridGeometry
*/
InjectionProblem2PNI(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{
......@@ -228,8 +224,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*/
......@@ -244,8 +239,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a neumann
* boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param globalPos The global position
*
......@@ -287,7 +281,7 @@ public:
// \{
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param globalPos The global position
*/
......
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the 1pnc model
* \ingroup TwoPOneCTests
* \brief Test for the 2p1c model.
*/
#include <config.h>
#include "problem.hh"
......
......@@ -20,8 +20,8 @@
* \file
* \ingroup TwoPOneCTests
* \brief Non-isothermal steam injection test problem for the 2p1cni model.
*
*/
#ifndef DUMUX_STEAM_INJECTIONPROBLEM_HH
#define DUMUX_STEAM_INJECTIONPROBLEM_HH
......@@ -88,9 +88,8 @@ struct UseBlockingOfSpuriousFlow<TypeTag, TTag::InjectionProblem> { static const
* \ingroup TwoPOneCTests
* \brief Non-isothermal 2D problem where steam is injected on the lower left side of the domain.
*
* This problem uses the \ref TwoPOneCModel .
*
* */
* This problem uses the \ref TwoPOneCModel.
*/
template <class TypeTag>
class InjectionProblem : public PorousMediumFlowProblem<TypeTag>
{
......@@ -126,11 +125,6 @@ class InjectionProblem : public PorousMediumFlowProblem<TypeTag>
using GlobalPosition = typename Element::Geometry::GlobalCoordinate;
public:
/*!
* \brief The constructor
*
*/
InjectionProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{ FluidSystem::init(); }
......@@ -172,8 +166,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Dirichlet
* boundary segment
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*/
......@@ -183,8 +176,7 @@ 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 and requires some quantities that
......@@ -228,7 +220,7 @@ public:
// \{
/*!
* \brief Evaluates the initial values for a control volume
* \brief Evaluates the initial values for a control volume.
*
* \param globalPos The global position
*/
......
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup TwoPOneCTests
* \brief Definition of the spatial parameters for the steam injection problem
* \brief Definition of the spatial parameters for the steam injection problem.
*/
#ifndef DUMUX_STEAMINJECTION_SPATIAL_PARAMS_HH
......@@ -33,7 +33,7 @@
namespace Dumux {
/*!
* \ingroup TwoPOneCTests
* \brief Definition of the spatial parameters for various steam injection problems
* \brief Definition of the spatial parameters for various steam injection problems.
*/
template<class FVGridGeometry, class Scalar>
class InjectionProblemSpatialParams
......@@ -60,11 +60,6 @@ public:
using MaterialLawParams = typename MaterialLaw::Params;
using PermeabilityType = DimWorldMatrix;
/*!
* \brief The constructor
*
* \param fvGridGeometry The finite volume grid geometry