Skip to content
Snippets Groups Projects
Commit 57c533d8 authored by Katharina Heck's avatar Katharina Heck Committed by Timo Koch
Browse files

[cleanup] docu

parent 522811ea
No related branches found
No related tags found
2 merge requests!1337WIP Fix/dirichlet caching v2,!1195Cleanup/interfacial areas
...@@ -53,6 +53,7 @@ public: ...@@ -53,6 +53,7 @@ public:
* \param values Container for the return values * \param values Container for the return values
* \param params Array of parameters * \param params Array of parameters
* \param state Fluidstate * \param state Fluidstate
* \param wPhaseIdx index of the wetting phase
*/ */
template <class ContainerT, class FluidState> template <class ContainerT, class FluidState>
static void capillaryPressures(ContainerT &values, static void capillaryPressures(ContainerT &values,
...@@ -73,6 +74,7 @@ public: ...@@ -73,6 +74,7 @@ public:
* \param values Container for the return values * \param values Container for the return values
* \param params Array of parameters * \param params Array of parameters
* \param state Fluidstate * \param state Fluidstate
* \param wPhaseIdx index of the wetting phase
*/ */
template <class ContainerT, class FluidState> template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values, static void relativePermeabilities(ContainerT &values,
......
...@@ -61,6 +61,7 @@ public: ...@@ -61,6 +61,7 @@ public:
* \param values Container for the return values * \param values Container for the return values
* \param params Array of Parameters * \param params Array of Parameters
* \param state The fluid state * \param state The fluid state
* \param wPhaseIdx index of the wetting phase
*/ */
template <class ContainerT, class FluidState> template <class ContainerT, class FluidState>
static void capillaryPressures(ContainerT &values, static void capillaryPressures(ContainerT &values,
...@@ -81,6 +82,7 @@ public: ...@@ -81,6 +82,7 @@ public:
* \param values Container for the return values * \param values Container for the return values
* \param params Array of Parameters * \param params Array of Parameters
* \param state The fluid state * \param state The fluid state
* \param wPhaseIdx index of the wetting phase
*/ */
template <class ContainerT, class FluidState> template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values, static void relativePermeabilities(ContainerT &values,
......
...@@ -73,8 +73,6 @@ public: ...@@ -73,8 +73,6 @@ public:
/*! /*!
* \brief Returns the index of the wetting phase in the * \brief Returns the index of the wetting phase in the
* fluid-solid configuration (for porous medium systems). * fluid-solid configuration (for porous medium systems).
*
* \param phaseIdx the index of the phase
*/ */
int wettingPhase() const { return wPhaseIdx_; } int wettingPhase() const { return wPhaseIdx_; }
......
...@@ -68,8 +68,6 @@ public: ...@@ -68,8 +68,6 @@ public:
/*! /*!
* \brief Returns the index of the wetting phase in the * \brief Returns the index of the wetting phase in the
* fluid-solid configuration (for porous medium systems). * fluid-solid configuration (for porous medium systems).
*
* \param phaseIdx the index of the phase
*/ */
int wettingPhase() const { return wPhaseIdx_; } int wettingPhase() const { return wPhaseIdx_; }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment