Commit 9aeb02bb authored by Sina Ackermann's avatar Sina Ackermann Committed by Simon Emmert

[doxygen] Adapt documentation for tracer tests

parent 303bac48
......@@ -18,9 +18,10 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the tracer CC model
* \ingroup TracerTests
* \brief Test for the tracer CC model.
*/
#include <config.h>
#include "problem_1p.hh"
......
......@@ -21,6 +21,7 @@
* \ingroup TracerTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_ONEP_TRACER_TEST_PROBLEM_HH
#define DUMUX_ONEP_TRACER_TEST_PROBLEM_HH
......@@ -129,8 +130,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 finite element
* \param scvf The sub control volume face
......
......@@ -22,6 +22,7 @@
* \brief Definition of a problem, for the tracer problem:
* A rotating velocity field mixes a tracer band in a porous groundwater reservoir.
*/
#ifndef DUMUX_TRACER_TEST_PROBLEM_HH
#define DUMUX_TRACER_TEST_PROBLEM_HH
......@@ -117,7 +118,7 @@ public:
static Scalar molarMass(unsigned int compIdx)
{ return 0.300; }
//! binary diffusion coefficient
//! Binary diffusion coefficient
//! (might depend on spatial parameters like pressure / temperature)
static Scalar binaryDiffusionCoefficient(unsigned int compIdx,
const Problem& problem,
......@@ -200,7 +201,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,8 +19,9 @@
/*!
* \file
* \ingroup TracerTests
* \brief The spatial params the incompressible test
* \brief The spatial parameters for the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
#define DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -32,7 +33,7 @@ namespace Dumux {
/*!
* \ingroup TracerTests
* \brief The spatial params the incompressible test
* \brief The spatial parameters for the incompressible test
*/
template<class FVGridGeometry, class Scalar>
class OnePTestSpatialParams
......@@ -94,8 +95,7 @@ public:
}
/*!
* \brief Function for defining the porosity.
* That is possibly solution dependent.
* \brief Function for defining the porosity which is possibly solution dependent.
*
* \return the porosity
*/
......
......@@ -21,6 +21,7 @@
* \ingroup TracerTests
* \brief Definition of the spatial parameters for the tracer problem
*/
#ifndef DUMUX_TRACER_TEST_SPATIAL_PARAMS_HH
#define DUMUX_TRACER_TEST_SPATIAL_PARAMS_HH
......@@ -55,7 +56,7 @@ public:
: ParentType(fvGridGeometry) {}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......@@ -63,7 +64,7 @@ public:
{ return 0.2; }
/*!
* \brief Define the dispersivity.
* \brief Defines the dispersivity.
*
* \param element The finite element
* \param scv The sub-control volume
......@@ -75,15 +76,15 @@ public:
const ElementSolution& elemSol) const
{ return 0; }
//! Fluid properties that are spatial params in the tracer model
//! Fluid properties that are spatial parameters in the tracer model
//! They can possible vary with space but are usually constants
//! fluid density
//! Fluid density
Scalar fluidDensity(const Element &element,
const SubControlVolume& scv) const
{ return 1000; }
//! fluid molar mass
//! Fluid molar mass
Scalar fluidMolarMass(const Element &element,
const SubControlVolume& scv) const
{ return 18.0; }
......@@ -91,7 +92,7 @@ public:
Scalar fluidMolarMass(const GlobalPosition &globalPos) const
{ return 18.0; }
//! velocity field
//! Velocity field
template<class ElementVolumeVariables>
Scalar volumeFlux(const Element &element,
const FVElementGeometry& fvGeometry,
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the tracer CC model
* \ingroup TracerTests
* \brief Test for the tracer CC model.
*/
#include <config.h>
......
......@@ -19,7 +19,7 @@
/**
* \file
* \ingroup TracerTests
* \brief Definition of a problem, for the tracer problem:
* \brief Definition of a problem for the tracer problem:
* A rotating velocity field mixes a tracer band in a porous groundwater reservoir.
*/
#ifndef DUMUX_TRACER_TEST_PROBLEM_HH
......@@ -43,7 +43,7 @@
namespace Dumux {
/**
* \ingroup TracerTests
* \brief Definition of a problem, for the tracer problem:
* \brief Definition of a problem for the tracer problem:
* A rotating velocity field mixes a tracer band in a porous groundwater reservoir.
*/
template <class TypeTag>
......@@ -123,7 +123,7 @@ public:
static Scalar molarMass(unsigned int compIdx)
{ return 0.300; }
//! binary diffusion coefficient
//! Binary diffusion coefficient
//! (might depend on spatial parameters like pressure / temperature)
static Scalar binaryDiffusionCoefficient(unsigned int compIdx,
const Problem& problem,
......@@ -160,7 +160,7 @@ struct FluidSystem<TypeTag, TTag::TracerTest> { using type = TracerFluidSystem<T
/*!
* \ingroup TracerTests
*
* \brief Definition of a problem, for the tracer problem:
* \brief Definition of a problem for the tracer problem:
* A lens of contaminant tracer is diluted by diffusion and a base groundwater flow
*
* This problem uses the \ref TracerModel model.
......@@ -224,7 +224,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,8 +19,9 @@
/*!
* \file
* \ingroup TracerTests
* \brief Definition of the spatial parameters for the tracer problem
* \brief Definition of the spatial parameters for the tracer problem.
*/
#ifndef DUMUX_TRACER_TEST_SPATIAL_PARAMS_HH
#define DUMUX_TRACER_TEST_SPATIAL_PARAMS_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup TracerTests
* \brief Definition of the spatial parameters for the tracer problem
* \brief Definition of the spatial parameters for the tracer problem.
*/
template<class FVGridGeometry, class Scalar>
class TracerTestSpatialParams
......@@ -55,7 +56,7 @@ public:
: ParentType(fvGridGeometry) {}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......@@ -63,7 +64,7 @@ public:
{ return 0.2; }
/*!
* \brief Define the dispersivity.
* \brief Defines the dispersivity.
*
* \param element The finite element
* \param scv The sub-control volume
......@@ -75,15 +76,15 @@ public:
const ElementSolution& elemSol) const
{ return 0; }
//! Fluid properties that are spatial params in the tracer model
//! They can possible vary with space but are usually constants
//! Fluid properties that are spatial parameters in the tracer model
//! They can possibly vary with space but are usually constants
//! fluid density
//! Fluid density
Scalar fluidDensity(const Element &element,
const SubControlVolume& scv) const
{ return 1000; }
//! fluid molar mass
//! Fluid molar mass
Scalar fluidMolarMass(const Element &element,
const SubControlVolume& scv) const
{ return 18.0; }
......@@ -91,7 +92,7 @@ public:
Scalar fluidMolarMass(const GlobalPosition &globalPos) const
{ return 18.0; }
//! velocity field
//! Velocity field
GlobalPosition velocity(const SubControlVolumeFace& scvf) const
{
GlobalPosition vel(1e-5);
......@@ -105,7 +106,7 @@ public:
return vel;
}
//! velocity field
//! Velocity field
template<class ElementVolumeVariables>
Scalar volumeFlux(const Element &element,
const FVElementGeometry& fvGeometry,
......
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief test for the two-phase porousmedium flow model
* \ingroup TracerTests
* \brief Test for the multi-component tracer porous medium flow model
*/
#include <config.h>
......
......@@ -19,7 +19,7 @@
/**
* \file
* \ingroup TracerTest
* \brief Definition of a problem, for the MaxwellStefan problem:
* \brief Definition of a problem for the MaxwellStefan problem:
* A rotating velocity field mixes a MaxwellStefan band in a porous groundwater reservoir.
*/
#ifndef DUMUX_MAXWELL_STEFAN_TEST_PROBLEM_HH
......@@ -128,7 +128,7 @@ public:
DUNE_THROW(Dune::InvalidStateException, "Invalid component index " << compIdx);
}
//! binary diffusion coefficient
//! Binary diffusion coefficient
//! (might depend on spatial parameters like pressure / temperature)
static Scalar binaryDiffusionCoefficient(unsigned int compIdx,
const Problem& problem,
......@@ -146,7 +146,7 @@ public:
<< compIdx <<" is undefined!\n");
}
//! binary diffusion coefficient
//! Binary diffusion coefficient
//! (might depend on spatial parameters like pressure / temperature)
static Scalar binaryDiffusionCoefficient(unsigned int compIIdx,
unsigned int compJIdx,
......@@ -194,7 +194,8 @@ struct FluidSystem<TypeTag, TTag::MaxwellStefanTest> { using type = H2N2CO2Fluid
/*!
* \ingroup TracerTest
* \brief Definition of a problem, for the MaxwellStefan problem *
* \brief Definition of a problem for the MaxwellStefan problem.
*
* This problem uses the MaxwellStefan equations.
*
* To run the simulation execute the following line in shell:
......@@ -363,8 +364,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 position for which the bc type should be evaluated
* The units must be according to either using mole or mass fractions. (mole/(m^2*s) or kg/(m^2*s))
......@@ -380,7 +380,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
*
......@@ -426,6 +426,6 @@ private:
bool plotOutput_;
};
} //end namespace Dumux
} // end namespace Dumux
#endif
......@@ -19,8 +19,9 @@
/*!
* \file
*\ingroup TracerTest
* \brief Definition of the spatial parameters for the MaxwellStefan problem
* \brief Definition of the spatial parameters for the MaxwellStefan problem.
*/
#ifndef DUMUX_MAXWELL_STEFAN_TEST_SPATIAL_PARAMS_HH
#define DUMUX_MAXWELL_STEFAN_TEST_SPATIAL_PARAMS_HH
......@@ -31,7 +32,7 @@ namespace Dumux {
/*!
* \ingroup TracerTest
* \brief Definition of the spatial parameters for the MaxwellStefan problem
* \brief Definition of the spatial parameters for the MaxwellStefan problem.
*/
template<class FVGridGeometry, class Scalar>
class MaxwellStefanTestSpatialParams
......@@ -55,7 +56,7 @@ public:
: ParentType(fvGridGeometry) {}
/*!
* \brief Define the porosity \f$\mathrm{[-]}\f$.
* \brief Defines the porosity \f$\mathrm{[-]}\f$.
*
* \param globalPos The global position
*/
......@@ -63,7 +64,7 @@ public:
{ return 0.4; }
/*!
* \brief Define the dispersivity.
* \brief Defines the dispersivity.
*
* \param element The finite element
* \param scv The sub-control volume
......@@ -75,20 +76,20 @@ public:
const ElementSolution& elemSol) const
{ return 0; }
//! Fluid properties that are spatial params in the tracer model
//! They can possible vary with space but are usually constants
//! Fluid properties that are spatial parameters in the tracer model
//! They can possibly vary with space but are usually constants
//! fluid density
//! Fluid density
Scalar fluidDensity(const Element &element,
const SubControlVolume& scv) const
{ return 1; }
//! fluid molar mass
//! Fluid molar mass
Scalar fluidMolarMass(const Element &element,
const SubControlVolume& scv) const
{ return 0.02896; /*air*/}
//! velocity field
//! Velocity field
GlobalPosition velocity(const SubControlVolumeFace& scvf) const
{
GlobalPosition vel(0.0);
......@@ -96,7 +97,7 @@ public:
return vel;
}
//! velocity field
//! Velocity field
template<class ElementVolumeVariables>
Scalar volumeFlux(const Element &element,
const FVElementGeometry& fvGeometry,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment