Skip to content
GitLab
Commit 88c1b546 authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Scholz
Browse files

[doxygen] Adapt documentation for mpnc tests

parent 16e2517f
Hide whitespace changes
Inline Side-by-side
test/porousmediumflow/mpnc/implicit/2p2ccomparison/main.cc
View file @ 88c1b546
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the mpnc porousmedium box flow model
* \ingroup MPNCTests
* \brief Test for the mpnc porous medium box flow model.
*/
#include <config.h>
......
test/porousmediumflow/mpnc/implicit/2p2ccomparison/problem.hh
View file @ 88c1b546
......@@ -19,7 +19,9 @@
/*!
* \file
* \ingroup MPNCTests
* \brief Problem where air is injected in a unsaturated porous medium. This test compares a mpnc problem with a 2p2c problem
* \brief Problem where air is injected in a unsaturated porous medium.
*
* This test compares a mpnc problem with a 2p2c problem.
*/
#ifndef DUMUX_MPNC_TWOPTWOC_COMPARISON_OBSTACLEPROBLEM_HH
#define DUMUX_MPNC_TWOPTWOC_COMPARISON_OBSTACLEPROBLEM_HH
......@@ -44,7 +46,9 @@ namespace Dumux {
/*!
* \ingroup MPNCTests
* \brief Problem where air is injected in a unsaturated porous medium. This test compares a mpnc problem with a 2p2c problem
* \brief Problem where air is injected in a unsaturated porous medium.
*
* This test compares a mpnc problem with a 2p2c problem.
*/
template <class TypeTag>
class MPNCComparisonProblem;
......@@ -93,7 +97,9 @@ struct IOFields<TypeTag, TTag::MPNCComparison> { using type = TwoPTwoCMPNCIOFiel
/*!
* \ingroup MPNCTests
* \brief Problem where air is injected in a unsaturated porous medium. This test compares a mpnc problem with a 2p2c problem
* \brief Problem where air is injected in a unsaturated porous medium.
*
* This test compares a mpnc problem with a 2p2c problem.
*
*/
template <class TypeTag>
......@@ -131,10 +137,6 @@ class MPNCComparisonProblem
static constexpr bool isBox = GetPropType<TypeTag, Properties::FVGridGeometry>::discMethod == DiscretizationMethod::box;
public:
/*!
* \brief The constructor
*
*/
MPNCComparisonProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{
......@@ -196,8 +198,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
*/
......@@ -207,8 +208,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Neumann
* boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
......@@ -241,7 +241,7 @@ public:
// \{
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* \param globalPos The center of the finite volume which ought to be set.
*
......@@ -324,6 +324,6 @@ private:
static constexpr Scalar eps_ = 1e-6;
std::string name_;
};
} //end namespace
} // end namespace
#endif
test/porousmediumflow/mpnc/implicit/2p2ccomparison/spatialparams.hh
View file @ 88c1b546
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
* \ingroup TwoPTwoCTests
* \brief The spatial parameters for the TwoPTwoC MPNC comparison problem
* \ingroup MPNCTests
* \brief The spatial parameters for the TwoPTwoC MPNC comparison problem.
*/
#ifndef DUMUX_MPNC_COMPARISON_SPATIAL_PARAMS_HH
......@@ -60,7 +60,6 @@ public:
using MaterialLaw = EffToAbsLaw<EffectiveLaw>;
using MaterialLawParams = typename MaterialLaw::Params;
//! The constructor
MPNCComparisonSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry) : ParentType(fvGridGeometry)
{
// intrinsic permeabilities
......@@ -95,7 +94,7 @@ public:
}
/*!
* \brief Define the porosity \f$[-]\f$ of the soil
* \brief Defines the porosity \f$[-]\f$ of the soil
*
* \param globalPos The global Position
*/
......@@ -108,7 +107,7 @@ public:
* \brief Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.).
*
* \param globalPos The global position of the sub-control volume.
* \return the material parameters object
* \return The material parameters object
*/
const MaterialLawParams& materialLawParamsAtPos(const GlobalPosition& globalPos) const
{
......@@ -121,8 +120,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
......
test/porousmediumflow/mpnc/implicit/kinetic/main.cc
View file @ 88c1b546
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief Test for the three-phase box model
* \ingroup MPNCTests
* \brief Test for the three-phase box model.
*/
#include <config.h>
#include "problem.hh"
......
test/porousmediumflow/mpnc/implicit/kinetic/plotoverline2d.hh
View file @ 88c1b546
......@@ -18,10 +18,10 @@
*****************************************************************************/
/*!
* \file
* \ingroup MPNCTests
* \brief Plot variables over a line specified by two arguments.
* These output files are meant for visualization with another
* program (matlab, gnuplot...)
*
*/
#ifndef DUMUX_PLOTOVERLINE_2D_HH
#define DUMUX_PLOTOVERLINE_2D_HH
......@@ -38,6 +38,12 @@
namespace Dumux {
/*!
* \ingroup MPNCTests
* \brief Plot variables over a line specified by two arguments.
* These output files are meant for visualization with another
* program (matlab, gnuplot...)
*/
template<class TypeTag>
class PlotOverLine2D
{
......@@ -70,12 +76,12 @@ public:
/*!
* \brief A function that writes results over a line (like paraview's plotOverline into a text file.)
*
* The writer needs to be called in postTimeStep().
* The writer needs to be called in postTimeStep().
*
* This function puts output variables (TemperaturePhase, Saturation, t, tIndex, ...)
* over space (1D, over a line) into a text file,
* so they can be read in by another program like matlab.
* The file can be found by the extension: dat
* This function puts output variables (TemperaturePhase, Saturation, t, tIndex, ...)
* over space (1D, over a line) into a text file,
* so they can be read in by another program like matlab.
* The file can be found by the extension: dat
*/
void write(const Problem & problem,
const GlobalPosition & pointOne,
......@@ -186,7 +192,7 @@ public:
}
/*!
* \brief Check whether the current point is on a line between two points
* \brief Checks whether the current point is on a line between two points
*/
bool isBetween(const GlobalPosition & globalPosCurrent,
const GlobalPosition & pointOne,
......
test/porousmediumflow/mpnc/implicit/kinetic/problem.hh
View file @ 88c1b546
......@@ -19,14 +19,16 @@
/*!
* \file
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*
* The whole domain is porous medium, but the upper half has properties mimicing the ones of a free-flow domain.
* This way a poor man's coupling approach is accomplished: Without the complications of coupling,
* the main characteristics a porous and a free-flow domain are depicted.
* The whole domain is porous medium, but the upper half has properties mimicing
* the ones of a free-flow domain.
* This way a poor man's coupling approach is accomplished: Without the
* complications of coupling, the main characteristics a porous and a free-flow
* domain are depicted.
*
* The porous domain is bypassed with dry air. This way the equilibration process on top of the porous domain can be studied.
* The porous domain is bypassed with dry air. This way the equilibration
* process on top of the porous domain can be studied.
*
* \author Philipp Nuske
*/
......@@ -66,7 +68,6 @@
namespace Dumux {
/*!
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*/
template <class TypeTag>
......@@ -129,7 +130,8 @@ struct SpatialParams<TypeTag, TTag::EvaporationAtmosphere>
/*!
* \ingroup MPNCTests
*
* \brief Problem that simulates the coupled heat and mass transfer processes resulting form the evaporation of liquid water from
* \brief Problem that simulates the coupled heat and mass transfer processes
resulting from the evaporation of liquid water from
* a porous medium sub-domain into a gas filled "quasi-freeflow" sub-domain.
*/
template <class TypeTag>
......@@ -180,11 +182,6 @@ class EvaporationAtmosphereProblem: public PorousMediumFlowProblem<TypeTag>
static constexpr auto leastWettingFirst = MpNcPressureFormulation::leastWettingFirst;
public:
/*!
* \brief The constructor
*
* \param fvGridGeometry The finite volume grid geometry
*/
EvaporationAtmosphereProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{
......@@ -252,8 +249,7 @@ public:
}
/*!
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
* \brief Evaluates the boundary conditions for a Dirichlet boundary segment.
*
* \param globalPos The global position
*
......@@ -345,7 +341,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
*/
......@@ -355,8 +351,8 @@ public:
}
/*!
* \brief Evaluate the source term for all balance equations within a given
* sub-control-volume.
* \brief Evaluates the source term for all balance equations within a given
* sub-controlvolume.
*
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
......@@ -411,7 +407,7 @@ private:
const auto &materialParams =
this->spatialParams().materialLawParamsAtPos(globalPos);
std::vector<Scalar> capPress(numPhases);
//obtain pc according to saturation
// obtain pc according to saturation
using MaterialLaw = typename ParentType::SpatialParams::MaterialLaw;
using MPAdapter = MPAdapter<MaterialLaw, numPhases>;
......@@ -506,19 +502,19 @@ private:
}
/*!
* \brief Give back whether the tested position (input) is a specific region (left) in the domain
* \brief Returns whether the tested position is on the left boundary of the domain.
*/
bool onLeftBoundary_(const GlobalPosition & globalPos) const
{ return globalPos[0] < this->fvGridGeometry().bBoxMin()[0] + eps_; }
/*!
* \brief Give back whether the tested position (input) is a specific region (right) in the domain
* \brief Returns whether the tested position is on the right boundary of the domain.
*/
bool onRightBoundary_(const GlobalPosition & globalPos) const
{ return globalPos[0] > this->fvGridGeometry().bBoxMax()[0] - eps_; }
/*!
* \brief Give back whether the tested position (input) is a specific region (down, (gravityDir)) in the domain
* \brief Returns whether the tested position is on the lower boundary of the domain.
*/
bool onLowerBoundary_(const GlobalPosition & globalPos) const
{ return globalPos[dimWorld-1] < this->fvGridGeometry().bBoxMin()[dimWorld-1] + eps_; }
......@@ -551,6 +547,6 @@ public:
{ return inputParameters_; }
};
} //end namespace
} // end namespace
#endif
test/porousmediumflow/mpnc/implicit/kinetic/spatialparams.hh
View file @ 88c1b546
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
* \brief Spatial parameters for the kinetic test-case of the mpnc model.
*
* "Poor-mans" coupling of free-flow and porous medium.
*/
#ifndef DUMUX_EVAPORATION_ATMOSPHERE_SPATIALPARAMS_HH
#define DUMUX_EVAPORATION_ATMOSPHERE_SPATIALPARAMS_HH
......@@ -61,14 +62,14 @@ class EvaporationAtmosphereSpatialParams
static constexpr auto dimWorld = GridView::dimensionworld;
public:
//! export the type used for the permeability
//! Export the type used for the permeability
using PermeabilityType = Scalar;
//! export the material law type used
//! Export the material law type used
using MaterialLaw = EffToAbsLaw<RegularizedBrooksCorey<Scalar>>;
//! convenience aliases of the law parameters
//! Convenience aliases of the law parameters
using MaterialLawParams = typename MaterialLaw::Params;
//! export the types used for interfacial area calculations
//! Export the types used for interfacial area calculations
using EffectiveIALawAws = AwnSurfacePolynomial2ndOrder<Scalar>;
using EffectiveIALawAwn = AwnSurfacePcMaxFct<Scalar>;
using EffectiveIALawAns = AwnSurfaceExpSwPcTo3<Scalar>;
......@@ -174,7 +175,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 porosity
* \return The porosity
*/
template<class ElementSolution>
Scalar porosity(const Element& element,
......@@ -206,7 +207,7 @@ public:
else DUNE_THROW(Dune::InvalidStateException, "You should not be here: x=" << globalPos[0] << " y= "<< globalPos[dimWorld-1]);
}
/*!\brief Return a reference to the container object for the
/*!\brief Returns a reference to the container object for the
* parametrization of the surface between wetting and non-Wetting phase.
*
* The position is determined based on the coordinate of
......@@ -229,7 +230,7 @@ public:
else DUNE_THROW(Dune::InvalidStateException, "You should not be here: x=" << globalPos[0] << " y= "<< globalPos[dimWorld-1]);
}
/*!\brief Return a reference to the container object for the
/*!\brief Returns a reference to the container object for the
* parametrization of the surface between non-Wetting and solid phase.
*
* The position is determined based on the coordinate of
......@@ -251,15 +252,15 @@ public:
else DUNE_THROW(Dune::InvalidStateException, "You should not be here: x=" << globalPos[0] << " y= "<< globalPos[dimWorld-1]);
}
/*!\brief Return the maximum capillary pressure for the given pc-Sw curve
/*!\brief Returns the maximum capillary pressure for the given pc-Sw curve
*
* Of course physically there is no such thing as a maximum capillary pressure.
* The parametrization (VG/BC) goes to infinity and physically there is only one pressure
* for single phase conditions.
* Here, this is used for fitting the interfacial area surface: the capillary pressure,
* where the interfacial area is zero.
* Technically this value is obtained as the capillary pressure of saturation zero.
* This value of course only exists for the case of a regularized pc-Sw relation.
* Of course physically there is no such thing as a maximum capillary pressure.
* The parametrization (VG/BC) goes to infinity and physically there is only one pressure
* for single phase conditions.
* Here, this is used for fitting the interfacial area surface: the capillary pressure,
* where the interfacial area is zero.
* Technically this value is obtained as the capillary pressure of saturation zero.
* This value of course only exists for the case of a regularized pc-Sw relation.
* \param element The finite element
* \param scv The sub-control volume
* \param elemSol The element solution
......@@ -270,8 +271,10 @@ public:
const ElementSolution &elemSol) const
{ return aWettingNonWettingSurfaceParams_.pcMax() ; }
/*!\brief Return the characteristic length for the mass transfer.
* \param globalPos The position in global coordinates.*/
/*!
* \brief Returns the characteristic length for the mass transfer.
* \param globalPos The position in global coordinates.
*/
const Scalar characteristicLengthAtPos(const GlobalPosition & globalPos) const
{
if (inFF_(globalPos) )
......@@ -281,8 +284,10 @@ public:
else DUNE_THROW(Dune::InvalidStateException, "You should not be here: x=" << globalPos[0] << " y= "<< globalPos[dimWorld-1]);
}
/*!\brief Return the pre factor the the energy transfer
* \param globalPos The position in global coordinates.*/
/*!
* \brief Return the pre factor the the energy transfer
* \param globalPos The position in global coordinates.
*/
const Scalar factorEnergyTransferAtPos(const GlobalPosition & globalPos) const
{
if (inFF_(globalPos) )
......@@ -292,8 +297,10 @@ public:
else DUNE_THROW(Dune::InvalidStateException, "You should not be here: x=" << globalPos[0] << " y= "<< globalPos[dimWorld-1]);
}
/*!\brief Return the pre factor the the mass transfer
* \param globalPos The position in global coordinates.*/
/*!
* \brief Return the pre factor the the mass transfer
* \param globalPos The position in global coordinates.
*/
const Scalar factorMassTransferAtPos(const GlobalPosition & globalPos) const
{
if (inFF_(globalPos) )
......@@ -306,8 +313,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
......@@ -315,27 +322,32 @@ public:
return FluidSystem::phase0Idx;
}
/*!\brief Give back whether the tested position (input) is a specific region (porous medium part) in the domain
/*!
* \brief Returns whether the tested position is in the porous medium part of the domain
*
* This setting ensures, that the boundary between the two domains has porous medium properties.
* This is desirable, because I want to observe the boundary of the porous domain.
* However, the position has to be the coordinate of the vertex and not the integration point
* of the boundary flux. If the position is the ip of the neumann flux this leads to a situation
* where the vertex belongs to porous medium and there is nonetheless injection over the boundary.
* That does not work.
* This setting ensures that the boundary between the two domains has porous
* medium properties. This is desirable, because I want to observe the
* boundary of the porous domain.
* However, the position has to be the coordinate of the vertex and not the
* integration point of the boundary flux. If the position is the ip of the
* Neumann flux this leads to a situation
* where the vertex belongs to porous medium and there is nonetheless
* injection over the boundary. That does not work.
* -> be careful with neumannAtPos
*/
bool inPM_(const GlobalPosition & globalPos) const
{ return ( (globalPos[dimWorld-1] > 0. - eps_) and (globalPos[dimWorld-1] < (heightPM_ + eps_) ) ); }
/*!
* \brief Give back whether the tested position (input) is a specific region (above PM / "free flow") in the domain
* \brief Returns whether the tested position is above PM / "free flow" in the domain.
*
* This setting ensures, that the boundary between the two domains has porous medium properties.
* This is desirable, because I want to observe the boundary of the porous domain.
* However, the position has to be the coordinate of the vertex and not the integration point
* of the boundary flux. If the position is the ip of the neumann flux this leads to a situation
* where the vertex belongs to porous medium and there is nonetheless injection over the boundary.
* This setting ensures that the boundary between the two domains has porous
* medium properties. This is desirable, because I want to observe the
* boundary of the porous domain.
* However, the position has to be the coordinate of the vertex and not the
* integration point of the boundary flux. If the position is the ip of the
* Neumann flux this leads to a situation where the vertex belongs to porous
* medium and there is nonetheless injection over the boundary.
* That does not work.
* -> be careful with neumannAtPos
*/
......
test/porousmediumflow/mpnc/implicit/obstacle/main.cc
View file @ 88c1b546
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the mpnc porousmedium box flow model
* \ingroup MPNCTests
* \brief Test for the mpnc porous medium box flow model.
*/
#include <config.h>
......
test/porousmediumflow/mpnc/implicit/obstacle/problem.hh
View file @ 88c1b546
......@@ -19,9 +19,11 @@
/*!
* \file
* \ingroup MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* \brief Problem where liquid water is injected which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
*
* The water is injected by means of a Dirichlet condition on the lower
* right of the domain.
*/
#ifndef DUMUX_OBSTACLEPROBLEM_HH
#define DUMUX_OBSTACLEPROBLEM_HH
......@@ -45,9 +47,11 @@ namespace Dumux {
/*!
* \ingroup MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* \brief Problem where liquid water is injected which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
*
* The water is injected by means of a Dirichlet condition on the lower
* right of the domain.
*/
template <class TypeTag>
class ObstacleProblem;
......@@ -91,13 +95,14 @@ struct Scalar<TypeTag, TTag::Obstacle> { using type = double; };
}
/*!
* \ingroup MPNCTests
* \brief Problem where liquid water is injected -- by means of a
* Dirichlet condition on the lower right of the domain -- which has to go
* \brief Problem where liquid water is injected which has to go
* around an obstacle with \f$10^3\f$ lower permeability.
*
* The water is injected by means of a Dirichlet condition on the lower
* right of the domain.
*
* The domain is sized 60m times 40m and consists of two media, a
* moderately permeable soil (\f$ K_0=10e-12 m^2\f$) and an obstacle
* at \f$[10; 20]m \times [0; 35]m \f$ with a lower permeablility of
......@@ -156,11 +161,6 @@ class ObstacleProblem
using PhaseVector = Dune::FieldVector<Scalar, numPhases>;
public:
/*!
* \brief The constructor
*
* \param fvGridGeometry The finite volume grid geometry
*/
ObstacleProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{
......@@ -229,8 +229,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
*/
......@@ -240,8 +239,7 @@ public:
}
/*!
* \brief Evaluates the boundary conditions for a Neumann
* boundary segment.
* \brief Evaluates the boundary conditions for a Neumann boundary segment.
*
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
......@@ -266,8 +264,8 @@ public:
// \{
/*!
* \brief Evaluate the source term for all balance equations within a given
* sub-control-volume.
* \brief Evaluates the source term for all balance equations within a given
* sub-control volume.
*
* \param element The finite element
* \param fvGeometry The finite volume geometry of the element
......@@ -285,7 +283,7 @@ public:
}
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* \param globalPos The center of the finite volume which ought to be set.
*
......
test/porousmediumflow/mpnc/implicit/obstacle/spatialparams.hh
View file @ 88c1b546
......@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup MPNCTests
* \brief The spatial parameters for the ObstacleProblem
* \brief The spatial parameters for the ObstacleProblem.
*/
#ifndef DUMUX_OBSTACLE_SPATIAL_PARAMS_HH
......@@ -34,7 +34,7 @@ namespace Dumux {
/**
* \ingroup MPNCTests
* \brief Definition of the spatial params properties for the obstacle problem
* \brief Definition of the spatial params properties for the obstacle problem.
*
*/
template<class FVGridGeometry, class Scalar>
......@@ -54,13 +54,12 @@ class ObstacleSpatialParams
using EffectiveLaw = RegularizedLinearMaterial<Scalar>;
public: