Commit 3ecb0f3e authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[ documentation ]

added brief description for files
mainly added "\file" or copied text from below


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@10314 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent d78afc13
......@@ -17,6 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file
*
* \brief This file provides the infrastructure to use quad-precision
* floating point values in the numerical models.
*/
......
......@@ -19,6 +19,13 @@
* 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 Contains the quantities which are constant within a
* finite volume in the non-isothermal CO2
* model.
*/
#ifndef DUMUX_CO2_VOLUME_VARIABLES_HH
#define DUMUX_CO2_VOLUME_VARIABLES_HH
......
......@@ -32,6 +32,7 @@
namespace Dumux
{
/*!
* \file
* \brief The mass conservation part of the Mp-Nc model.
*
* This is the class represents methods which are shared amongst all
......
......@@ -16,6 +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 M-phase, N-component specific details needed to
* approximately calculate the local defect in the fully implicit scheme.
*
*/
#ifndef DUMUX_MPNC_LOCAL_RESIDUAL_HH
#define DUMUX_MPNC_LOCAL_RESIDUAL_HH
......@@ -30,10 +36,10 @@ namespace Dumux
/*!
* \ingroup MPNCModel
* \ingroup ImplicitLocalResidual
* \brief two-phase, N-component specific details needed to
* \brief M-phase, N-component specific details needed to
* approximately calculate the local defect in the fully implicit scheme.
*
* This class is used to fill the gaps in BoxLocalResidual for the
* This class is used to fill the gaps in ImplicitLocalResidual for the
* two-phase, N-component twophase flow.
*/
template<class TypeTag>
......
......@@ -16,6 +16,13 @@
* 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 A fully implicit model for M-phase, N-component flow using
* vertex centered finite volumes.
*
*/
#ifndef DUMUX_MPNC_MODEL_HH
#define DUMUX_MPNC_MODEL_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 Writes the VTK output files for a solution of the Mp-Nc model.
*/
#ifndef DUMUX_MPNC_VTK_WRITER_HH
#define DUMUX_MPNC_VTK_WRITER_HH
......
......@@ -16,6 +16,13 @@
* 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 A VTK writer module which adheres to the required API but
* does nothing.
*/
#ifndef DUMUX_MPNC_VTK_BASE_WRITER_HH
#define DUMUX_MPNC_VTK_BASE_WRITER_HH
......
......@@ -16,6 +16,14 @@
* 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 Components
*
* \brief Properties of mesitylene.
*
*/
#ifndef DUMUX_MESITYLENE_HH
#define DUMUX_MESITYLENE_HH
......
......@@ -16,6 +16,13 @@
* 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 Components
*
* \brief Properties of xylene.
*/
#ifndef DUMUX_XYLENE_HH
#define DUMUX_XYLENE_HH
......
......@@ -17,8 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file parkerVanGen3pparams.hh Implementation of van Genuchten's capillary
* pressure <-> saturation relation
* \file
*
* \brief Implementation of van Genuchten's capillary pressure-saturation relation.
*
*/
#ifndef PARKERVANGEN_3P_HH
#define PARKERVANGEN_3P_HH
......
......@@ -17,8 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file vangenuchtenparams.hh Specification of the material params
* for the van Genuchten capillary pressure model.
* \file
*
* \brief Specification of the material params for the van Genuchten
* capillary pressure model.
*
* In comparison to the 2p version, this parameter container also includes
* the residual saturations, as their inclusion is very model-specific.
......
......@@ -19,6 +19,8 @@
/*!
* \file 2padapter.hh
*
* \brief Makes the twophase capillary pressure-saturation relations available under the M-phase API for material laws
*
* Makes the twophase capillary pressure-saturation relations
* available under the M-phase API for material laws
*/
......
......@@ -17,8 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file mplinearmaterialparams.hh
*
* \file
*
* \brief Implements a linear saturation-capillary pressure relation
*
* Implements a linear saturation-capillary pressure relation for
* M-phase fluid systems.
*/
......
......@@ -17,9 +17,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file linearmaterialparams.hh
* \file
*
* Reference implementation of parameters for the M-phase linear
* \brief Reference implementation of parameters for the M-phase linear
* material material.
*/
#ifndef MP_LINEAR_MATERIAL_PARAMS_HH
......
......@@ -14,7 +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 sequential 2p models
*/
#define STRUCTUREDGRID 1
#include "config.h"
......
......@@ -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 Test problem for the sequential 2p models
*/
#ifndef TEST_2P_SPATIALPARAMETERS_HH
#define TEST_2P_SPATIALPARAMETERS_HH
......
......@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Test for the adaptive 2p2c model
*/
#include "config.h"
#include "test_adaptive2p2cproblem.hh"
......
......@@ -16,6 +16,13 @@
* 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 Definition of the spatial params properties for the Forchheimer problem
*
*/
#ifndef DUMUX_FORCHHEIMER_SPATIAL_PARAMS_HH
#define DUMUX_FORCHHEIMER_SPATIAL_PARAMS_HH
......
......@@ -16,6 +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 The spatial parameters for the ObstacleProblem
*/
#ifndef DUMUX_OBSTACLE_SPATIAL_PARAMS_HH
#define DUMUX_OBSTACLE_SPATIAL_PARAMS_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