Commit 6c285f27 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[doxygen]

updated doxygen docu, there are still 7 warnings are produced


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@13381 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 854a2e52
......@@ -185,21 +185,15 @@
*/
/*!
* \ingroup ImplicitModels
* \defgroup BoxStokesModel Stokes
*
* \copydetails Dumux::StokesModel
*/
/*!
* \ingroup ImplicitModels
* \defgroup BoxStokes2cModel Two-component Stokes
* \defgroup NIModel Non-Isothermal
*
* \copydetails Dumux::Stokes2cModel
* \copydetails Dumux::NIModel
*/
/*!
* \ingroup ImplicitModels
* \defgroup BoxStokes2cniModel Non-isothermal two-component Stokes
* \defgroup BoxStokesModel Stokes
*
* \copydetails Dumux::Stokes2cniModel
* \copydetails Dumux::StokesModel
*/
/*!
* \ingroup ImplicitModels
......@@ -231,6 +225,24 @@
*
* \copydetails Dumux::ElTwoPModel
*/
/*!
* \ingroup ImplicitModels
* \defgroup MultidomainModel Multidomain
*/
/*!
* \ingroup ImplicitModels
* \defgroup TwoPTwoCStokesTwoCModel Two-component, Stokes-Darcy
*
* \copydetails Dumux::TwoPTwoCModel
* \copydetails Dumux::StokesncModel
*/
/*!
* \ingroup ImplicitModels
* \defgroup TwoPTwoCNIStokesTwoCNIModel Non-isothermal, two-component, Stokes-Darcy
*
* \copydetails Dumux::TwoPTwoCNIModel
* \copydetails Dumux::StokesncniModel
*/
/*!
* \ingroup ImplicitModel
* \defgroup ImplicitBaseProblems Base Problems
......
......@@ -67,6 +67,7 @@ namespace Dumux {
* \f[
\frac{\partial (\varrho_g u_g)}{\partial t}
+ \boldsymbol{\nabla} \boldsymbol{\cdot} \left( \varrho_g h_g {\boldsymbol{v}}_g
- \sum_\kappa \left[ h^\kappa_g D^\kappa_g \varrho_g \frac{M^\kappa}{M_g} \nabla x^\kappa_g \right]
- \lambda_g \boldsymbol{\nabla} T \right) - q_T = 0
* \f]
*
......
......@@ -23,7 +23,7 @@
/*!
* \ingroup Properties
* \ingroup CCProperties
* \ingroup ImplicitProperties
* \ingroup CCModel
* \file
* \brief Specify the shape functions, operator assemblers, etc
......
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup TwoPTwoCNIModel
* \ingroup NIModel
* \ingroup ImplicitIndices
* \brief Indices for the non-isothermal two-phase two-component model
*
......
......@@ -31,7 +31,7 @@
namespace Dumux
{
/*!
* \ingroup TwoPTwoCNIModel
* \ingroup NIModel
* \ingroup ImplicitLocalResidual
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase two-component fully implicit model.
......
......@@ -27,7 +27,14 @@
#include "niproperties.hh"
namespace Dumux {
/*!
* \ingroup NIModel
* *
* This model implements a non-isothermal flow for single and multi-phase
* transport problems
*
* \todo The equations have to be added here
*/
template<class TypeTag>
class NIModel : public GET_PROP_TYPE(TypeTag, IsothermalModel)
{
......
......@@ -32,7 +32,7 @@ namespace Dumux
{
/*!
* \ingroup TwoPTwoCNIModel
* \ingroup NIModel
* \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are are constant within a
* finite volume in the non-isothermal two-phase two-component
......
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
* See the file COPYING for full copying permissions. *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* 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 mesh creator for the coupled problems
*/
#ifndef DUMUX_INTERFACEMESHCREATOR_HH
#define DUMUX_INTERFACEMESHCREATOR_HH
......@@ -6,6 +30,12 @@
namespace Dumux
{
/*!
* \brief A mesh creator for the coupled problems
*
* A mesh creator, that creates a grid, which can be refined towards the
* coupling interface and the top of the domain.
*/
template <class Grid>
class InterfaceMeshCreator
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Linear
*
* \brief Provides linear solvers using the PDELab AMG backends.
*/
......
......@@ -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 Provides a helper class for nonoverlapping
* decomposition using the PDELab AMG.
*/
#ifndef DUMUX_AMGPARALLELHELPERS_HH
#define DUMUX_AMGPARALLELHELPERS_HH
......@@ -27,11 +33,10 @@
namespace Dumux
{
//========================================================
// A parallel helper class providing a nonoverlapping
// decomposition of all degrees of freedom
//========================================================
/*!
* \brief A parallel helper class providing a nonoverlapping
* decomposition of all degrees of freedom
*/
// operator that resets result to zero at constrained DOFS
template<class TypeTag>
class ParallelISTLHelper
......
......@@ -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 Properties
* \ingroup Linear
*
* \brief Defines some fundamental properties for the PDELab AMG solver.
*/
#ifndef DUMUXAMGPROPERTIES_HH
#define DUMUXAMGPROPERTIES_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 Finite element map for P0 elements
*/
#ifndef DUMUX_P0FEM_HH
#define DUMUX_P0FEM_HH
......@@ -28,6 +34,9 @@
namespace Dumux {
/*!
* \brief Finite element map for P0 elements
*/
template<class D, class R, int d, bool isCube = true>
class P0LocalFiniteElementMap
: public Dune::PDELab::SimpleLocalFiniteElementMap< Dune::P0LocalFiniteElement<D,R,d> >
......
......@@ -16,6 +16,10 @@
* 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 a class to exchange entries of a vector
*/
#ifndef DUMUX_VECTOR_EXCHANGE_HH
#define DUMUX_VECTOR_EXCHANGE_HH
......@@ -23,8 +27,9 @@
namespace Dumux
{
// A DataHandle class to exchange entries of a vector
/*!
* \brief A data handle class to exchange entries of a vector
*/
template<class Mapper, class Vector> // mapper type and vector type
class VectorExchange
: public Dune::CommDataHandleIF<VectorExchange<Mapper,Vector>,
......
......@@ -21,7 +21,7 @@
*
* \ingroup Components
*
* \brief A simple class for the \f$Air\f$ fluid properties
* \brief A simple class for the air fluid properties
*/
#ifndef DUMUX_AIR_HH
#define DUMUX_AIR_HH
......@@ -35,7 +35,7 @@ namespace Dumux
/*!
* \ingroup Components
*
* \brief A class for the \f$AIR\f$ fluid properties
* \brief A class for the air fluid properties
*
* \tparam Scalar The type used for scalar values
*/
......
......@@ -17,10 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file heatpipelaw.hh
* \file
*
* Implementation of the capillary pressure <-> saturation relation
* for the heatpipe problem.
* \brief Implementation of the capillary pressure <-> saturation relation
* for the heatpipe problem.
*/
#ifndef HEATPIPELAW_HH
#define HEATPIPELAW_HH
......@@ -40,10 +40,10 @@ namespace Dumux
* \ingroup material
*
* \brief Implementation of the capillary pressure <-> saturation
* relation for the heatpipe problem. This class bundles the
* "raw" curves as static members and doesn't concern itself
* converting absolute to effective saturations and vince
* versa.
* relation for the heatpipe problem.
*
* This class bundles the "raw" curves as static members and doesn't concern itself
* converting absolute to effective saturations and vince versa.
*/
template <class ScalarT, class ParamsT = HeatPipeLawParams<ScalarT> >
class HeatPipeLaw
......
......@@ -17,10 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file heatpipelawparams.hh
* \file
*
* Specification of the material params for the heat pipe's capillary
* pressure model.
* \brief Specification of the material params for the heat pipe's capillary
* pressure model.
*/
#ifndef DUMUX_HEATPIPELAWPARAMS_HH
#define DUMUX_HEATPIPELAWPARAMS_HH
......
......@@ -17,10 +17,10 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file 2poftadapter.hh
* \file
*
* Makes the twophase capillary pressure-saturation relations
* available under the M-phase API for material laws.
* \brief Makes the twophase capillary pressure-saturation relations
* available under the M-phase API for material laws.
*
* Also use the temperature dependent version of the material laws.
*/
......
......@@ -32,6 +32,7 @@
namespace Dumux {
/*!
* \ingroup TwoPTwoCNIStokesTwoCNIModel
* \brief The extension of the local operator for the coupling of a two-component Stokes model
* and a two-phase two-component Darcy model for non-isothermal conditions.
*/
......
......@@ -39,6 +39,7 @@
namespace Dumux {
/*!
* \ingroup TwoPTwoCStokesTwoCModel
* \brief The local operator for the coupling of a two-component Stokes model
* and a two-phase two-component porous-medium model under isothermal conditions.
*/
......
......@@ -26,13 +26,12 @@
#include <dumux/multidomain/common/multidomainnewtoncontroller.hh>
/*!
* \file
*/
namespace Dumux
{
/*!
* \ingroup Newton
* \ingroup TwoPTwoCStokesTwoCModel
* \brief Implementation of a Newton controller for the coupling of a two-component Stokes model
* and a two-phase two-component porous-medium model under isothermal conditions.
*
......
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