Commit f8e9a772 authored by Katharina Heck's avatar Katharina Heck
Browse files

[fix] test docu

parent 533268b3
......@@ -15,15 +15,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file combustionproblem1c.hh
*
* \file
* \ingroup MPNCTests
* \brief Problem where hot, pure liquid water is injected from the left hand side into a initially
* isotherm domain. The water is fully evaporated by a strong heat source.
* A local thermal non-equilibrium model is used: i.e. two different (fluid, solid)
* temperatures are primary variables.
*
* \ingroup MpNcBoxproblems
*
* \author Philipp Nuske
*/
#ifndef DUMUX_COMBUSTION_PROBLEM_ONE_COMPONENT_HH
......@@ -106,8 +104,7 @@ SET_INT_PROP(CombustionProblemOneComponent, NumEqBalance, GET_PROP_VALUE(TypeTag
}
/*!
* \ingroup MpNcBoxproblems
*
* \ingroup MPNCTests
* \brief Problem where water is injected from the left hand side into a porous media filled domain,
* which is supplied with energy from the right hand side to evaporate the water.
*/
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file combustionspatialparams.hh
*
* \file
* \ingroup MPNCTests
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
#ifndef DUMUX_COMBUSTION_SPATIALPARAMS_HH
......@@ -34,7 +34,10 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
//forward declaration
template<class TypeTag>
class CombustionSpatialParams;
......
......@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file evaporationatmosphereproblem.hh
* \ingroup MpNcBoxproblems
* \file
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*
......@@ -28,10 +28,6 @@
*
* The porous domain is bypassed with dry air. This way the equilibration process on top of the porous domain can be studied.
*
* The Problem is written, such that the kinetic consideration for mass and energy can
* be switched of by merely setting kinetic, kineticenergy respectivly to false.
* Boundary and initial conditions are specified for all cases.
*
* \author Philipp Nuske
*/
#ifndef DUMUX_EVAPORATION_ATMOSPHERE_PROBLEM_HH
......@@ -58,7 +54,11 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
*
* \brief Problem showcasing the capabilities of the kinetic model.
*/
template <class TypeTag>
class EvaporationAtmosphereProblem;
......
......@@ -17,7 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file evaporationatmospherespatialparams.hh
* \file
* \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
*
*/
......@@ -45,7 +46,11 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief spatialparameters for the kinetic test-case of the mpnc model. "Poor-mans" coupling of free-flow and porous medium.
*
*/
//forward declaration
template<class TypeTag>
class EvaporationAtmosphereSpatialParams;
......
......@@ -16,8 +16,9 @@
* 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
* \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
* around an obstacle with \f$10^3\f$ lower permeability.
......@@ -41,7 +42,12 @@
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
* around an obstacle with \f$10^3\f$ lower permeability.
*/
template <class TypeTag>
class ObstacleProblem;
......
......@@ -16,9 +16,9 @@
* 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
*
* \ingroup MPNCTests
* \brief The spatial parameters for the ObstacleProblem
*/
......@@ -34,7 +34,10 @@
namespace Dumux
{
/*!
* \ingroup MPNCTests
* \brief The spatial parameters for the ObstacleProblem
*/
//forward declaration
template<class TypeTag>
class ObstacleSpatialParams;
......
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