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

[doxygen] Adapt documentation for all 1p related tests

parent 689919e1
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
#include "problem.hh"
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_COMPRESSIBLE_ONEP_TEST_PROBLEM_HH
#define DUMUX_COMPRESSIBLE_ONEP_TEST_PROBLEM_HH
......@@ -39,13 +40,11 @@
#include "spatialparams.hh"
namespace Dumux
{
namespace Dumux {
// forward declarations
template<class TypeTag> class OnePTestProblem;
namespace Properties
{
namespace Properties {
// create the type tag nodes
// Create new type tags
namespace TTag {
......@@ -89,11 +88,11 @@ template<class TypeTag>
struct EnableGridFluxVariablesCache<TypeTag, TTag::OnePCompressible> { static constexpr bool value = false; };
template<class TypeTag>
struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static constexpr bool value = false; };
} // end namespace Properties
/*!
* \ingroup OnePTests
* \brief Test problem for the compressible one-phase model:
* \brief Test problem for the compressible one-phase model.
*
* Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt>
......@@ -139,8 +138,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.
*
......@@ -154,7 +152,7 @@ public:
}
/*!
* \brief Evaluate the initial conditions
* \brief Evaluates the initial conditions
*
* \param globalPos The center of the finite volume which ought to be set.
*/
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief The spatial params the incompressible test
* \brief The spatial params for the incompressible test
*/
#ifndef DUMUX_COMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
#define DUMUX_COMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -32,7 +33,7 @@ namespace Dumux {
/*!
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* compressible 1p model
* compressible 1p model.
*/
template<class FVGridGeometry, class Scalar>
class OnePTestSpatialParams
......@@ -67,7 +68,7 @@ public:
* \param element The element
* \param scv The sub control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
* \return The intrinsic permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -81,7 +82,7 @@ public:
}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief test for the one-phase CC model
*/
#include <config.h>
#include "problem.hh"
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_COMPRESSIBLE_ONEP_TEST_PROBLEM_HH
#define DUMUX_COMPRESSIBLE_ONEP_TEST_PROBLEM_HH
......@@ -39,13 +40,11 @@
#include "spatialparams.hh"
namespace Dumux
{
namespace Dumux {
// forward declarations
template<class TypeTag> class OnePTestProblem;
namespace Properties
{
namespace Properties {
// create the type tag nodes
// Create new type tags
namespace TTag {
......@@ -89,11 +88,11 @@ template<class TypeTag>
struct EnableGridFluxVariablesCache<TypeTag, TTag::OnePCompressible> { static constexpr bool value = false; };
template<class TypeTag>
struct EnableFVGridGeometryCache<TypeTag, TTag::OnePCompressible> { static constexpr bool value = false; };
} // end namespace Properties
/*!
* \ingroup OnePTests
* \brief Test problem for the compressible one-phase model:
* \brief Test problem for the compressible one-phase model.
*
* Can be run as <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt>
......@@ -139,8 +138,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.
*
......@@ -154,7 +152,7 @@ public:
}
/*!
* \brief Evaluate the initial conditions
* \brief Evaluates the initial conditions
*
* \param globalPos The center of the finite volume which ought to be set.
*/
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief The spatial params the incompressible test
*/
#ifndef DUMUX_COMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
#define DUMUX_COMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -67,7 +68,7 @@ public:
* \param element The element
* \param scv The sub control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
* \return The intrinsic permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -81,7 +82,7 @@ public:
}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief test for the one-phase CC model
* \brief Test for the one-phase CC model
*/
#include <config.h>
#include <ctime>
......
......@@ -20,7 +20,8 @@
* \file
* \ingroup OnePTests
* \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_ONEP_FRACTURE_TEST_PROBLEM_HH
......@@ -93,8 +94,8 @@ struct SpatialParams<TypeTag, TTag::Fracture>
/*!
* \ingroup OnePTests
* \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.
* This problem uses the \ref OnePModel.
*/
template <class TypeTag>
......@@ -119,11 +120,6 @@ class FractureProblem : public PorousMediumFlowProblem<TypeTag>
using FVGridGeometry = GetPropType<TypeTag, Properties::FVGridGeometry>;
public:
/*!
* \brief The constructor
*
* \param fvGridGeometry The finite volume grid geometry
*/
FractureProblem(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{
......
......@@ -22,6 +22,7 @@
* \brief The spatial parameters for the LensProblem which uses the
* two-phase fully implicit model
*/
#ifndef DUMUX_ONEP_FRACTURE_TEST_SPATIALPARAMS_HH
#define DUMUX_ONEP_FRACTURE_TEST_SPATIALPARAMS_HH
......@@ -33,7 +34,7 @@ namespace Dumux {
/*!
* \ingroup OnePTests
* \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
......@@ -51,11 +52,6 @@ public:
// export permeability type
using PermeabilityType = Scalar;
/*!
* \brief The constructor
*
* \param fvGridGeometry The fvGridGeometry
*/
FractureSpatialParams(std::shared_ptr<const FVGridGeometry> fvGridGeometry)
: ParentType(fvGridGeometry)
{}
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief test for the one-phase CC model
* \brief Test for the one-phase CC model
*/
#include <config.h>
#include <ctime>
......@@ -54,7 +55,7 @@
#include "problem.hh"
//! function to write out the scv-wise velocities (overload for mpfa)
//! Function to write out the scv-wise velocities (overload for mpfa)
template<class FVGridGeometry, class GridVariables, class Sol,
std::enable_if_t<FVGridGeometry::discMethod == Dumux::DiscretizationMethod::ccmpfa, int> = 0>
void writeMpfaVelocities(const FVGridGeometry& fvGridGeometry,
......@@ -70,7 +71,7 @@ void writeMpfaVelocities(const FVGridGeometry& fvGridGeometry,
writer.write("mpfa_scv_velocities");
}
//! function to write out the scv-wise velocities (overload for NOT mpfa)
//! Function to write out the scv-wise velocities (overload for NOT mpfa)
template<class FVGridGeometry, class GridVariables, class Sol,
std::enable_if_t<FVGridGeometry::discMethod != Dumux::DiscretizationMethod::ccmpfa, int> = 0>
void writeMpfaVelocities(const FVGridGeometry& fvGridGeometry,
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_PROBLEM_HH
#define DUMUX_INCOMPRESSIBLE_ONEP_TEST_PROBLEM_HH
......@@ -47,13 +48,11 @@
#define GRIDTYPE Dune::YaspGrid<2>
#endif
namespace Dumux
{
namespace Dumux {
// forward declarations
template<class TypeTag> class OnePTestProblem;
namespace Properties
{
namespace Properties {
// create the type tag nodes
// Create new type tags
namespace TTag {
......@@ -109,6 +108,7 @@ template<class TypeTag>
struct Scalar<TypeTag, TTag::OnePIncompressibleTpfaQuad> { using type = Quad; };
#endif
} // end namespace Properties
/*!
* \ingroup OnePTests
* \brief Test problem for the incompressible one-phase model:
......@@ -166,8 +166,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.
*
......@@ -194,10 +193,10 @@ public:
}
/*!
* \brief Return how much the domain is extruded at a given position.
* \brief Returns how much the domain is extruded at a given position.
*
* This means the factor by which a lower-dimensional
* entity needs to be expanded to get a full dimensional cell.
* entity needs to be expanded to get a full-dimensional cell.
*/
Scalar extrusionFactorAtPos(const GlobalPosition &globalPos) const
{
......@@ -208,7 +207,7 @@ public:
* \brief Returns the velocity
*
* The velocity is given for the case of a linear pressure solution
* with constant permeablity and without gravity
* with constant permeablity and without gravity.
*/
const GlobalPosition velocity() const
{
......
......@@ -21,6 +21,7 @@
* \ingroup OnePTests
* \brief The spatial params the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
#define DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -69,7 +70,7 @@ public:
* \param element The element
* \param scv The sub control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
* \return The intrinsic permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -83,7 +84,7 @@ public:
}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief test for the one-phase CC model
* \brief Test for the one-phase CC model
*/
#include <config.h>
#include <ctime>
......
......@@ -22,6 +22,7 @@
* \brief A test problem for the one-phase model:
* water is flowing from bottom to top through and around a low permeable lens.
*/
#ifndef DUMUX_1PTEST_PROBLEM_HH
#define DUMUX_1PTEST_PROBLEM_HH
......@@ -160,7 +161,7 @@ public:
}
/*!
* \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.
*/
......@@ -192,8 +193,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.
*
......@@ -214,7 +214,7 @@ public:
// \{
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* For this method, the \a priVars parameter stores primary
* variables.
......
......@@ -20,8 +20,9 @@
* \file
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p box model
* 1p box model.
*/
#ifndef DUMUX_1P_TEST_SPATIALPARAMS_HH
#define DUMUX_1P_TEST_SPATIALPARAMS_HH
......@@ -34,7 +35,7 @@ namespace Dumux {
/*!
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p box model
* 1p box model.
*/
template<class FVGridGeometry, class Scalar>
class OnePTestSpatialParams
......@@ -82,7 +83,7 @@ public:
* \param element The element
* \param scv The sub control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
* \return The intrinsic permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......@@ -100,7 +101,7 @@ public:
return permeability_;
}
/*! \brief Define the porosity in [-].
/*! \brief Defines the porosity in [-].
*
* \param globalPos The global position where we evaluate
*/
......@@ -110,7 +111,7 @@ public:
/*!
* \brief This method allows the generation of a statistical field using gstat
*
* \param gg The finite-volume grid Geometry used by the problem
* \param gg The finite-volume grid geometry used by the problem
*/
void initRandomField(const FVGridGeometry& gg)
{
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief test for the one-phase CC model
* \brief Test for the one-phase CC model
*/
#include <config.h>
#include <ctime>
......
......@@ -22,6 +22,7 @@
* \brief A test problem for the 1p model. A pipe system with circular cross-section
* and a branching point embedded in a three-dimensional world
*/
#ifndef DUMUX_ONEP_TUBES_TEST_PROBLEM_HH
#define DUMUX_ONEP_TUBES_TEST_PROBLEM_HH
......@@ -119,7 +120,7 @@ struct FluidSystem<TypeTag, TTag::TubesTest>
/*!
* \ingroup OnePTests
* \brief A test problem for the 1p model. A pipe system with circular cross-section
* \brief A test problem for the 1p model: A pipe system with circular cross-section
* and a branching point embedded in a three-dimensional world
*/
template <class TypeTag>
......@@ -181,14 +182,14 @@ public:
}
/*!
* \brief Return the temperature within the domain in [K].
* \brief Returns the temperature within the domain in [K].
*
*/
Scalar temperature() const
{ return 273.15 + 37.0; } // Body temperature
/*!
* \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.
*
* This means the factor by which a lower-dimensional (1D or 2D)
* entity needs to be expanded to get a full dimensional cell. The
......@@ -225,8 +226,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.
*
......@@ -245,7 +245,7 @@ public:
// \{
/*!
* \brief Evaluate the source term for all phases within a given
* \brief Evaluates the source term for all phases within a given
* sub-control-volume.
*
* This is the method for the case where the source term is
......@@ -286,7 +286,7 @@ public:
}
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* For this method, the \a priVars parameter stores primary
* variables.
......
......@@ -19,9 +19,10 @@
/*!
* \file
* \ingroup OnePTests
* \brief A test problem for the 1p model. A pipe system with circular cross-section
* \brief A test problem for the 1p model: A pipe system with circular cross-section
* and a branching point embedded in a three-dimensional world
*/
#ifndef DUMUX_ONEP_TUBES_TEST_SPATIALPARAMS_HH
#define DUMUX_ONEP_TUBES_TEST_SPATIALPARAMS_HH
......@@ -32,7 +33,7 @@ namespace Dumux {
/*!
* \ingroup OnePTests
* \brief A test problem for the 1p model. A pipe system with circular cross-section
* \brief A test problem for the 1p model: A pipe system with circular cross-section
* and a branching point embedded in a three-dimensional world
*/
template<class FVGridGeometry, class Scalar>
......@@ -63,7 +64,8 @@ public:
}
/*!
* \brief Return the radius of the circular pipe for the current sub-control volume in [m].
* \brief Returns the radius of the circular pipe for the current
* sub-control volume in [m].
*
* \param scv The sub control volume
*/
......@@ -81,7 +83,7 @@ public:
* \param element The element
* \param scv The sub control volume
* \param elemSol The element solution vector
* \return the intrinsic permeability
* \return The intrinsic permeability
*/
template<class ElementSolution>
PermeabilityType permeability(const Element& element,
......
......@@ -19,8 +19,9 @@
/*!
* \file
* \ingroup OnePTests
* \brief test for the 1pni CC model
* \brief Test for the 1pni CC model
*/
#include <config.h>
#include <ctime>
......
......@@ -19,9 +19,11 @@
/**
* \file
* \ingroup OnePTests
* \brief Test for the OnePModel in combination with the NI model for a conduction problem:
* The simulation domain is a tube where with an elevated temperature on the left hand side.
* \brief Test for the OnePModel in combination with the NI model for a conduction problem.
*
* The simulation domain is a tube with an elevated temperature on the left hand side.
*/
#ifndef DUMUX_1PNI_CONDUCTION_PROBLEM_HH
#define DUMUX_1PNI_CONDUCTION_PROBLEM_HH
......@@ -41,14 +43,12 @@
#include "spatialparams.hh"
namespace Dumux
{
namespace Dumux {
template <class TypeTag>
class OnePNIConductionProblem;
namespace Properties
{
namespace Properties {
// Create new type tags
namespace TTag {
struct OnePNIConduction { using InheritsFrom = std::tuple<OnePNI>; };
......@@ -57,7 +57,6 @@ struct OnePNIConductionCCTpfa { using InheritsFrom = std::tuple<OnePNIConduction
struct OnePNIConductionCCMpfa { using InheritsFrom = std::tuple<OnePNIConduction, CCMpfaModel>; };
} // end namespace TTag
// Set the grid type
template<class TypeTag>
struct Grid<TypeTag, TTag::OnePNIConduction> { using type = Dune::YaspGrid<2>; };
......@@ -84,15 +83,16 @@ struct SpatialParams<TypeTag, TTag::OnePNIConduction>
};
}
/*!
* \ingroup OnePTests
* \brief Test for the OnePModel in combination with the NI model for a conduction problem:
* The simulation domain is a tube where with an elevated temperature on the left hand side.
* \brief Test for the OnePModel in combination with the NI model for a conduction problem.
*
* The simulation domain is a tube with an elevated temperature on the left hand side.
*
* Initially the domain is fully saturated with water at a constant temperature.
* On the left hand side there is a Dirichlet boundary condition with an increased temperature and on the right hand side
* a Dirichlet boundary with constant pressure, saturation and temperature is applied.
* On the left hand side there is a Dirichlet boundary condition with an increased
* temperature and on the right hand side a Dirichlet boundary with constant pressure,
* saturation and temperature is applied.
*
* The results are compared to an analytical solution for a diffusion process:
\f[
......@@ -145,13 +145,13 @@ public:
temperatureExact_.resize(fvGridGeometry->numDofs());
}
//! get the analytical temperature
//! Get the analytical temperature
const std::vector<Scalar>& getExactTemperature()
{
return temperatureExact_;
}
//! udpate the analytical temperature
//! Udpate the analytical temperature
void updateExactTemperature(const SolutionVector& curSol, Scalar time)
{
const auto someElement = *(elements(this->fvGridGeometry().gridView()).begin());
......@@ -234,8 +234,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 position for which the bc type should be evaluated
*
......@@ -257,7 +256,7 @@ public:
// \{
/*!
* \brief Evaluate the initial value for a control volume.
* \brief Evaluates the initial value for a control volume.
*
* \param globalPos The position for which the initial condition should be evaluated
*
......
......@@ -19,10 +19,12 @@
/**
* \file
* \ingroup OnePTests
* \brief Test for the OnePModel in combination with the NI model for a convection problem:
* \brief Test for the OnePModel in combination with the NI model for a convection problem.
*
* The simulation domain is a tube where water with an elevated temperature is injected
* at a constant rate on the left hand side.
*/
#ifndef DUMUX_1PNI_CONVECTION_PROBLEM_HH
#define DUMUX_1PNI_CONVECTION_PROBLEM_HH
......@@ -40,14 +42,12 @@
#include <dumux/material/fluidmatrixinteractions/1p/thermalconductivityaverage.hh>
#include "spatialparams.hh"
namespace Dumux
{
namespace Dumux {
template <class TypeTag>
class OnePNIConvectionProblem;
namespace Properties
{
namespace Properties {
// Create new type tags
namespace TTag {
......@@ -83,10 +83,10 @@ struct SpatialParams<TypeTag, TTag::OnePNIConvection>
};
} // end namespace Properties