Skip to content
GitLab
Commit e54577fe authored by Johannes Hommel's avatar Johannes Hommel
Browse files

[doxygen] updated doxygen for all 1p and 1pnc tests

parent 5a9af85f
Hide whitespace changes
Inline Side-by-side
doc/doxygen/modules.txt
View file @ e54577fe
......@@ -19,7 +19,7 @@
* \defgroup SequentialOnePModel Sequential
* # Pressure
* \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/pressure.hh
*
*
* # Velocity
* \copydetails ./porousmediumflow/1p/sequential/diffusion/cellcentered/velocity.hh
*/
......@@ -45,7 +45,7 @@
* \defgroup SequentialTwoPModel Sequential
* # Pressure
* \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/pressure.hh
*
*
* # Velocity
* \copydetails ./porousmediumflow/2p/sequential/diffusion/cellcentered/velocity.hh
*/
......@@ -65,7 +65,7 @@
* \defgroup SequentialTwoPTwoCModel Sequential
* # Pressure
* \copydetails ./porousmediumflow/2p2c/sequential/fvpressure.hh
*
*
* # Velocity
* \copydetails ./porousmediumflow/2p2c/sequential/fvtransport.hh
*/
......@@ -172,9 +172,11 @@
*/
/*! \ingroup BenchmarksAndTests
* \defgroup OnePTests 1p (one phase) benchmarks and tests
* OnePTests contain various tests using a OnePModel. The files are listed below, with hopefully self-explanatory names.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup OnePNCTests 1pnc (one phase, n-component) benchmarks and tests
* OnePNCTests contain various tests using a OneNCPModel. The files are listed below, with hopefully self-explanatory names.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup OnePNCMinTests 1pncmin (one phase, n-component mineralization) benchmarks and tests
......@@ -202,25 +204,25 @@
*/
/*! \ingroup BenchmarksAndTests
* \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests
*/
*/
/*! \ingroup BenchmarksAndTests
* \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests
*/
*/
/*! \ingroup BenchmarksAndTests
* \defgroup MPNCTests MPNC (m phase, n-component) benchmarks and tests
*/
*/
/*! \ingroup BenchmarksAndTests
* \defgroup MPNCTests MPNC (m phase, n-component) benchmarks and tests
*/
/*! \ingroup BenchmarksAndTests
* \defgroup RichardsTests Richards benchmarks and tests
*/
*/
/*! \ingroup BenchmarksAndTests
* \defgroup RichardsNCTests Richards n-component benchmarks and tests
*/
*/
/*! \ingroup BenchmarksAndTests
* \defgroup TracerTests Tracer benchmarks and tests
*/
*/
/* ***************** Discretization ******************/
/*!
......@@ -374,30 +376,30 @@
* parameters. For example permeability, porosity etc.
*
*/
/* ***************** Adaptive ******************/
/*!
* \defgroup Adaptive Adaptive
* TODO: Doc me in modules.txt!
*/
/* ***************** Assembly ******************/
/*!
* \defgroup Assembly Assembly
* TODO: Doc me in modules.txt!
*/
/* ***************** Common ******************/
/*!
* \defgroup Common Common
* TODO: Doc me in modules.txt!
*/
/*!
/*!
* \ingroup Common
* \defgroup Properties Properties
* TODO: Doc me in modules.txt!
*/
/* ***************** InputOutput ******************/
/*!
* \defgroup InputOutput Input Output
......
test/porousmediumflow/1p/implicit/1pniconductionproblem.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/**
* \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.
*/
......@@ -75,9 +76,7 @@ SET_STRING_PROP(OnePNIConductionCCMpfaProblem, ModelParameterGroup, "MpfaTest");
/*!
* \ingroup OnePNIModel
* \ingroup ImplicitTestProblems
*
* \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.
*
......
test/porousmediumflow/1p/implicit/1pniconvectionproblem.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/**
* \file
* \ingroup OnePTests
* \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.
......@@ -73,9 +74,7 @@ SET_STRING_PROP(OnePNIConvectionCCMpfaProblem, ModelParameterGroup, "MpfaTest");
/*!
* \ingroup OnePNIModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \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.
......
test/porousmediumflow/1p/implicit/1pnispatialparams.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief Definition of the spatial parameters for the 1pni problems.
*/
#ifndef DUMUX_TEST_1PNI_SPATIAL_PARAMS_HH
......@@ -30,9 +30,7 @@ namespace Dumux
{
/*!
* \ingroup OnePNIModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \brief Definition of the spatial parameters for the 1pni problems.
*/
template<class TypeTag>
......
test/porousmediumflow/1p/implicit/1ptestproblem.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief A test problem for the one-phase model:
* water is flowing from bottom to top through and around a low permeable lens.
*/
......@@ -68,8 +68,7 @@ SET_TYPE_PROP(OnePTestProblem, SpatialParams, OnePTestSpatialParams<TypeTag> );
}
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
* \ingroup OnePTests
* \brief Test problem for the one-phase model:
* water is flowing from bottom to top through and around a low permeable lens.
*
......
test/porousmediumflow/1p/implicit/1ptestspatialparams.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p box model
*/
......@@ -42,9 +42,7 @@ NEW_TYPE_TAG(OnePTestSpatialParams);
}
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p box model
*/
......
test/porousmediumflow/1p/implicit/compressible/problem.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup OnePTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_PROBLEM_HH
......@@ -73,7 +74,13 @@ SET_BOOL_PROP(OnePCompressible, EnableGridFluxVariablesCache, false);
SET_BOOL_PROP(OnePCompressible, EnableFVGridGeometryCache, false);
} // end namespace Properties
/*!
* \ingroup OnePTests
* \brief Test problem for the compressible one-phase model:
*\todo doc me!
* <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt>
*/
template<class TypeTag>
class OnePTestProblem : public PorousMediumFlowProblem<TypeTag>
{
......
test/porousmediumflow/1p/implicit/compressible/spatialparams.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup OnePTests
* \brief The spatial params the incompressible test
*/
#ifndef DUMUX_COMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -28,6 +29,11 @@
namespace Dumux
{
/*!
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* compressible 1p model
*/
template<class TypeTag>
class OnePTestSpatialParams : public FVSpatialParamsOneP<TypeTag>
{
......
test/porousmediumflow/1p/implicit/fractureproblem.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief A discrete fracture network embedded in an impermeable matrix.
* The fracture is a 2D network embedded in 3D.
*/
......@@ -71,8 +71,7 @@ SET_PROP(FractureProblem, FluidSystem)
} // end namespace Properties
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
* \ingroup OnePTests
* \brief A discrete fracture network embedded in an impermeable matrix.
* The fracture is a 2D network embedded in 3D.
*
......
test/porousmediumflow/1p/implicit/fracturespatialparams.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief The spatial parameters for the LensProblem which uses the
* two-phase fully implicit model
*/
......@@ -44,8 +44,7 @@ SET_TYPE_PROP(FractureSpatialParams, SpatialParams, Dumux::FractureSpatialParams
}
/*!
* \ingroup TwoPModel
* \ingroup ImplicitTestProblems
* \ingroup OnePTests
* \brief The spatial parameters for the LensProblem which uses the
* two-phase fully implicit model
*/
......
test/porousmediumflow/1p/implicit/incompressible/problem.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup OnePTests
* \brief The properties for the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_PROBLEM_HH
......@@ -75,7 +76,13 @@ SET_BOOL_PROP(OnePIncompressible, EnableGridFluxVariablesCache, false);
SET_BOOL_PROP(OnePIncompressible, EnableFVGridGeometryCache, false);
} // end namespace Properties
/*!
* \ingroup OnePTests
* \brief Test problem for the incompressible one-phase model:
*\todo doc me!
* <tt>./test_box1pfv</tt> or
* <tt>./test_cc1pfv</tt>
*/
template<class TypeTag>
class OnePTestProblem : public PorousMediumFlowProblem<TypeTag>
{
......
test/porousmediumflow/1p/implicit/incompressible/spatialparams.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup OnePTests
* \brief The spatial params the incompressible test
*/
#ifndef DUMUX_INCOMPRESSIBLE_ONEP_TEST_SPATIAL_PARAMS_HH
......@@ -28,6 +29,11 @@
namespace Dumux
{
/*!
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* incompressible 1p model
*/
template<class TypeTag>
class OnePTestSpatialParams : public FVSpatialParamsOneP<TypeTag>
{
......
test/porousmediumflow/1p/implicit/pointsources/1psingularityproblem.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief A test problem for the one-phase model:
* Water is injected in one single point in the middle of the domain.
*/
......@@ -65,8 +65,7 @@ SET_TYPE_PROP(OnePSingularityTypeTag, SpatialParams, OnePSingularitySpatialParam
}
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
* \ingroup OnePTests
* \brief Test problem for the one-phase model:
* Water is injected in a single point in the middle of the domain.
*
......
test/porousmediumflow/1p/implicit/pointsources/1psingularityproblemtimedependent.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief A test problem for the one-phase model:
* Water is injected in one single point in the middle of the domain.
*/
......@@ -44,8 +44,7 @@ SET_TYPE_PROP(OnePSingularityTimeDependentCCTpfaTypeTag, PointSource, SolDepende
}
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
* \ingroup OnePTests
* \brief Test problem for the one-phase model:
* Water is injected in a single point in the middle of the domain.
*
......
test/porousmediumflow/1p/implicit/pointsources/1psingularityspatialparams.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p model with point sources
*/
......@@ -31,9 +31,7 @@ namespace Dumux
{
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \brief The spatial parameters class for the test problem using the
* 1p model with point sources
*/
......
test/porousmediumflow/1p/implicit/tubesproblem.hh
View file @ e54577fe
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
*
* \ingroup OnePTests
* \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
*/
......@@ -68,9 +68,7 @@ SET_PROP(TubesTestProblem, FluidSystem)
} // end namespace Properties
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \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
*/
......
test/porousmediumflow/1p/implicit/tubesspatialparams.hh
View file @ e54577fe
......@@ -18,8 +18,8 @@
*****************************************************************************/
/*!
* \file
*
* \brief A test problem for the 1p model. A pipe system with circular cross-section
* \ingroup OnePTests
* \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
......@@ -31,9 +31,7 @@ namespace Dumux
{
/*!
* \ingroup OnePModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePTests
* \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
*/
......
test/porousmediumflow/1pnc/implicit/1p2cniconductionproblem.hh
View file @ e54577fe
......@@ -18,9 +18,9 @@
*****************************************************************************/
/**
* \file
* \brief Test for the OnePTwoCModel in combination with the NI model for a conduction problem:
* \ingroup OnePNCTests
* \brief Test for the OnePNCModel 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.
*
*/
#ifndef DUMUX_1P2CNI_CONDUCTION_TEST_PROBLEM_HH
#define DUMUX_1P2CNI_CONDUCTION_TEST_PROBLEM_HH
......@@ -72,9 +72,7 @@ SET_BOOL_PROP(OnePTwoCNIConductionProblem, UseMoles, true);
/*!
* \ingroup OnePNCModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePNCTests
* \brief Definition of a problem, for the 1pnc problem:
* Nitrogen is dissolved in the water phase and
* is transported with the water flow from the left side to the right.
......
test/porousmediumflow/1pnc/implicit/1p2cniconvectionproblem.hh
View file @ e54577fe
......@@ -16,13 +16,12 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*
* \file
* \brief Test for the OnePTwoCModel 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.
*
*/
/**
* \file
* \ingroup OnePNCTests
* \brief Test for the OnePNCModel 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.
*/
#ifndef DUMUX_1P2CNI_CONVECTION_TEST_PROBLEM_HH
#define DUMUX_1P2CNI_CONVECTION_TEST_PROBLEM_HH
......@@ -73,9 +72,7 @@ SET_BOOL_PROP(OnePTwoCNIConvectionProblem, UseMoles, true);
/*!
* \ingroup OnePTwoCModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePNCTests
* \brief Test for the OnePTwoCModel 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.
......
test/porousmediumflow/1pnc/implicit/1p2ctestproblem.hh
View file @ e54577fe
......@@ -18,6 +18,7 @@
*****************************************************************************/
/**
* \file
* \ingroup OnePNCTests
* \brief Definition of a problem, for the 1pnc problem:
* Component transport of nitrogen dissolved in the water phase.
*/
......@@ -72,9 +73,7 @@ SET_BOOL_PROP(OnePTwoCTestProblem, UseMoles, true);
/*!
* \ingroup OnePNCModel
* \ingroup ImplicitTestProblems
*
* \ingroup OnePNCTests
* \brief Definition of a problem, for the 1pnc problem:
* Nitrogen is dissolved in the water phase and
* is transported with the water flow from the left side to the right.
......
Supports Markdown
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