Skip to content
Snippets Groups Projects
Commit 1f560488 authored by Melanie Lipp's avatar Melanie Lipp
Browse files

[docu] Added a few parameter documentations to the Richards documentation.

parent 986b6284
No related branches found
No related tags found
2 merge requests!698Feature/xy docu,!617[WIP] Next
......@@ -72,6 +72,7 @@ public:
* \brief Evaluate the rate of change of all conservation
* quantites (e.g. phase mass) within a sub-control
* volume of a finite volume element for the immiscible models.
* \param problem The problem
* \param scv The sub control volume
* \param volVars The current or previous volVars
* \note This function should not include the source and sink terms.
......@@ -107,7 +108,13 @@ public:
/*!
* \brief Evaluate the mass flux over a face of a sub control volume
*
* \param problem The problem
* \param element The current element.
* \param fvGeometry The finite-volume geometry
* \param elemVolVars The volume variables of the current element
* \param scvf The sub control volume face to compute the flux on
* \param elemFluxVarsCache The cache related to flux compuation
*/
ResidualVector computeFlux(const Problem& problem,
const Element& element,
......
......@@ -73,6 +73,7 @@ public:
* This is basically the step
* \f[ u^{k+1} = u^k - \Delta u^k \f]
*
* \param assembler TODO docme!
* \param uCurrentIter The solution after the current Newton iteration \f$ u^{k+1} \f$
* \param uLastIter The solution after the last Newton iteration \f$ u^k \f$
* \param deltaU The vector of differences between the last
......
......@@ -414,8 +414,8 @@ public:
/*!
* \brief Returns the binary diffusion coefficients for a phase in \f$[m^2/s]\f$.
*
* \param phaseIdx TODO docme!
* \param compIdx TODO docme!
* \param phaseIdx The phase index
* \param compIdx The component index
*/
Scalar diffusionCoefficient(int phaseIdx, int compIdx) const
{
......
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