Commit 1e933ace authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

updated doxygen docu

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4488 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 68594558
# This file contains local changes to the doxygen configuration
# please us '+=' to add file/directories to the lists
INTERNAL_DOCS = NO
INPUT += @top_srcdir@/dumux
EXTRA_PACKAGES += amsmath,amssymb
......@@ -22,8 +22,7 @@
/*!
* \file
*
* \brief Element-wise calculation of the Jacobian matrix for problems
* using the two-phase box model.
* \brief Element-wise calculation of the residual for the two-phase box model.
*/
#ifndef DUMUX_TWOP_LOCAL_RESIDUAL_BASE_HH
#define DUMUX_TWOP_LOCAL_RESIDUAL_BASE_HH
......
......@@ -23,7 +23,7 @@
/*!
* \file
*
* \brief Adaption of the BOX scheme to the two-phase flow model.
* \brief Adaption of the box scheme to the two-phase flow model.
*/
#ifndef DUMUX_TWOP_MODEL_HH
......
......@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Boundary types gathered on an element
*/
#ifndef DUMUX_BOX_ELEMENT_BOUNDARY_TYPES_HH
#define DUMUX_BOX_ELEMENT_BOUNDARY_TYPES_HH
......
......@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Volume variables gathered on an element
*/
#ifndef DUMUX_BOX_ELEMENT_VOLUME_VARIABLES_HH
#define DUMUX_BOX_ELEMENT_VOLUME_VARIABLES_HH
......
......@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Element-wise geometric data for the box method
*/
#ifndef DUMUX_BOX_FV_ELEMENTGEOMETRY_HH
#define DUMUX_BOX_FV_ELEMENTGEOMETRY_HH
......@@ -50,8 +55,7 @@ public:
};
};
/** \todo Please doc me! */
/*! \internal */
template <typename BoxFVElementGeometry>
class _BoxFVElemGeomHelper<BoxFVElementGeometry, 1>
{
......
......@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Base class for models using box discretization
*/
#ifndef DUMUX_BOX_MODEL_HH
#define DUMUX_BOX_MODEL_HH
......
......@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Default properties for box models
*/
#ifndef DUMUX_BOX_PROPERTY_DEFAULTS_HH
#define DUMUX_BOX_PROPERTY_DEFAULTS_HH
......
......@@ -13,11 +13,14 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief An assembler for the Jacobian matrix based on PDELab.
*/
#ifndef DUMUX_PDELAB_BOX_ASSEMBLER_HH
#define DUMUX_PDELAB_BOX_ASSEMBLER_HH
//#include "pdelabboundarytypes.hh"
#include "pdelabboxlocaloperator.hh"
namespace Dumux {
......
/*
/*!
* \file
*
* \brief This is basically a copy of PDELab's ISTLVectorBackend which
......
......@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief A local PDELab operator for box models.
*/
#ifndef DUMUX_PDELAB_BOX_LOCAL_OPERATOR_HH
#define DUMUX_PDELAB_BOX_LOCAL_OPERATOR_HH
......
......@@ -19,6 +19,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Element-wise calculation of the residual for the Richards box model.
*/
#ifndef DUMUX_RICHARDS_LOCAL_RESIDUAL_HH
#define DUMUX_RICHARDS_LOCAL_RESIDUAL_HH
......
......@@ -19,6 +19,13 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Adaption of the box scheme to the Richards model.
*/
#ifndef DUMUX_RICHARDS_MODEL_HH
#define DUMUX_RICHARDS_MODEL_HH
......
......@@ -13,7 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Sequential preconditioner using the Pardiso direct solver.
*/
#ifndef DUMUX_PARDISO_HH
#define DUMUX_PARDISO_HH
......
......@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief A parallel solver for nonoverlapping grid partitions.
*/
#ifndef DUMUX_PDELAB_PRECONDITIONER_HH
#define DUMUX_PDELAB_PRECONDITIONER_HH
......
......@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Properties for the MPFA-O method.
*/
#ifndef DUNE_MPFAOPROPERTIES_HH
#define DUNE_MPFAOPROPERTIES_HH
......
......@@ -13,7 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Local stiffness matrix for the diffusion equation discretized by mimetic FD
*/
#ifndef DUMUX_MIMETICGROUNDWATER_HH
#define DUMUX_MIMETICGROUNDWATER_HH
......@@ -31,12 +35,6 @@
#include<dumux/common/boundaryconditions.hh>
/**
* @file
* @brief compute local stiffness matrix for conforming finite elements for diffusion equation
* @author Peter Bastian
*/
namespace Dumux
{
/**
......
......@@ -13,7 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief An assembler for the Jacobian matrix based on mimetic FD.
*/
#ifndef DUMUX_MIMETICOPERATOR_HH
#define DUMUX_MIMETICOPERATOR_HH
......
......@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Model for the pressure equation discretized by mimetic FD.
*/
#ifndef DUMUX_MIMETICPRESSURE2P_HH
#define DUMUX_MIMETICPRESSURE2P_HH
......@@ -28,12 +33,6 @@
#include "dumux/common/pardiso.hh"
#include <dumux/decoupled/2p/2pproperties.hh>
/**
* @file
* @brief mimetic Diffusion Model
* @author Bernd Flemisch, Jochen Fritz, Markus Wolff
*/
namespace Dumux
{
......
......@@ -13,15 +13,14 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \file
*
* \brief Model for the pressure equation discretized by mimetic FD including velocity calculation.
*/
#ifndef DUMUX_FVVELOCITY2P_HH
#define DUMUX_FVVELOCITY2P_HH
/**
* @file
* @brief Finite Volume Diffusion Model
* @author Markus Wolff
*/
#include <dumux/decoupled/2p/diffusion/fv/fvpressure2p.hh>
namespace Dumux
......
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