Commit f6d08fc5 authored by Philipp Nuske's avatar Philipp Nuske
Browse files

providing doxygen file descriptions


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@13453 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent f27a2ddf
......@@ -15,11 +15,11 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file
* Specification of the material params specific interfacial area surface
* as a function of wetting phase Saturation and capillary pressure.
* \file
*
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
#ifndef AWN_SURFACE_EXP_FCT_HH
#define AWN_SURFACE_EXP_FCT_HH
......
......@@ -16,8 +16,9 @@
*****************************************************************************/
/*!
* \file
* Specification of the material params for the interfacial area surface
* parameters
*
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is exponential.
*/
#ifndef AWN_SURFACE_EXP_FCT_PARAMS_HH
#define AWN_SURFACE_EXP_FCT_PARAMS_HH
......
......@@ -16,11 +16,10 @@
*****************************************************************************/
/*!
* \file
* Specification of the material params specific interfacial area surface as
* a function of wetting phase Saturation and capillary pressure.
*
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This function is of third order in pc.
*/
#ifndef AWN_SURFACE_EXP_SW_PC_TO_3
#define AWN_SURFACE_EXP_SW_PC_TO_3
......
......@@ -16,8 +16,9 @@
*****************************************************************************/
/*!
* \file
* Specification of the material params for the interfacial area surfaces
* parameters
*
* \brief Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This is of third order in pc.
*/
#ifndef AWN_SURFACE_EXP_SW_PC_TO_3_PARAMS
#define AWN_SURFACE_EXP_SW_PC_TO_3_PARAMS
......
......@@ -14,6 +14,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 Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
#ifndef AWN_SURFACE_PCMAX_FCT_HH
#define AWN_SURFACE_PCMAX_FCT_HH
......
......@@ -14,6 +14,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 Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization uses a maximum value of capillary pressure.
*/
#ifndef AWN_SURFACE_PCMAX_FCT_PARAMS_HH
#define AWN_SURFACE_PCMAX_FCT_PARAMS_HH
......
......@@ -16,8 +16,9 @@
*****************************************************************************/
/*!
* \file
* Specification of the material params specific interfacial area surface
* as a function of wetting phase Saturation and capillara pressure.
*
* \brief Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_2ND_ORDER_HH
......
......@@ -14,6 +14,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 Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_2ND_ORDER_PARAMS_HH
#define AWN_SURFACE_POLYNOMIAL_2ND_ORDER_PARAMS_HH
......
......@@ -14,6 +14,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 Specification of a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_HH
#define AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_HH
......
......@@ -14,6 +14,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 Specification of the parameters for a function relating volume specific interfacial area to capillary pressure and saturation.
* This parametrization is a second order polynomial which is zero for saturations of zero and one.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
#define AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
......
......@@ -14,17 +14,15 @@
* 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 CombustionProblem.hh
* \ingroup MpNcBoxproblems
/*!
* \file combustionproblem1c.hh
*
* \brief Problem where hot, pure air is injected from the left hand side into a initially
* isotherm domain. A kinetic model is used: i.e. three different (fluid, gas, solid)
* \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.
*
* 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.
* \ingroup MpNcBoxproblems
*
* \author Philipp Nuske
*/
......
......@@ -16,6 +16,11 @@
* 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 combustionspatialparams.hh
*
* \brief Spatialparameters for the combustionproblem1c. Parameters for the actual simulation domain and an outflow region are provided.
*/
#ifndef DUMUX_COMBUSTION_SPATIALPARAMS_HH
#define DUMUX_COMBUSTION_SPATIALPARAMS_HH
......@@ -132,7 +137,7 @@ public:
Snr_ = GET_RUNTIME_PARAM(TypeTag, Scalar, SpatialParams.soil.Snr);
characteristicLength_ = GET_RUNTIME_PARAM(TypeTag, Scalar, SpatialParams.PorousMedium.meanPoreSize);
intrinsicPermeability_ = (std::pow(characteristicLength_,2.0) * std::pow(porosity_,3.0)) / (150.0 * std::pow((1.0-porosity_),2.0));
intrinsicPermeability_ = (std::pow(characteristicLength_,2.0) * std::pow(porosity_,3.0)) / (150.0 * std::pow((1.0-porosity_),2.0)); // 1.69e-10 ; //
factorEnergyTransfer_ = GET_RUNTIME_PARAM(TypeTag, Scalar, SpatialParams.PorousMedium.factorEnergyTransfer);
factorMassTransfer_ = GET_RUNTIME_PARAM(TypeTag, Scalar, SpatialParams.PorousMedium.factorMassTransfer);
......
......@@ -16,8 +16,8 @@
* 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 EvaporationAtmosphereProblem.hh
/*!
* \file evaporationatmosphereproblem.hh
* \ingroup MpNcBoxproblems
*
* \brief Problem showcasing the capabilities of the kinetic model.
......
......@@ -16,6 +16,11 @@
* 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 evaporationatmospherespatialparams.hh
* \brief spatialparameters 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
......
......@@ -16,6 +16,11 @@
* 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 kinetic modules of the mpnc box model.
*/
#include "config.h"
#include <dumux/common/start.hh>
......
......@@ -14,6 +14,11 @@
* 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 local thermal non-equilibrium module of the mpnc box model.
*/
#include "config.h"
//#include "combustionproblem.hh"
......
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