diff --git a/dumux/porousmediumflow/2p2c/indices.hh b/dumux/porousmediumflow/2p2c/indices.hh
index 8f7421688615077713f674b4653a011ff27f4855..95f3aa74ef5b928538fd0d9cee960343c2d88b4e 100644
--- a/dumux/porousmediumflow/2p2c/indices.hh
+++ b/dumux/porousmediumflow/2p2c/indices.hh
@@ -16,9 +16,9 @@
* 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 TwoPTwoCModel
* \brief Defines the indices required for the two-phase two-component model
*/
#ifndef DUMUX_2P2C_INDICES_HH
@@ -28,18 +28,16 @@
namespace Dumux
{
-// \{
-
/*!
- * \ingroup TwoPTwoCModel
* \brief Enumerates the formulations which the two-phase two-component model accepts.
+ * \ingroup TwoPTwoCModel
*/
struct TwoPTwoCFormulation
{ enum { pnsw, pwsn}; };
/*!
- * \ingroup TwoPTwoCModel
* \brief The indices for the isothermal two-phase two-component model.
+ * \ingroup TwoPTwoCModel
*
* \tparam PVOffset The first index in a primary variable vector.
*/
@@ -47,12 +45,12 @@ template <class FluidSystem, int PVOffset = 0>
struct TwoPTwoCIndices
{
// Phase indices
- static const int wPhaseIdx = FluidSystem::wPhaseIdx; //!< Index of the wetting phase
- static const int nPhaseIdx = FluidSystem::nPhaseIdx; //!< Index of the non-wetting phase
+ static const int wPhaseIdx = FluidSystem::wPhaseIdx; //!< index of the wetting phase
+ static const int nPhaseIdx = FluidSystem::nPhaseIdx; //!< index of the non-wetting phase
// Component indices
- static const int wCompIdx = FluidSystem::wCompIdx; //!< Index of the primary component of the wetting phase
- static const int nCompIdx = FluidSystem::nCompIdx; //!< Index of the primary component of the non-wetting phase
+ static const int wCompIdx = FluidSystem::wCompIdx; //!< index of the primary component of the wetting phase
+ static const int nCompIdx = FluidSystem::nCompIdx; //!< index of the primary component of the non-wetting phase
// present phases (-> 'pseudo' primary variable)
static const int wPhaseOnly = 1; //!< Only the non-wetting phase is present
@@ -60,17 +58,17 @@ struct TwoPTwoCIndices
static const int bothPhases = 3; //!< Both phases are present
// Primary variable indices
- //! Index for wetting/non-wetting phase pressure (depending on the formulation) in a solution vector
+ //! index for wetting/non-wetting phase pressure (depending on the formulation) in a solution vector
static const int pressureIdx = PVOffset + 0;
- //! Index of either the saturation or the mass fraction of the non-wetting/wetting phase
+ //! index of either the saturation or the mass fraction of the non-wetting/wetting phase
static const int switchIdx = PVOffset + 1;
// equation indices
- //! Index of the mass conservation equation for the first component
+ //! index of the mass conservation equation for the first component
static const int conti0EqIdx = PVOffset;
- //! Index of the mass conservation equation for the primary component of the wetting phase
+ //! index of the mass conservation equation for the primary component of the wetting phase
static const int contiWEqIdx = conti0EqIdx + wCompIdx;
- //! Index of the mass conservation equation for the primary component of the non-wetting phase
+ //! index of the mass conservation equation for the primary component of the non-wetting phase
static const int contiNEqIdx = conti0EqIdx + nCompIdx;
};
diff --git a/dumux/porousmediumflow/2p2c/model.hh b/dumux/porousmediumflow/2p2c/model.hh
index 37e69ed139b96631c663a506c052cfd85f0e8d4e..5817137f903751a360f9c514892a2630f04571e8 100644
--- a/dumux/porousmediumflow/2p2c/model.hh
+++ b/dumux/porousmediumflow/2p2c/model.hh
@@ -17,8 +17,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
- * \ingroup TwoPTwoCModel
* \file
+ * \ingroup TwoPTwoCModel
* \brief Adaption of the fully implicit scheme to the
* two-phase two-component fully implicit model.
*
@@ -217,13 +217,13 @@ public:
// Property values for isothermal model required for the general non-isothermal model
//////////////////////////////////////////////////////////////////
-//set isothermal Indices
+//! Set isothermal Indices
SET_TYPE_PROP(TwoPTwoCNI, IsothermalIndices, TwoPTwoCIndices<typename GET_PROP_TYPE(TypeTag, FluidSystem), /*PVOffset=*/0>);
-//set isothermal output fields
+//! Set isothermal output fields
SET_TYPE_PROP(TwoPTwoCNI, IsothermalVtkOutputFields, TwoPTwoCVtkOutputFields<TypeTag>);
-//set isothermal NumEq
+// Set isothermal NumEq
SET_INT_PROP(TwoPTwoCNI, IsothermalNumEq, 2);
} // end namespace Properties
diff --git a/dumux/porousmediumflow/2p2c/primaryvariableswitch.hh b/dumux/porousmediumflow/2p2c/primaryvariableswitch.hh
index 0345e24d8f4c514081831162e196e7c75b7ce779..ef51891d3a30c6a15887befb14634e520c8ff472 100644
--- a/dumux/porousmediumflow/2p2c/primaryvariableswitch.hh
+++ b/dumux/porousmediumflow/2p2c/primaryvariableswitch.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup TwoPTwoCModel
* \brief The primary variable switch for the 2p2c model
*/
#ifndef DUMUX_2P2C_PRIMARY_VARIABLE_SWITCH_HH
diff --git a/dumux/porousmediumflow/2p2c/volumevariables.hh b/dumux/porousmediumflow/2p2c/volumevariables.hh
index 7ed0a4e6a97a4009260f536b9e0cfca3c34cd254..98ec392e84be357e6c06be421b22938047a92ef9 100644
--- a/dumux/porousmediumflow/2p2c/volumevariables.hh
+++ b/dumux/porousmediumflow/2p2c/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup TwoPTwoCModel
* \brief Contains the quantities which are constant within a
* finite volume in the two-phase two-component model.
*/
@@ -111,8 +111,14 @@ public:
using ParentType::enthalpy;
/*!
- * \copydoc PorousMediumFlowVolumeVariables::update
- */
+ * \brief Update all quantities for a given control volume
+ *
+ * \param elemSol A vector containing all primary variables connected to the element
+ * \param problem The object specifying the problem which ought to
+ * be simulated
+ * \param element An element which contains part of the control volume
+ * \param scv The sub control volume
+ */
void update(const ElementSolution &elemSol,
const Problem &problem,
const Element &element,
@@ -158,7 +164,15 @@ public:
}
/*!
- * \copydoc ImplicitModel::completeFluidState
+ * \brief Complete the fluid state
+ *
+ * \param elemSol A vector containing all primary variables connected to the element
+ * \param problem The problem
+ * \param element The element
+ * \param scv The sub control volume
+ * \param fluidState The fluid state
+ *
+ * Set temperature, saturations, capillary pressures, viscosities, densities and enthalpies.
*/
static void completeFluidState(const ElementSolution& elemSol,
const Problem& problem,
diff --git a/dumux/porousmediumflow/2p2c/vtkoutputfields.hh b/dumux/porousmediumflow/2p2c/vtkoutputfields.hh
index a786aef207b098a03fc0a35a4c86d8871cfa7e0e..b1d1ec08eae9330f061e156aa058e02ffa4964a0 100644
--- a/dumux/porousmediumflow/2p2c/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/2p2c/vtkoutputfields.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup TwoPTwoCModel
* \brief Adds vtk output fields specific to the twop model
*/
#ifndef DUMUX_TWOPTWOC_VTK_OUTPUT_FIELDS_HH
@@ -29,7 +30,7 @@ namespace Dumux
{
/*!
- * \ingroup TwoPTwoC, InputOutput
+ * \ingroup TwoPTwoCModel
* \brief Adds vtk output fields specific to the two-phase two-component model
*/
template<class TypeTag>