Commit 71da3343 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[doxygen]

updated doxgen docu, 3 warnings left


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@13350 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent e94884b4
......@@ -112,7 +112,7 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*
* \param solveTwice indicates if more than one iteration is allowed to get an initial pressure solution
*/
......@@ -132,7 +132,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
* \copydetails FVPressure::update()
*
*/
void update()
......
......@@ -59,7 +59,7 @@ template<class TypeTag> class FVPressureVelocity1P: public FVPressure1P<TypeTag>
public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -69,7 +69,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
* \copydetails FVPressure::update()
*
*/
void update()
......
......@@ -240,8 +240,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
*
* \copydetails FVPressure::update()
*/
void update()
{
......
......@@ -120,7 +120,7 @@ public:
/*! \brief Pressure update
*
* \copydetails FVPressure2P::update()
* \copydetails FVPressure::update()
*
* The grid-adaptive implementation also reconstructs the velocity directly after the pressure update.
* This is necessary to make sure the hanging nodes are treated correctly!
......
......@@ -186,7 +186,7 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -285,7 +285,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
* \copydetails FVPressure::update()
*
*/
void update()
......
......@@ -133,7 +133,7 @@ public:
/*! \brief Initializes pressure and velocity
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -159,7 +159,7 @@ public:
/*! \brief Pressure and velocity update
*
* \copydetails ParentType::update()
* \copydetails FVPressure::update()
*
*/
void update()
......
......@@ -143,7 +143,7 @@ public:
/*! \brief Initializes pressure and velocity
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -169,7 +169,7 @@ public:
/*! \brief Pressure and velocity update
*
* \copydetails ParentType::update()
* \copydetails FVPressure::update()
*
*/
void update()
......
......@@ -176,7 +176,7 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize(bool solveTwice = true)
{
......@@ -269,8 +269,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
*
* \copydetails FVPressure::update()
*/
void update()
{
......
......@@ -128,7 +128,7 @@ public:
/*! \brief Initializes pressure and velocity
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize(bool solveTwice = true)
{
......@@ -155,8 +155,7 @@ public:
/*! \brief Pressure and velocity update
*
* \copydetails ParentType::update()
*
* \copydetails FVPressure::update()
*/
void update()
{
......
......@@ -170,8 +170,7 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
*
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -206,8 +205,7 @@ public:
/*! \brief Pressure update
*
* \copydetails ParentType::update()
*
* \copydetails FVPressure::update()
*/
void update()
{
......
......@@ -134,7 +134,7 @@ public:
/*! \brief Initializes pressure and velocity
*
* \copydetails ParentType::initialize()
* \copydetails FVPressure::initialize()
*/
void initialize()
{
......@@ -160,8 +160,7 @@ public:
/*! \brief Pressure and velocity update
*
* \copydetails ParentType::update()
*
* \copydetails FVPressure::update()
*/
void update()
{
......
......@@ -32,8 +32,8 @@
namespace Dumux
{
//! \ingroup Adaptive2p2c mpfa
/*! \brief Interactionvolume container for compositional adaptive 3-d (using MPFA L-method) Model
/*! \ingroup Adaptive2p2c mpfa
* \brief Interactionvolume container for compositional adaptive 3-d (using MPFA L-method) Model
*
* Container class which stores MPFA-interaction-volume information for each vertex of a DUNE grid.
*
......
......@@ -583,13 +583,14 @@ public:
+
(1.-massUpwindWeight_) * transportedThingDn ) ;
}
/*! \brief The heat conduction in the phase
*
* \param flux The flux over the SCV (sub-control-volume) face for each component
* \param fluxVars The flux Variables
* \param elemVolVars The volume variables of the current element
* \param phaseIdx The local index of the phases
*/
*
* \param flux The flux over the SCV (sub-control-volume) face for each component
* \param fluxVars The flux Variables
* \param elemVolVars The volume variables of the current element
* \param energyEqIdx The index of the phase energy equation
*/
static void computeHeatConduction(PrimaryVariables & flux,
const FluxVariables & fluxVars,
const ElementVolumeVariables & elemVolVars,
......
......@@ -499,8 +499,7 @@ class EntityExchanger
public:
/*! \brief Constructor. Sets up the local to global relations.
\param[in] gridView The grid view to operate on.
\param[in] problem The problem to be solved.
*/
EntityExchanger(const Problem& problem)
: problem_(problem)
......@@ -633,7 +632,7 @@ public:
}
/** @brief Constructor
@param[in] gridView Grid view.
@param[in] problem The problem to be solved.
@param[in] g2i Global to local index map.
@param[in] i2g Local to global index map.
@param[in] A Matrix to operate on.
......@@ -739,7 +738,7 @@ public:
}
/** @brief Constructor
@param[in] gridView Grid view.
@param[in] problem The problem to be solved.
@param[in] g2i Global to local index map.
@param[in] i2g Local to global index map.
@param[in] A Matrix to operate on.
......
......@@ -55,6 +55,7 @@ public:
/*!
* \brief The capillary pressure-saturation curve.
*
* \param params Array of parameters
* \param Sw Effective saturation of of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar pc(const Params &params, Scalar Sw)
......@@ -118,6 +119,7 @@ public:
/*!
* \brief The relative permeability for the wetting phase.
*
* \param params Array of parameters
* \param Sw The mobile saturation of the wetting phase.
*/
static Scalar krw(const Params &params, Scalar Sw)
......@@ -128,6 +130,7 @@ public:
/*!
* \brief The relative permeability for the non-wetting phase.
*
* \param params Array of parameters
* \param Sw The mobile saturation of the wetting phase.
*/
static Scalar krn(const Params &params, Scalar Sw)
......
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