Commit 5ef91ae0 authored by Benjamin Faigle's avatar Benjamin Faigle
Browse files

updated doxygen documentation

new doxygen structure applied

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4558 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 83ae91eb
......@@ -16,6 +16,11 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \ingroup IMPES
* \defgroup FV1p Single Phase Finite-Volume
*/
/*!
* \ingroup FV1p
* \file
*
* \brief Defines the properties required for the twophase BOX model.
......@@ -34,10 +39,6 @@
namespace Dumux
{
/*!
* \ingroup fracflow
* \addtogroup DecoupledModel
*/
////////////////////////////////
// forward declarations
......
......@@ -28,8 +28,10 @@
namespace Dumux
{
/*!
* \ingroup Decoupled
* \brief Base class for all 1-phase problems which use an impes algorithm
* \ingroup FV1p
* \ingroup IMPESproblems
*
* \brief Base class for all single phase problems which use an impes algorithm
*
* \todo Please doc me more!
*/
......
......@@ -37,8 +37,8 @@
namespace Dumux
{
//! \ingroup diffusion
//! Finite Volume Diffusion Model
//! \ingroup FV1p
//! \brief Single Phase Finite Volume Diffusion Model
/*! Provides a Finite Volume implementation for the evaluation
* of equations of the form
* \f[\text{div}\, \boldsymbol{v}_{total} = q.\f]
......@@ -53,12 +53,8 @@ namespace Dumux
* For all cases, \f$p = p_D\f$ on \f$\Gamma_{Neumann}\f$, and \f$\boldsymbol{v}_{total} = q_N\f$
* on \f$\Gamma_{Dirichlet}\f$.
*
* Template parameters are:
* @tparam TypeTag The Type Tag
*
- GridView a DUNE gridview type
- Scalar type used for scalar quantities
- VC type of a class containing different variables of the model
- Problem class defining the physical problem
*/
template<class TypeTag> class FVPressure1P
{
......@@ -113,9 +109,9 @@ protected:
}
public:
//! Calculate the pressure.
//! Initializes the problem
/*!
* \param t time
* @param solveTwice repeats the pressure calculation step
*
* Calculates the pressure \f$p\f$ as solution of the boundary value
* \f[ \text{div}\, \boldsymbol{v} = q, \f]
......@@ -134,6 +130,14 @@ public:
return;
}
//! Calculate the pressure.
/*!
* @param solveTwice without any function here!
*
* Calculates the pressure \f$p\f$ as solution of the boundary value
* \f[ \text{div}\, \boldsymbol{v} = q, \f]
* subject to appropriate boundary conditions.
*/
void pressure(bool solveTwice = true)
{
assemble(false);
......@@ -156,7 +160,7 @@ public:
}
//! \brief Write data files
/* \param name file name */
/* \param writer VTK-Writer for the current simulation run */
template<class MultiWriter>
void addOutputVtkFields(MultiWriter &writer)
{
......@@ -172,10 +176,7 @@ public:
//! Constructs a FVPressure1P object
/**
* \param gridView gridView object of type GridView
* \param problem a problem class object
* \param pressType a string giving the type of pressure used (could be: pw, pn, pglobal)
* \param satType a string giving the type of saturation used (could be: Sw, Sn)
*/
FVPressure1P(Problem& problem) :
problem_(problem), A_(problem.variables().gridSize(), problem.variables().gridSize(), (2 * dim + 1)
......@@ -193,7 +194,7 @@ protected:
const Dune::FieldVector<Scalar, dimWorld>& gravity; //!< vector including the gravity constant
};
//initializes the matrix to store the system of equations
//!initializes the matrix to store the system of equations
template<class TypeTag>
void FVPressure1P<TypeTag>::initializeMatrix()
{
......@@ -243,7 +244,7 @@ void FVPressure1P<TypeTag>::initializeMatrix()
return;
}
//function which assembles the system of equations to be solved
//!function which assembles the system of equations to be solved
template<class TypeTag>
void FVPressure1P<TypeTag>::assemble(bool first)
{
......@@ -429,7 +430,7 @@ void FVPressure1P<TypeTag>::assemble(bool first)
return;
}
//solves the system of equations to get the spatial distribution of the pressure
//!solves the system of equations to get the spatial distribution of the pressure
template<class TypeTag>
void FVPressure1P<TypeTag>::solve()
{
......
......@@ -26,8 +26,8 @@
namespace Dumux
{
//! \ingroup diffusion
//! Finite Volume Diffusion Model
//! \ingroup FV1p
//! \brief Single Phase Finite Volume Diffusion Model
/*! Calculates non-wetting phase velocities from a known pressure field in context of a Finite Volume implementation for the evaluation
* of equations of the form
* \f[\text{div}\, \boldsymbol{v}_{total} = q.\f]
......@@ -38,12 +38,7 @@ namespace Dumux
* As in the two-phase pressure equation a total flux depending on a total velocity is considered one has to be careful at neumann flux boundaries. Here, a phase velocity is only uniquely defined, if
* the saturation is at the maximum (\f$1-S_{rw}\f$, \f$\boldsymbol{v}_{total} = \boldsymbol{v}_n\f$) or at the minimum (\f$ S_{rn} \f$, \f$\boldsymbol{v}_n = 0\f$)
*
* Template parameters are:
*
- GridView a DUNE gridview type
- Scalar type used for scalar quantities
- VC type of a class containing different variables of the model
- Problem class defining the physical problem
* @tparam TypeTag The Type Tag
*/
template<class TypeTag>
......@@ -82,10 +77,7 @@ typedef typename GridView::Traits::template Codim<0>::Entity Element;
public:
//! Constructs a FVNonWettingPhaseVelocity2P object
/**
* \param gridView gridView object of type GridView
* \param problem a problem class object
* \param pressureType a string giving the type of pressure used (could be: pw, pn, pglobal)
* \param satType a string giving the type of saturation used (could be: Sw, Sn)
*/
FVVelocity1P(Problem& problem)
: FVPressure1P<TypeTag>(problem)
......@@ -94,8 +86,6 @@ public:
//! Calculate the velocity.
/*!
* \param t time
*
*
* Given the piecewise constant pressure \f$p\f$,
* this method calculates the velocity
......
......@@ -16,7 +16,7 @@
/*!
* \file
*
* \brief Gives the phase state.
* \brief Determines the phase state of the immiscible sequential 2p model.
*/
#ifndef DUMUX_2P_FLUID_STATE_HH
#define DUMUX_2P_FLUID_STATE_HH
......@@ -27,7 +27,10 @@
namespace Dumux
{
/*!
* \brief Calcultes the phase state from the primary variables in the
* \ingroup IMPES
*/
/*!
* \brief Calcultes the phase state from the primary variables in the sequential
* 2p model.
*/
template <class TypeTag>
......
......@@ -15,10 +15,28 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \ingroup IMPET
* \defgroup IMPES Immiscible IMPES
*/
/*!
* \ingroup IMPES
* \defgroup FV2p Finite-Volume
*/
/*! \ingroup IMPES
* \defgroup MPFA2p MPFA
*/
/*! \ingroup IMPES
* \defgroup mimetic Mimetic FiniteDifference
*/
/*!
* \ingroup IMPES
* \ingroup Properties
*/
/*!
* \file
*
* \brief Defines the properties required for the twophase BOX model.
* \brief Defines the properties required for (immiscible) twophase sequential models.
*/
#ifndef DUMUX_2PPROPERTIES_HH
......@@ -35,10 +53,6 @@
namespace Dumux
{
/*!
* \ingroup fracflow
* \addtogroup DecoupledModel
*/
// \{
////////////////////////////////
......@@ -62,10 +76,8 @@ struct TwoPCommonIndices;
////////////////////////////////
namespace Properties
{
/*!
* \ingroup fracflow
* \addtogroup DecoupledModel
* \ingroup Properties
*/
// \{
......@@ -193,6 +205,7 @@ private:
typedef typename GET_PROP_TYPE(TypeTag, PTAG(PressureRHSVector)) Vector;
public:
typedef Dune::BiCGSTABSolver<Vector> type;
// typedef Dune::CGSolver<Vector> type;
};
//SET_INT_PROP(DecoupledTwoP, PressurePreconditioner, SolverIndices::seqILU0);
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \brief Base class for all problems which use the box scheme
* \brief doc me!!
*/
#ifndef DUMUX_DIFFUSIONPROBLEM_2P_HH
#define DUMUX_DIFFUSIONPROBLEM_2P_HH
......@@ -29,7 +29,7 @@
namespace Dumux
{
/*!
* \ingroup Decoupled
* \ingroup IMPESproblems
* \brief Base class for all 2-phase problems which use an impes algorithm
*
* \todo Please doc me more!
......
......@@ -37,8 +37,8 @@
namespace Dumux
{
//! \ingroup diffusion
//! Finite Volume Diffusion Model
//! \ingroup FV2p
//! \brief Pressure equation of the sequential Finite Volume Model
/*! Provides a Finite Volume implementation for the evaluation
* of equations of the form
* \f[\text{div}\, \boldsymbol{v}_{total} = q.\f]
......@@ -53,12 +53,7 @@ namespace Dumux
* For all cases, \f$p = p_D\f$ on \f$\Gamma_{Neumann}\f$, and \f$\boldsymbol{v}_{total} = q_N\f$
* on \f$\Gamma_{Dirichlet}\f$.
*
* Template parameters are:
*
- GridView a DUNE gridview type
- Scalar type used for scalar quantities
- VC type of a class containing different variables of the model
- Problem class defining the physical problem
* \tparam TypeTag The Type Tag
*/
template<class TypeTag> class FVPressure2P
{
......@@ -128,18 +123,9 @@ protected:
}
public:
//! Calculate the pressure.
/*!
* \param t time
*
* Calculates the pressure \f$p\f$ as solution of the boundary value
* \f[ \text{div}\, \boldsymbol{v} = q, \f]
* subject to appropriate boundary conditions.
*/
//constitutive functions are initialized and stored in the variables object
void updateMaterialLaws();
//! \copydoc Dumux::FVPressure1P::initialize()
void initialize(bool solveTwice = true)
{
updateMaterialLaws();
......@@ -177,7 +163,7 @@ public:
}
return;
}
//! \copydoc Dumux::FVPressure1P::pressure()
void pressure(bool solveTwice = true)
{
assemble(false);
......@@ -185,7 +171,7 @@ public:
return;
}
//! What is this method here fore???
void update()
{
updateMaterialLaws();
......@@ -208,8 +194,7 @@ public:
return;
}
//! \brief Write data files
/* \param name file name */
//! \copydoc Dumux::FVPressure1P::addOutputVtkFields(MultiWriter &writer)
template<class MultiWriter>
void addOutputVtkFields(MultiWriter &writer)
{
......@@ -264,10 +249,7 @@ public:
//! Constructs a FVPressure2P object
/**
* \param gridView gridView object of type GridView
* \param problem a problem class object
* \param pressType a string giving the type of pressure used (could be: pw, pn, pglobal)
* \param satType a string giving the type of saturation used (could be: Sw, Sn)
*/
FVPressure2P(Problem& problem) :
problem_(problem), A_(problem.variables().gridSize(), problem.variables().gridSize(), (2 * dim + 1)
......@@ -347,7 +329,7 @@ void FVPressure2P<TypeTag>::initializeMatrix()
return;
}
//function which assembles the system of equations to be solved
//!function which assembles the system of equations to be solved
template<class TypeTag>
void FVPressure2P<TypeTag>::assemble(bool first)
{
......@@ -817,7 +799,7 @@ void FVPressure2P<TypeTag>::assemble(bool first)
return;
}
//solves the system of equations to get the spatial distribution of the pressure
//!solves the system of equations to get the spatial distribution of the pressure
template<class TypeTag>
void FVPressure2P<TypeTag>::solve()
{
......@@ -847,7 +829,7 @@ void FVPressure2P<TypeTag>::solve()
return;
}
//constitutive functions are updated once if new saturations are calculated and stored in the variables object
//!constitutive functions are updated once if new saturations are calculated and stored in the variables object
template<class TypeTag>
void FVPressure2P<TypeTag>::updateMaterialLaws()
{
......
......@@ -26,8 +26,8 @@
namespace Dumux
{
//! \ingroup diffusion
//! Finite Volume Diffusion Model
//! \ingroup FV2p
//! \brief Determines the velocity of the sequential Finite Volume Model
/*! Calculates non-wetting phase velocities from a known pressure field in context of a Finite Volume implementation for the evaluation
* of equations of the form
* \f[\text{div}\, \boldsymbol{v}_{total} = q.\f]
......@@ -38,12 +38,7 @@ namespace Dumux
* As in the two-phase pressure equation a total flux depending on a total velocity is considered one has to be careful at neumann flux boundaries. Here, a phase velocity is only uniquely defined, if
* the saturation is at the maximum (\f$1-S_{rw}\f$, \f$\boldsymbol{v}_{total} = \boldsymbol{v}_n\f$) or at the minimum (\f$ S_{rn} \f$, \f$\boldsymbol{v}_n = 0\f$)
*
* Template parameters are:
*
- GridView a DUNE gridview type
- Scalar type used for scalar quantities
- VC type of a class containing different variables of the model
- Problem class defining the physical problem
* \tparam TypeTag The Type Tag
*/
template<class TypeTag>
......@@ -99,11 +94,8 @@ typedef typename GridView::Traits::template Codim<0>::Entity Element;
public:
//! Constructs a FVNonWettingPhaseVelocity2P object
/**
* \param gridView gridView object of type GridView
/*!
* \param problem a problem class object
* \param pressureType a string giving the type of pressure used (could be: pw, pn, pglobal)
* \param satType a string giving the type of saturation used (could be: Sw, Sn)
*/
FVVelocity2P(Problem& problem)
: FVPressure2P<TypeTag>(problem)
......@@ -119,10 +111,7 @@ public:
}
//! Constructs a FVNonWettingPhaseVelocity2P object
/**
* \param gridView gridView object of type GridView
* \param problem a problem class object
* \param pressureType a string giving the type of pressure used (could be: pw, pn, pglobal)
* \param satType a string giving the type of saturation used (could be: Sw, Sn)
* \param solverName a string giving the type of solver used (could be: CG, BiCGSTAB, Loop)
* \param preconditionerName a string giving the type of the matrix preconditioner used (could be: Dune::SeqILU0, SeqPardiso)
*/
......@@ -142,8 +131,6 @@ public:
//! Calculate the velocity.
/*!
* \param t time
*
*
* Given the piecewise constant pressure \f$p\f$,
* this method calculates the velocity
......@@ -161,8 +148,7 @@ public:
return;
}
//! \brief Write data files
/* \param name file name */
//! \copydoc Dumux::FVVelocity1P::addOutputVtkFields(MultiWriter &writer)
template<class MultiWriter>
void addOutputVtkFields(MultiWriter &writer)
{
......@@ -224,6 +210,7 @@ public:
private:
static const int velocityType_ = GET_PROP_VALUE(TypeTag, PTAG(VelocityFormulation)); //!< gives kind of velocity used (\f$ 0 = v_w\f$, \f$ 1 = v_n\f$, \f$ 2 = v_t\f$)
};
//! \copydoc Dumux::FVVelocity1P::calculateVelocity()
template<class TypeTag>
void FVVelocity2P<TypeTag>::calculateVelocity()
{
......
......@@ -41,7 +41,7 @@
namespace Dumux
{
//! \ingroup diffusion
//! \ingroup MPFA2p
//! Base class for defining an instance of a numerical diffusion model.
/*! An interface for defining a numerical diffusion model for the
* solution of equations of the form
......
......@@ -28,7 +28,7 @@
namespace Dumux
{
//! \ingroup MPFA2p
template<class TypeTag> class FVMPFAOVelocity2P: public FVMPFAOPressure2P<TypeTag>
{
typedef FVMPFAOVelocity2P<TypeTag> ThisType;
......
......@@ -15,6 +15,11 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
* \ingroup IMPES
* \addtogroup MPFA2p
*/
/*!
* \ingroup MPFA2p
* \file
*
* \brief Properties for the MPFA-O method.
......
......@@ -44,21 +44,10 @@
* @author Peter Bastian
*/
/*! @defgroup DISC_Operators Operators
@ingroup DISC
@brief
@section D1 Introduction
<!--=================-->
To be written
*/
namespace Dumux
{
/** @addtogroup DISC_Operators
*
* @{
/*!
* \ingroup mimetic
*/
/**
* @brief defines a class for Crozieux-Raviart piecewise linear finite element functions
......
......@@ -27,19 +27,9 @@
* @author Peter Bastian
*/
/*! @defgroup DISC_Operators Operators
@ingroup DISC
@brief
@section D1 Introduction
<!--=================-->
To be written
*/
namespace Dumux
{
/** @addtogroup DISC_Operators
/** @addtogroup mimetic
*
* @{
*/
......
......@@ -37,9 +37,8 @@
namespace Dumux
{
/**
*
*
/*!
* \ingroup mimetic
*/
/**
* @brief compute local stiffness matrix for conforming finite elements for diffusion equation
......
......@@ -44,7 +44,9 @@
namespace Dumux
{
/*! @brief Levelwise assembler
/*!
* \ingroup mimetic
* @brief Levelwise assembler
This class serves as a base class for local assemblers. It provides
space and access to the local stiffness matrix. The actual assembling is done
......
......@@ -36,7 +36,7 @@
namespace Dumux
{
//! \ingroup diffusion
//! \ingroup mimetic
//! mimetic Diffusion Model
/*! Provides a mimetic implementation for the evaluation
* of equations of the form
......
......@@ -16,7 +16,7 @@
*****************************************************************************/
/*!
* \file
* \brief Base class for all problems which use the box scheme
* \brief Base class for all 2-phase problems which use an impes algorithm
*/
#ifndef DUMUX_IMPESPROBLEM_2P_HH
#define DUMUX_IMPESPROBLEM_2P_HH
......@@ -31,7 +31,11 @@
namespace Dumux
{
/*!
* \ingroup Decoupled
* \ingroup IMPES
* \defgroup IMPESproblems IMPES problems
*/
/*!
* \ingroup IMPESproblems
* \brief Base class for all 2-phase problems which use an impes algorithm
*
* \todo Please doc me more!
......@@ -61,6 +65,12 @@ class IMPESProblem2P : public IMPETProblem<TypeTag, Implementation>
{}
public:
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param verbose Output flag for the time manager.
*/
IMPESProblem2P(const GridView &gridView, bool verbose = true)
: ParentType(gridView, verbose),
gravity_(0)
......@@ -72,6 +82,13 @@ public:
if (GET_PROP_VALUE(TypeTag, PTAG(EnableGravity)))
gravity_[dim - 1] = - 9.81;
}
/*!
* \brief The constructor
*
* \param gridView The grid view
* \param spatialParameters SpatialParameters instantiation
* \param verbose Output flag for the time manager.
*/
IMPESProblem2P(const GridView &gridView, SpatialParameters &spatialParameters, bool verbose = true)
: ParentType(gridView, verbose),
gravity_(0),spatialParameters_(&spatialParameters)
......
......@@ -21,12 +21,12 @@
/**
* @file
* @brief Class for defining the diffusive capillary pressure term of a saturation equation
* @brief Class for defining the diffusive capillary pressure term of a 2p saturation equation
* @author Bernd Flemisch, Markus Wolff
*/
namespace Dumux